Skip to content

pre_configured

oauthlib.oauth2.rfc6749.endpoints.pre_configured ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

This module is an implementation of various endpoints needed for providing OAuth 2.0 RFC6749 servers.

BackendApplicationServer

Bases: TokenEndpoint, IntrospectEndpoint, ResourceEndpoint, RevocationEndpoint

An all-in-one endpoint featuring Client Credentials grant and Bearer tokens.

Source code in server/vendor/oauthlib/oauth2/rfc6749/endpoints/pre_configured.py 
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
class BackendApplicationServer(TokenEndpoint, IntrospectEndpoint,
                               ResourceEndpoint, RevocationEndpoint):

    """An all-in-one endpoint featuring Client Credentials grant and Bearer tokens."""

    def __init__(self, request_validator, token_generator=None,
                 token_expires_in=None, refresh_token_generator=None, **kwargs):
        """Construct a client credentials grant server.

        :param request_validator: An implementation of
                                  oauthlib.oauth2.RequestValidator.
        :param token_expires_in: An int or a function to generate a token
                                 expiration offset (in seconds) given a
                                 oauthlib.common.Request object.
        :param token_generator: A function to generate a token from a request.
        :param refresh_token_generator: A function to generate a token from a
                                        request for the refresh token.
        :param kwargs: Extra parameters to pass to authorization-,
                       token-, resource-, and revocation-endpoint constructors.
        """
        self.credentials_grant = ClientCredentialsGrant(request_validator)
        self.bearer = BearerToken(request_validator, token_generator,
                             token_expires_in, refresh_token_generator)
        TokenEndpoint.__init__(self, default_grant_type='client_credentials',
                               grant_types={
                                   'client_credentials': self.credentials_grant},
                               default_token_type=self.bearer)
        ResourceEndpoint.__init__(self, default_token='Bearer',
                                  token_types={'Bearer': self.bearer})
        RevocationEndpoint.__init__(self, request_validator,
                                    supported_token_types=['access_token'])
        IntrospectEndpoint.__init__(self, request_validator,
                                    supported_token_types=['access_token'])

__init__(request_validator, token_generator=None, token_expires_in=None, refresh_token_generator=None, **kwargs)

Construct a client credentials grant server.

:param request_validator: An implementation of oauthlib.oauth2.RequestValidator. :param token_expires_in: An int or a function to generate a token expiration offset (in seconds) given a oauthlib.common.Request object. :param token_generator: A function to generate a token from a request. :param refresh_token_generator: A function to generate a token from a request for the refresh token. :param kwargs: Extra parameters to pass to authorization-, token-, resource-, and revocation-endpoint constructors.

Source code in server/vendor/oauthlib/oauth2/rfc6749/endpoints/pre_configured.py 
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
def __init__(self, request_validator, token_generator=None,
             token_expires_in=None, refresh_token_generator=None, **kwargs):
    """Construct a client credentials grant server.

    :param request_validator: An implementation of
                              oauthlib.oauth2.RequestValidator.
    :param token_expires_in: An int or a function to generate a token
                             expiration offset (in seconds) given a
                             oauthlib.common.Request object.
    :param token_generator: A function to generate a token from a request.
    :param refresh_token_generator: A function to generate a token from a
                                    request for the refresh token.
    :param kwargs: Extra parameters to pass to authorization-,
                   token-, resource-, and revocation-endpoint constructors.
    """
    self.credentials_grant = ClientCredentialsGrant(request_validator)
    self.bearer = BearerToken(request_validator, token_generator,
                         token_expires_in, refresh_token_generator)
    TokenEndpoint.__init__(self, default_grant_type='client_credentials',
                           grant_types={
                               'client_credentials': self.credentials_grant},
                           default_token_type=self.bearer)
    ResourceEndpoint.__init__(self, default_token='Bearer',
                              token_types={'Bearer': self.bearer})
    RevocationEndpoint.__init__(self, request_validator,
                                supported_token_types=['access_token'])
    IntrospectEndpoint.__init__(self, request_validator,
                                supported_token_types=['access_token'])

LegacyApplicationServer

Bases: TokenEndpoint, IntrospectEndpoint, ResourceEndpoint, RevocationEndpoint

An all-in-one endpoint featuring Resource Owner Password Credentials grant and Bearer tokens.

