v1

latestOpenAPI 3.0.1License2026-07-17467229.7 KB

UMA (User Managed Access)

Gets UMA configuration data.

get/restv1/uma2-configuration

Response

issuerstring required

The authorization server's issuer identifier, which is\n a URL that uses the "https" scheme and has no query or fragment\n components. This is the location where ".well-known" RFC 5785\n [RFC5785] resources containing information about the authorization\n server are published. Using these well-known resources is\n described in Section 3. The issuer identifier is used to prevent\n authorization server mix-up attacks, as described in "OAuth 2.0 Mix-Up Mitigation"

authorization_endpointstring required

URL of the authorization server's authorization endpoint.

token_endpointstring required

URL of the authorization server's token endpoint [RFC6749]. This is REQUIRED unless only the implicit grant type is used.

jwks_uristring

URL of the authorization server's JWK Set [JWK] document. The referenced document contains the signing key(s) the client uses to validate signatures from the authorization server. This URL MUST use the "https" scheme. The JWK Set MAY also contain the server's encryption key(s), which are used by clients to encrypt requests to the server. When both signing and encryption keys are made available, a "use" (public key use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage.

registration_endpointstring

URL of the authorization server's OAuth 2.0 Dynamic Client Registration endpoint [RFC7591]

response_types_supportedstring[] required

JSON array containing a list of the OAuth 2.0 "response_type" values that this authorization server supports. The array values used are the same as those used with the "response_types" parameter defined by "OAuth 2.0 Dynamic Client Registration Protocol" [RFC7591].

grant_types_supportedstring[]

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_supportedstring[]

JSON array containing a list of client authentication methods supported by this token endpoint. Client authentication method values are used in the "token_endpoint_auth_method" parameter defined in Section 2 of [RFC7591]. If omitted, the default is "client_secret_basic" -- the HTTP Basic Authentication Scheme specified in Section 2.3.1 of OAuth 2.0 [RFC6749].

token_endpoint_auth_signing_alg_values_supportedstring[]

JSON array containing a list of the JWS signing algorithms ("alg" values) supported by the token endpoint for the signature on the JWT [JWT] used to authenticate the client at the token endpoint for the "private_key_jwt" and "client_secret_jwt" authentication methods. Servers SHOULD support "RS256". The value "none" MUST NOT be used.

service_documentationstring

URL of a page containing human-readable information that developers might want or need to know when using the authorization server. In particular, if the authorization server does not support Dynamic Client Registration, then information on how to register clients needs to be provided in this documentation.

ui_locales_supportedstring[]

Languages and scripts supported for the user interface, represented as a JSON array of BCP47 [RFC5646] language tag values.

op_policy_uristring

URL that the authorization server provides to the person registering the client to read about the authorization server's requirements on how the client can use the data provided by the authorization server. The registration process SHOULD display this URL to the person registering the client if it is given. As described in Section 5, despite the identifier "op_policy_uri", appearing to be OpenID-specific, its usage in this specification is actually referring to a general OAuth 2.0 feature that is not specific to OpenID Connect.

op_tos_uristring

URL that the authorization server provides to the person registering the client to read about the authorization server's terms of service. The registration process SHOULD display this URL to the person registering the client if it is given. As described in Section 5, despite the identifier "op_tos_uri", appearing to be OpenID-specific, its usage in this specification is actually referring to a general OAuth 2.0 feature that is not specific to OpenID Connect.

introspection_endpointstring

URL of the authorization server's OAuth 2.0 introspection endpoint [RFC7662].

code_challenge_methods_supportedstring[]

JSON array containing a list of PKCE [RFC7636] code challenge methods supported by this authorization server. Code challenge method values are used in the "code_challenge_method" parameter defined in Section 4.3 of [RFC7636]. The valid code challenge method values are those registered in the IANA "PKCE Code Challenge Methods" registry [IANA.OAuth.Parameters]

claims_interaction_endpointstring

Static endpoint URI at which the authorization server declares that it interacts with end-user requesting parties to gather claims. If the authorization server also provides a claims interaction endpoint URI as part of its redirect_user hint in a need_info response to a client on authorization failure (see Section 3.3.6), that value overrides this metadata value. Providing the static endpoint URI is useful for enabling interactive claims gathering prior to any pushed-claims flows taking place, so that, for example, it is possible to gather requesting party authorization interactively for collecting all other claims in a "silent" fashion."

uma_profiles_supportedstring[]

UMA profiles supported by this authorization server. The value is an array of string values, where each string value is a URI identifying an UMA profile

permission_endpointstring

The endpoint URI at which the resource server requests permissions on the client's behalf.

resource_registration_endpointstring

The endpoint URI at which the resource server registers resources to put them under authorization manager protection.

scope_endpointstring

The Scope endpoint URI.

Example response

{
  "issuer": "https://sample.com",
  "authorization_endpoint": "https://sample.com/jans-auth/restv1/authorize",
  "token_endpoint": "https://sample.com/jans-auth/restv1/token",
  "jwks_uri": "https://sample.com/jans-auth/restv1/jwks",
  "registration_endpoint": "https://sample.com/jans-auth/restv1/register",
  "response_types_supported": [
    "code",
    "id_token",
    "token"
  ],
  "grant_types_supported": [
    "authorization_code",
    "implicit",
    "client_credentials"
  ],
  "token_endpoint_auth_methods_supported": [
    "client_secret_basic",
    "client_secret_post",
    "client_secret_jwt",
    "private_key_jwt"
  ],
  "token_endpoint_auth_signing_alg_values_supported": [
    "HS256",
    "HS384",
    "HS512",
    "RS256",
    "RS384",
    "RS512",
    "ES256",
    "ES384",
    "ES512"
  ],
  "service_documentation": "http://<op_docs>",
  "ui_locales_supported": [
    "en",
    "es"
  ],
  "op_policy_uri": "http://gluu.sample.com/policy",
  "op_tos_uri": "http://gluu.sample.com/tos",
  "introspection_endpoint": "https://sample.com/jans-auth/restv1/rpt/status",
  "claims_interaction_endpoint": "https://sample.com/jans-auth/restv1/uma/gather_claims",
  "permission_endpoint": "https://sample.com/jans-auth/restv1/host/rsrc_pr",
  "resource_registration_endpoint": "https://sample.com/jans-auth/restv1/host/rsrc/resource_set",
  "scope_endpoint": "https://sample.com/jans-auth/restv1/uma/scopes"
}