diff options
author | Jonathan Huot <jonathan.huot@thomsonreuters.com> | 2018-12-13 16:32:00 +0100 |
---|---|---|
committer | Jonathan Huot <jonathan.huot@thomsonreuters.com> | 2018-12-13 16:32:00 +0100 |
commit | 7a0b1e9cad04806bf4be5c7380e75aaf03ebec2c (patch) | |
tree | 40c85dcd577a1d8ed2cc9f2bdb5858112a8f09fb /oauthlib/oauth2/rfc6749 | |
parent | 5d9a9c90ba04f85477c7859a3cc7b13577fc24f9 (diff) | |
download | oauthlib-7a0b1e9cad04806bf4be5c7380e75aaf03ebec2c.tar.gz |
Add OAuth2.0 Authorization Server Metadata documentation
Diffstat (limited to 'oauthlib/oauth2/rfc6749')
-rw-r--r-- | oauthlib/oauth2/rfc6749/endpoints/metadata.py | 42 |
1 files changed, 33 insertions, 9 deletions
diff --git a/oauthlib/oauth2/rfc6749/endpoints/metadata.py b/oauthlib/oauth2/rfc6749/endpoints/metadata.py index 6d77b9f..ad56c42 100644 --- a/oauthlib/oauth2/rfc6749/endpoints/metadata.py +++ b/oauthlib/oauth2/rfc6749/endpoints/metadata.py @@ -32,14 +32,13 @@ class MetadataEndpoint(BaseEndpoint): `OpenID Connect Discovery 1.0` in a way that is compatible with OpenID Connect Discovery while being applicable to a wider set of OAuth 2.0 use cases. This is intentionally parallel to the way - that `OAuth 2.0 Dynamic Client Registration Protocol` [RFC7591] + that OAuth 2.0 Dynamic Client Registration Protocol [`RFC7591`_] generalized the dynamic client registration mechanisms defined by - `OpenID Connect Dynamic Client Registration 1.0` + OpenID Connect Dynamic Client Registration 1.0 in a way that is compatible with it. - .. _`OpenID Connect Discovery 1.0`: http://openid.net/specs/openid-connect-discovery-1_0.html - .. _`OAuth 2.0 Dynamic Client Registration Protocol`: https://tools.ietf.org/html/rfc7591 - .. _`OpenID Connect Dynamic Client Registration 1.0`: https://openid.net/specs/openid-connect-registration-1_0.html + .. _`OpenID Connect Discovery 1.0`: https://openid.net/specs/openid-connect-discovery-1_0.html + .. _`RFC7591`: https://tools.ietf.org/html/rfc7591 """ def __init__(self, endpoints, claims={}, raise_errors=True): @@ -127,18 +126,19 @@ class MetadataEndpoint(BaseEndpoint): """ Authorization servers can have metadata describing their configuration. The following authorization server metadata values - are used by this specification. More details can be found in `RFC8414` : + are used by this specification. More details can be found in + `RFC8414 section 2`_ : issuer REQUIRED authorization_endpoint URL of the authorization server's authorization endpoint - [RFC6749]. This is REQUIRED unless no grant types are supported + [`RFC6749#Authorization`_]. This is REQUIRED unless no grant types are supported that use the authorization endpoint. token_endpoint - URL of the authorization server's token endpoint [RFC6749]. This + URL of the authorization server's token endpoint [`RFC6749#Token`_]. This is REQUIRED unless only the implicit grant type is supported. scopes_supported @@ -151,26 +151,50 @@ class MetadataEndpoint(BaseEndpoint): jwks_uri registration_endpoint response_modes_supported + grant_types_supported + OPTIONAL. JSON array containing a list of the OAuth 2.0 grant + type values that this authorization server supports. The array + values used are the same as those used with the "grant_types" + parameter defined by "OAuth 2.0 Dynamic Client Registration + Protocol" [`RFC7591`_]. If omitted, the default value is + "["authorization_code", "implicit"]". + token_endpoint_auth_methods_supported + token_endpoint_auth_signing_alg_values_supported + service_documentation + ui_locales_supported + op_policy_uri + op_tos_uri + revocation_endpoint + revocation_endpoint_auth_methods_supported + revocation_endpoint_auth_signing_alg_values_supported + introspection_endpoint + introspection_endpoint_auth_methods_supported + introspection_endpoint_auth_signing_alg_values_supported + code_challenge_methods_supported Additional authorization server metadata parameters MAY also be used. Some are defined by other specifications, such as OpenID Connect - Discovery 1.0 [OpenID.Discovery]. + Discovery 1.0 [`OpenID.Discovery`_]. .. _`RFC8414 section 2`: https://tools.ietf.org/html/rfc8414#section-2 + .. _`RFC6749#Authorization`: https://tools.ietf.org/html/rfc6749#section-3.1 + .. _`RFC6749#Token`: https://tools.ietf.org/html/rfc6749#section-3.2 + .. _`RFC7591`: https://tools.ietf.org/html/rfc7591 + .. _`OpenID.Discovery`: https://openid.net/specs/openid-connect-discovery-1_0.html """ claims = copy.deepcopy(self.initial_claims) self.validate_metadata(claims, "issuer", is_required=True, is_issuer=True) |