Source code in server/vendor/oauthlib/oauth2/rfc6749/endpoints/pre_configured.py 
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
class LegacyApplicationServer(TokenEndpoint, IntrospectEndpoint,
                              ResourceEndpoint, RevocationEndpoint):

    """An all-in-one endpoint featuring Resource Owner Password Credentials grant and Bearer tokens."""

    def __init__(self, request_validator, token_generator=None,
                 token_expires_in=None, refresh_token_generator=None, **kwargs):
        """Construct a resource owner password credentials grant server.

        :param request_validator: An implementation of
                                  oauthlib.oauth2.RequestValidator.
        :param token_expires_in: An int or a function to generate a token
                                 expiration offset (in seconds) given a
                                 oauthlib.common.Request object.
        :param token_generator: A function to generate a token from a request.
        :param refresh_token_generator: A function to generate a token from a
                                        request for the refresh token.
        :param kwargs: Extra parameters to pass to authorization-,
                       token-, resource-, and revocation-endpoint constructors.
        """
        self.password_grant = ResourceOwnerPasswordCredentialsGrant(
            request_validator)
        self.refresh_grant = RefreshTokenGrant(request_validator)
        self.bearer = BearerToken(request_validator, token_generator,
                             token_expires_in, refresh_token_generator)
        TokenEndpoint.__init__(self, default_grant_type='password',
                               grant_types={
                                   'password': self.password_grant,
                                   'refresh_token': self.refresh_grant,
                               },
                               default_token_type=self.bearer)
        ResourceEndpoint.__init__(self, default_token='Bearer',
                                  token_types={'Bearer': self.bearer})
        RevocationEndpoint.__init__(self, request_validator)
        IntrospectEndpoint.__init__(self, request_validator)

__init__(request_validator, token_generator=None, token_expires_in=None, refresh_token_generator=None, **kwargs)

Construct a resource owner password credentials grant server.

:param request_validator: An implementation of oauthlib.oauth2.RequestValidator. :param token_expires_in: An int or a function to generate a token expiration offset (in seconds) given a oauthlib.common.Request object. :param token_generator: A function to generate a token from a request. :param refresh_token_generator: A function to generate a token from a request for the refresh token. :param kwargs: Extra parameters to pass to authorization-, token-, resource-, and revocation-endpoint constructors.

Source code in server/vendor/oauthlib/oauth2/rfc6749/endpoints/pre_configured.py 
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
def __init__(self, request_validator, token_generator=None,
             token_expires_in=None, refresh_token_generator=None, **kwargs):
    """Construct a resource owner password credentials grant server.

    :param request_validator: An implementation of
                              oauthlib.oauth2.RequestValidator.
    :param token_expires_in: An int or a function to generate a token
                             expiration offset (in seconds) given a
                             oauthlib.common.Request object.
    :param token_generator: A function to generate a token from a request.
    :param refresh_token_generator: A function to generate a token from a
                                    request for the refresh token.
    :param kwargs: Extra parameters to pass to authorization-,
                   token-, resource-, and revocation-endpoint constructors.
    """
    self.password_grant = ResourceOwnerPasswordCredentialsGrant(
        request_validator)
    self.refresh_grant = RefreshTokenGrant(request_validator)
    self.bearer = BearerToken(request_validator, token_generator,
                         token_expires_in, refresh_token_generator)
    TokenEndpoint.__init__(self, default_grant_type='password',
                           grant_types={
                               'password': self.password_grant,
                               'refresh_token': self.refresh_grant,
                           },
                           default_token_type=self.bearer)
    ResourceEndpoint.__init__(self, default_token='Bearer',
                              token_types={'Bearer': self.bearer})
    RevocationEndpoint.__init__(self, request_validator)
    IntrospectEndpoint.__init__(self, request_validator)

MobileApplicationServer

Bases: AuthorizationEndpoint, IntrospectEndpoint, ResourceEndpoint, RevocationEndpoint

An all-in-one endpoint featuring Implicit code grant and Bearer tokens.

Source code in server/vendor/oauthlib/oauth2/rfc6749/endpoints/pre_configured.py 
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
class MobileApplicationServer(AuthorizationEndpoint, IntrospectEndpoint,
                              ResourceEndpoint, RevocationEndpoint):

    """An all-in-one endpoint featuring Implicit code grant and Bearer tokens."""

    def __init__(self, request_validator, token_generator=None,
                 token_expires_in=None, refresh_token_generator=None, **kwargs):
        """Construct a new implicit grant server.

        :param request_validator: An implementation of
                                  oauthlib.oauth2.RequestValidator.
        :param token_expires_in: An int or a function to generate a token
                                 expiration offset (in seconds) given a
                                 oauthlib.common.Request object.
        :param token_generator: A function to generate a token from a request.
        :param refresh_token_generator: A function to generate a token from a
                                        request for the refresh token.
        :param kwargs: Extra parameters to pass to authorization-,
                       token-, resource-, and revocation-endpoint constructors.
        """
        self.implicit_grant = ImplicitGrant(request_validator)
        self.bearer = BearerToken(request_validator, token_generator,
                             token_expires_in, refresh_token_generator)
        AuthorizationEndpoint.__init__(self, default_response_type='token',
                                       response_types={
                                           'token': self.implicit_grant},
                                       default_token_type=self.bearer)
        ResourceEndpoint.__init__(self, default_token='Bearer',
                                  token_types={'Bearer': self.bearer})
        RevocationEndpoint.__init__(self, request_validator,
                                    supported_token_types=['access_token'])
        IntrospectEndpoint.__init__(self, request_validator,
                                    supported_token_types=['access_token'])

__init__(request_validator, token_generator=None, token_expires_in=None, refresh_token_generator=None, **kwargs)

Construct a new implicit grant server.

:param request_validator: An implementation of oauthlib.oauth2.RequestValidator. :param token_expires_in: An int or a function to generate a token expiration offset (in seconds) given a oauthlib.common.Request object. :param token_generator: A function to generate a token from a request. :param refresh_token_generator: A function to generate a token from a request for the refresh token. :param kwargs: Extra parameters to pass to authorization-, token-, resource-, and revocation-endpoint constructors.

Source code in server/vendor/oauthlib/oauth2/rfc6749/endpoints/pre_configured.py 
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
def __init__(self, request_validator, token_generator=None,
             token_expires_in=None, refresh_token_generator=None, **kwargs):
    """Construct a new implicit grant server.

    :param request_validator: An implementation of
                              oauthlib.oauth2.RequestValidator.
    :param token_expires_in: An int or a function to generate a token
                             expiration offset (in seconds) given a
                             oauthlib.common.Request object.
    :param token_generator: A function to generate a token from a request.
    :param refresh_token_generator: A function to generate a token from a
                                    request for the refresh token.
    :param kwargs: Extra parameters to pass to authorization-,
                   token-, resource-, and revocation-endpoint constructors.
    """
    self.implicit_grant = ImplicitGrant(request_validator)
    self.bearer = BearerToken(request_validator, token_generator,
                         token_expires_in, refresh_token_generator)
    AuthorizationEndpoint.__init__(self, default_response_type='token',
                                   response_types={
                                       'token': self.implicit_grant},
                                   default_token_type=self.bearer)
    ResourceEndpoint.__init__(self, default_token='Bearer',
                              token_types={'Bearer': self.bearer})
    RevocationEndpoint.__init__(self, request_validator,
                                supported_token_types=['access_token'])
    IntrospectEndpoint.__init__(self, request_validator,
                                supported_token_types=['access_token'])

Server

Bases: AuthorizationEndpoint, IntrospectEndpoint, TokenEndpoint, ResourceEndpoint, RevocationEndpoint

An all-in-one endpoint featuring all four major grant types.

Source code in server/vendor/oauthlib/oauth2/rfc6749/endpoints/pre_configured.py 
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
class Server(AuthorizationEndpoint, IntrospectEndpoint, TokenEndpoint,
             ResourceEndpoint, RevocationEndpoint):

    """An all-in-one endpoint featuring all four major grant types."""

    def __init__(self, request_validator, token_expires_in=None,
                 token_generator=None, refresh_token_generator=None,
                 *args, **kwargs):
        """Construct a new all-grants-in-one server.

        :param request_validator: An implementation of
                                  oauthlib.oauth2.RequestValidator.
        :param token_expires_in: An int or a function to generate a token
                                 expiration offset (in seconds) given a
                                 oauthlib.common.Request object.
        :param token_generator: A function to generate a token from a request.
        :param refresh_token_generator: A function to generate a token from a
                                        request for the refresh token.
        :param kwargs: Extra parameters to pass to authorization-,
                       token-, resource-, and revocation-endpoint constructors.
        """
        self.auth_grant = AuthorizationCodeGrant(request_validator)
        self.implicit_grant = ImplicitGrant(request_validator)
        self.password_grant = ResourceOwnerPasswordCredentialsGrant(
            request_validator)
        self.credentials_grant = ClientCredentialsGrant(request_validator)
        self.refresh_grant = RefreshTokenGrant(request_validator)

        self.bearer = BearerToken(request_validator, token_generator,
                             token_expires_in, refresh_token_generator)

        AuthorizationEndpoint.__init__(self, default_response_type='code',
                                       response_types={
                                           'code': self.auth_grant,
                                           'token': self.implicit_grant,
                                           'none': self.auth_grant
                                       },
                                       default_token_type=self.bearer)

        TokenEndpoint.__init__(self, default_grant_type='authorization_code',
                               grant_types={
                                   'authorization_code': self.auth_grant,
                                   'password': self.password_grant,
                                   'client_credentials': self.credentials_grant,
                                   'refresh_token': self.refresh_grant,
                               },
                               default_token_type=self.bearer)
        ResourceEndpoint.__init__(self, default_token='Bearer',
                                  token_types={'Bearer': self.bearer})
        RevocationEndpoint.__init__(self, request_validator)
        IntrospectEndpoint.__init__(self, request_validator)

__init__(request_validator, token_expires_in=None, token_generator=None, refresh_token_generator=None, *args, **kwargs)

Construct a new all-grants-in-one server.

:param request_validator: An implementation of oauthlib.oauth2.RequestValidator. :param token_expires_in: An int or a function to generate a token expiration offset (in seconds) given a oauthlib.common.Request object. :param token_generator: A function to generate a token from a request. :param refresh_token_generator: A function to generate a token from a request for the refresh token. :param kwargs: Extra parameters to pass to authorization-, token-, resource-, and revocation-endpoint constructors.

Source code in server/vendor/oauthlib/oauth2/rfc6749/endpoints/pre_configured.py 
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
def __init__(self, request_validator, token_expires_in=None,
             token_generator=None, refresh_token_generator=None,
             *args, **kwargs):
    """Construct a new all-grants-in-one server.

    :param request_validator: An implementation of
                              oauthlib.oauth2.RequestValidator.
    :param token_expires_in: An int or a function to generate a token
                             expiration offset (in seconds) given a
                             oauthlib.common.Request object.
    :param token_generator: A function to generate a token from a request.
    :param refresh_token_generator: A function to generate a token from a
                                    request for the refresh token.
    :param kwargs: Extra parameters to pass to authorization-,
                   token-, resource-, and revocation-endpoint constructors.
    """
    self.auth_grant = AuthorizationCodeGrant(request_validator)
    self.implicit_grant = ImplicitGrant(request_validator)
    self.password_grant = ResourceOwnerPasswordCredentialsGrant(
        request_validator)
    self.credentials_grant = ClientCredentialsGrant(request_validator)
    self.refresh_grant = RefreshTokenGrant(request_validator)

    self.bearer = BearerToken(request_validator, token_generator,
                         token_expires_in, refresh_token_generator)

    AuthorizationEndpoint.__init__(self, default_response_type='code',
                                   response_types={
                                       'code': self.auth_grant,
                                       'token': self.implicit_grant,
                                       'none': self.auth_grant
                                   },
                                   default_token_type=self.bearer)

    TokenEndpoint.__init__(self, default_grant_type='authorization_code',
                           grant_types={
                               'authorization_code': self.auth_grant,
                               'password': self.password_grant,
                               'client_credentials': self.credentials_grant,
                               'refresh_token': self.refresh_grant,
                           },
                           default_token_type=self.bearer)
    ResourceEndpoint.__init__(self, default_token='Bearer',
                              token_types={'Bearer': self.bearer})
    RevocationEndpoint.__init__(self, request_validator)
    IntrospectEndpoint.__init__(self, request_validator)

WebApplicationServer

Bases: AuthorizationEndpoint, IntrospectEndpoint, TokenEndpoint, ResourceEndpoint, RevocationEndpoint

An all-in-one endpoint featuring Authorization code grant and Bearer tokens.

Source code in server/vendor/oauthlib/oauth2/rfc6749/endpoints/pre_configured.py 
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
class WebApplicationServer(AuthorizationEndpoint, IntrospectEndpoint, TokenEndpoint,
                           ResourceEndpoint, RevocationEndpoint):

    """An all-in-one endpoint featuring Authorization code grant and Bearer tokens."""

    def __init__(self, request_validator, token_generator=None,
                 token_expires_in=None, refresh_token_generator=None, **kwargs):
        """Construct a new web application server.

        :param request_validator: An implementation of
                                  oauthlib.oauth2.RequestValidator.
        :param token_expires_in: An int or a function to generate a token
                                 expiration offset (in seconds) given a
                                 oauthlib.common.Request object.
        :param token_generator: A function to generate a token from a request.
        :param refresh_token_generator: A function to generate a token from a
                                        request for the refresh token.
        :param kwargs: Extra parameters to pass to authorization-,
                       token-, resource-, and revocation-endpoint constructors.
        """
        self.auth_grant = AuthorizationCodeGrant(request_validator)
        self.refresh_grant = RefreshTokenGrant(request_validator)
        self.bearer = BearerToken(request_validator, token_generator,
                             token_expires_in, refresh_token_generator)
        AuthorizationEndpoint.__init__(self, default_response_type='code',
                                       response_types={'code': self.auth_grant},
                                       default_token_type=self.bearer)
        TokenEndpoint.__init__(self, default_grant_type='authorization_code',
                               grant_types={
                                   'authorization_code': self.auth_grant,
                                   'refresh_token': self.refresh_grant,
                               },
                               default_token_type=self.bearer)
        ResourceEndpoint.__init__(self, default_token='Bearer',
                                  token_types={'Bearer': self.bearer})
        RevocationEndpoint.__init__(self, request_validator)
        IntrospectEndpoint.__init__(self, request_validator)

__init__(request_validator, token_generator=None, token_expires_in=None, refresh_token_generator=None, **kwargs)

Construct a new web application server.

:param request_validator: An implementation of oauthlib.oauth2.RequestValidator. :param token_expires_in: An int or a function to generate a token expiration offset (in seconds) given a oauthlib.common.Request object. :param token_generator: A function to generate a token from a request. :param refresh_token_generator: A function to generate a token from a request for the refresh token. :param kwargs: Extra parameters to pass to authorization-, token-, resource-, and revocation-endpoint constructors.

Source code in server/vendor/oauthlib/oauth2/rfc6749/endpoints/pre_configured.py 
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
def __init__(self, request_validator, token_generator=None,
             token_expires_in=None, refresh_token_generator=None, **kwargs):
    """Construct a new web application server.

    :param request_validator: An implementation of
                              oauthlib.oauth2.RequestValidator.
    :param token_expires_in: An int or a function to generate a token
                             expiration offset (in seconds) given a
                             oauthlib.common.Request object.
    :param token_generator: A function to generate a token from a request.
    :param refresh_token_generator: A function to generate a token from a
                                    request for the refresh token.
    :param kwargs: Extra parameters to pass to authorization-,
                   token-, resource-, and revocation-endpoint constructors.
    """
    self.auth_grant = AuthorizationCodeGrant(request_validator)
    self.refresh_grant = RefreshTokenGrant(request_validator)
    self.bearer = BearerToken(request_validator, token_generator,
                         token_expires_in, refresh_token_generator)
    AuthorizationEndpoint.__init__(self, default_response_type='code',
                                   response_types={'code': self.auth_grant},
                                   default_token_type=self.bearer)
    TokenEndpoint.__init__(self, default_grant_type='authorization_code',
                           grant_types={
                               'authorization_code': self.auth_grant,
                               'refresh_token': self.refresh_grant,
                           },
                           default_token_type=self.bearer)
    ResourceEndpoint.__init__(self, default_token='Bearer',
                              token_types={'Bearer': self.bearer})
    RevocationEndpoint.__init__(self, request_validator)
    IntrospectEndpoint.__init__(self, request_validator)