This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > OAuth2.Server.Metadata

OAuth2.Server.Metadata

persistent class OAuth2.Server.Metadata extends %Library.Persistent, OAuth2.Metadata

SQL Table Name: OAuth2_Server.Metadata

Authorization Server metadata as specified by OpenID Connect Discovery.
OPTIONAL, REQUIRED and RECOMMENDED in the property descriptions below refer to optional/required/recommended by the OpenID Connect specifications.

Property Inventory (Including Private)

Properties (Including Private)

property access_token_encryption_alg_values_supported as %List;
ADDITIONAL. An array, which is represented as a $list, containing a list of the JWE encryption algorithms (alg values) supported for access token returned as a JWT to encode the Claims in a JWT.
Property methods: access_token_encryption_alg_values_supportedGet(), access_token_encryption_alg_values_supportedGetStored(), access_token_encryption_alg_values_supportedIsValid(), access_token_encryption_alg_values_supportedLogicalToOdbc(), access_token_encryption_alg_values_supportedOdbcToLogical(), access_token_encryption_alg_values_supportedSet()
property access_token_encryption_enc_values_supported as %List;
ADDITIONAL. An array, which is represented as a $list, containing a list of the JWE encryption algorithms (enc values) supported for access token returned as a JWT to encode the Claims in a JWT.
Property methods: access_token_encryption_enc_values_supportedGet(), access_token_encryption_enc_values_supportedGetStored(), access_token_encryption_enc_values_supportedIsValid(), access_token_encryption_enc_values_supportedLogicalToOdbc(), access_token_encryption_enc_values_supportedOdbcToLogical(), access_token_encryption_enc_values_supportedSet()
property access_token_signing_alg_values_supported as %List;
ADDITIONAL. An array, which is represented as a $list, containing a list of the JWS signing algorithms (alg values) supported for access token returned as a JWT to encode the Claims in a JWT. The value none MAY be included.
Property methods: access_token_signing_alg_values_supportedGet(), access_token_signing_alg_values_supportedGetStored(), access_token_signing_alg_values_supportedIsValid(), access_token_signing_alg_values_supportedLogicalToOdbc(), access_token_signing_alg_values_supportedOdbcToLogical(), access_token_signing_alg_values_supportedSet()
property acr_values_supported as %List;
OPTIONAL. An array, which is represented as a $list, containing a list of the Authentication Context Class References that this OP supports.
This property is currently not supported and is ignored during registration.
Property methods: acr_values_supportedGet(), acr_values_supportedGetStored(), acr_values_supportedIsValid(), acr_values_supportedLogicalToOdbc(), acr_values_supportedOdbcToLogical(), acr_values_supportedSet()
property authorization_endpoint as %OAuth2.uri;
REQUIRED. URL of the OP's OAuth 2.0 Authorization Endpoint.
Property methods: authorization_endpointDisplayToLogical(), authorization_endpointGet(), authorization_endpointGetStored(), authorization_endpointIsValid(), authorization_endpointLogicalToDisplay(), authorization_endpointLogicalToOdbc(), authorization_endpointNormalize(), authorization_endpointSet()
property claim_types_supported as %List;
OPTIONAL. An array, which is represented as a $list, containing a list of the Claim Types that the OpenID Provider supports. These Claim Types are described in Section 5.6 of OpenID Connect Core. Values defined by this specification are normal, aggregated, and distributed.
This property is currently not supported and is ignored during registration. If omitted, the implementation supports only normal Claims.
Property methods: claim_types_supportedGet(), claim_types_supportedGetStored(), claim_types_supportedIsValid(), claim_types_supportedLogicalToOdbc(), claim_types_supportedOdbcToLogical(), claim_types_supportedSet()
property claims_locales_supported as %List;
OPTIONAL. Languages and scripts supported for values in Claims being returned as an array, which is represented as a $list, of RFC5646 language tag values. Not all languages and scripts are necessarily supported for all Claim values.
This property is currently not supported and is ignored during registration.
Property methods: claims_locales_supportedGet(), claims_locales_supportedGetStored(), claims_locales_supportedIsValid(), claims_locales_supportedLogicalToOdbc(), claims_locales_supportedOdbcToLogical(), claims_locales_supportedSet()
property claims_parameter_supported as %Boolean;
OPTIONAL. Boolean value specifying whether the OP supports use of the claims parameter, with true indicating support. If omitted, the default value is false.
Property methods: claims_parameter_supportedDisplayToLogical(), claims_parameter_supportedGet(), claims_parameter_supportedGetStored(), claims_parameter_supportedIsValid(), claims_parameter_supportedLogicalToDisplay(), claims_parameter_supportedNormalize(), claims_parameter_supportedSet()
property claims_supported as %List;
RECOMMENDED. An array, which is represented as a $list, containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for. Note that for privacy or other reasons, this might not be an exhaustive list.
Property methods: claims_supportedGet(), claims_supportedGetStored(), claims_supportedIsValid(), claims_supportedLogicalToOdbc(), claims_supportedOdbcToLogical(), claims_supportedSet()
property display_values_supported as %List;
OPTIONAL. An array, which is represented as a $list, containing a list of the display parameter values that the OpenID Provider supports. These values are described in Section 3.1.2.1 of OpenID Connect Core.
This property is currently not supported and is ignored during registration.
Property methods: display_values_supportedGet(), display_values_supportedGetStored(), display_values_supportedIsValid(), display_values_supportedLogicalToOdbc(), display_values_supportedOdbcToLogical(), display_values_supportedSet()
property grant_types_supported as %List;
OPTIONAL. An array, which is represented as a $list, containing a list of the OAuth 2.0 Grant Type values that this OP supports. Dynamic OpenID Providers MUST support the authorization_code and implicit Grant Type values and MAY support other Grant Types. If omitted, the default value is ["authorization_code", "implicit"].
Property methods: grant_types_supportedGet(), grant_types_supportedGetStored(), grant_types_supportedIsValid(), grant_types_supportedLogicalToOdbc(), grant_types_supportedOdbcToLogical(), grant_types_supportedSet()
property id_token_encryption_alg_values_supported as %List;
OPTIONAL. An array, which is represented as a $list, containing a list of the JWE encryption algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT.
Property methods: id_token_encryption_alg_values_supportedGet(), id_token_encryption_alg_values_supportedGetStored(), id_token_encryption_alg_values_supportedIsValid(), id_token_encryption_alg_values_supportedLogicalToOdbc(), id_token_encryption_alg_values_supportedOdbcToLogical(), id_token_encryption_alg_values_supportedSet()
property id_token_encryption_enc_values_supported as %List;
OPTIONAL. An array, which is represented as a $list, containing a list of the JWE encryption algorithms (enc values) supported by the OP for the ID Token to encode the Claims in a JWT.
Property methods: id_token_encryption_enc_values_supportedGet(), id_token_encryption_enc_values_supportedGetStored(), id_token_encryption_enc_values_supportedIsValid(), id_token_encryption_enc_values_supportedLogicalToOdbc(), id_token_encryption_enc_values_supportedOdbcToLogical(), id_token_encryption_enc_values_supportedSet()
property id_token_signing_alg_values_supported as %List;
REQUIRED. An array, which is represented as a $list, containing a list of the JWS signing algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT. The algorithm RS256 MUST be included. The value none MAY be supported, but MUST NOT be used unless the Response Type used returns no ID Token from the Authorization Endpoint (such As when using the Authorization Code Flow).
Property methods: id_token_signing_alg_values_supportedGet(), id_token_signing_alg_values_supportedGetStored(), id_token_signing_alg_values_supportedIsValid(), id_token_signing_alg_values_supportedLogicalToOdbc(), id_token_signing_alg_values_supportedOdbcToLogical(), id_token_signing_alg_values_supportedSet()
property introspection_endpoint as %OAuth2.uri;
ADDITIONAL. OAuth 2.0 introspection endpoint as defined by RFC 7662
Property methods: introspection_endpointDisplayToLogical(), introspection_endpointGet(), introspection_endpointGetStored(), introspection_endpointIsValid(), introspection_endpointLogicalToDisplay(), introspection_endpointLogicalToOdbc(), introspection_endpointNormalize(), introspection_endpointSet()
property issuer as %OAuth2.uri;
REQUIRED. URL using the https scheme with no query or fragment component that the OP asserts as its Issuer Identifier. This also MUST be identical to the iss Claim value in ID Tokens issued from this Issuer.
Property methods: issuerDisplayToLogical(), issuerGet(), issuerGetStored(), issuerIsValid(), issuerLogicalToDisplay(), issuerLogicalToOdbc(), issuerNormalize(), issuerSet()
property jwks_uri as %OAuth2.uri;
REQUIRED. URL of the OP's JSON Web Key Set document. This contains the signing key(s) the RP uses to validate signatures from the OP. The JWK Set MAY also contain the Server's encryption key(s), which are used by RPs to encrypt requests to the Server. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED," As it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate.
Property methods: jwks_uriDisplayToLogical(), jwks_uriGet(), jwks_uriGetStored(), jwks_uriIsValid(), jwks_uriLogicalToDisplay(), jwks_uriLogicalToOdbc(), jwks_uriNormalize(), jwks_uriSet()
property op_policy_uri as %OAuth2.uri;
OPTIONAL. URL that the OpenID Provider provides to the person registering the Client to read about the OP's requirements on how the Relying Party can use the data provided by the OP. The registration process SHOULD display this URL to the person registering the Client if it is given.
Property methods: op_policy_uriDisplayToLogical(), op_policy_uriGet(), op_policy_uriGetStored(), op_policy_uriIsValid(), op_policy_uriLogicalToDisplay(), op_policy_uriLogicalToOdbc(), op_policy_uriNormalize(), op_policy_uriSet()
property op_tos_uri as %OAuth2.uri;
OPTIONAL. URL that the OpenID Provider provides to the person registering the Client to read about OpenID Provider's terms of service. The registration process SHOULD display this URL to the person registering the Client if it is given.
Property methods: op_tos_uriDisplayToLogical(), op_tos_uriGet(), op_tos_uriGetStored(), op_tos_uriIsValid(), op_tos_uriLogicalToDisplay(), op_tos_uriLogicalToOdbc(), op_tos_uriNormalize(), op_tos_uriSet()
property registration_endpoint as %OAuth2.uri;
RECOMMENDED. URL of the OP's Dynamic Client Registration Endpoint.
Property methods: registration_endpointDisplayToLogical(), registration_endpointGet(), registration_endpointGetStored(), registration_endpointIsValid(), registration_endpointLogicalToDisplay(), registration_endpointLogicalToOdbc(), registration_endpointNormalize(), registration_endpointSet()
property request_object_encryption_alg_values_supported as %List;
OPTIONAL. An array, which is represented as a $list, containing a list of the JWE encryption algorithms (alg values) supported by the OP for Request Objects. These algorithms are used both when the Request Object is passed by value and when it is passed by reference.
Property methods: request_object_encryption_alg_values_supportedGet(), request_object_encryption_alg_values_supportedGetStored(), request_object_encryption_alg_values_supportedIsValid(), request_object_encryption_alg_values_supportedLogicalToOdbc(), request_object_encryption_alg_values_supportedOdbcToLogical(), request_object_encryption_alg_values_supportedSet()
property request_object_encryption_enc_values_supported as %List;
OPTIONAL. An array, which is represented as a $list, containing a list of the JWE encryption algorithms (enc values) supported by the OP for Request Objects. These algorithms are used both when the Request Object is passed by value and when it is passed by reference.
Property methods: request_object_encryption_enc_values_supportedGet(), request_object_encryption_enc_values_supportedGetStored(), request_object_encryption_enc_values_supportedIsValid(), request_object_encryption_enc_values_supportedLogicalToOdbc(), request_object_encryption_enc_values_supportedOdbcToLogical(), request_object_encryption_enc_values_supportedSet()
property request_object_signing_alg_values_supported as %List;
OPTIONAL. An array, which is represented as a $list, containing a list of the JWS signing algorithms (alg values) supported by the OP for Request Objects, which are described in Section 6.1 of OpenID Connect Core. These algorithms are used both when the Request Object is passed by value (using the request parameter) and when it is passed by reference (using the request_uri parameter). Servers SHOULD support none and RS256.
Property methods: request_object_signing_alg_values_supportedGet(), request_object_signing_alg_values_supportedGetStored(), request_object_signing_alg_values_supportedIsValid(), request_object_signing_alg_values_supportedLogicalToOdbc(), request_object_signing_alg_values_supportedOdbcToLogical(), request_object_signing_alg_values_supportedSet()
property request_parameter_supported as %Boolean;
OPTIONAL. Boolean value specifying whether the OP supports use of the request parameter, with true indicating support. If omitted, the default value is false.
Property methods: request_parameter_supportedDisplayToLogical(), request_parameter_supportedGet(), request_parameter_supportedGetStored(), request_parameter_supportedIsValid(), request_parameter_supportedLogicalToDisplay(), request_parameter_supportedNormalize(), request_parameter_supportedSet()
property request_uri_parameter_supported as %Boolean;
OPTIONAL. Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support. If omitted, the default value is true.
Property methods: request_uri_parameter_supportedDisplayToLogical(), request_uri_parameter_supportedGet(), request_uri_parameter_supportedGetStored(), request_uri_parameter_supportedIsValid(), request_uri_parameter_supportedLogicalToDisplay(), request_uri_parameter_supportedNormalize(), request_uri_parameter_supportedSet()
property require_request_uri_registration as %Boolean;
OPTIONAL. Boolean value specifying whether the OP requires any request_uri values used to be preregistered using the request_uris registration parameter. Preregistration is REQUIRED when the value istrue. If omitted, the default value is false.
This property is currently not supported and is ignored during registration.
Property methods: require_request_uri_registrationDisplayToLogical(), require_request_uri_registrationGet(), require_request_uri_registrationGetStored(), require_request_uri_registrationIsValid(), require_request_uri_registrationLogicalToDisplay(), require_request_uri_registrationNormalize(), require_request_uri_registrationSet()
property response_modes_supported as %List;
OPTIONAL. An array, which is represented as a $list, containing a list of the OAuth 2.0 response_mode values that this OP supports. If omitted, the default for Dynamic OpenID Providers is ["query", "fragment"].
Property methods: response_modes_supportedGet(), response_modes_supportedGetStored(), response_modes_supportedIsValid(), response_modes_supportedLogicalToOdbc(), response_modes_supportedOdbcToLogical(), response_modes_supportedSet()
property response_types_supported as %List;
REQUIRED. An array, which is represented as a $list, containing a list of the OAuth 2.0 response_type values that this OP supports. Dynamic OpenID Providers MUST support the code, id_token, and the token id_token Response Type values.
Property methods: response_types_supportedGet(), response_types_supportedGetStored(), response_types_supportedIsValid(), response_types_supportedLogicalToOdbc(), response_types_supportedOdbcToLogical(), response_types_supportedSet()
property revocation_endpoint as %OAuth2.uri;
ADDITIONAL. OAuth 2.0 revocation endpoint as defined by RFC 7009
Property methods: revocation_endpointDisplayToLogical(), revocation_endpointGet(), revocation_endpointGetStored(), revocation_endpointIsValid(), revocation_endpointLogicalToDisplay(), revocation_endpointLogicalToOdbc(), revocation_endpointNormalize(), revocation_endpointSet()
property scopes_supported as %List;
RECOMMENDED. An array, which is represented as a $list, containing a list of the RFC6749 scope values that this server supports. The server MUST support the openid scope value. Servers MAY choose not to advertise some supported scope values even when this parameter is used, although those defined in SHOULD be listed, if supported.
Property methods: scopes_supportedGet(), scopes_supportedGetStored(), scopes_supportedIsValid(), scopes_supportedLogicalToOdbc(), scopes_supportedOdbcToLogical(), scopes_supportedSet()
property service_documentation as %OAuth2.uri;
OPTIONAL. URL of a page containing humanreadable information that developers might want or need to know when using the OpenID Provider. In particular, if the OpenID Provider does not support Dynamic Client Registration, then information on how to register Clients needs to be provided in this documentation.
Property methods: service_documentationDisplayToLogical(), service_documentationGet(), service_documentationGetStored(), service_documentationIsValid(), service_documentationLogicalToDisplay(), service_documentationLogicalToOdbc(), service_documentationNormalize(), service_documentationSet()
property subject_types_supported as %List;
REQUIRED. An array, which is represented as a $list, containing a list of the Subject Identifier types that this OP supports. Valid types include pairwise and public.
This property is currently not supported and is ignored during registration.
Property methods: subject_types_supportedGet(), subject_types_supportedGetStored(), subject_types_supportedIsValid(), subject_types_supportedLogicalToOdbc(), subject_types_supportedOdbcToLogical(), subject_types_supportedSet()
property token_endpoint as %OAuth2.uri;
URL of the OP's OAuth 2.0 Token Endpoint. This is REQUIRED unless only the Implicit Flow is used.
Property methods: token_endpointDisplayToLogical(), token_endpointGet(), token_endpointGetStored(), token_endpointIsValid(), token_endpointLogicalToDisplay(), token_endpointLogicalToOdbc(), token_endpointNormalize(), token_endpointSet(), token_endpoint_auth_methods_supportedGet(), token_endpoint_auth_methods_supportedGetStored(), token_endpoint_auth_methods_supportedIsValid(), token_endpoint_auth_methods_supportedLogicalToOdbc(), token_endpoint_auth_methods_supportedOdbcToLogical(), token_endpoint_auth_methods_supportedSet(), token_endpoint_auth_signing_alg_values_supportedGet(), token_endpoint_auth_signing_alg_values_supportedGetStored(), token_endpoint_auth_signing_alg_values_supportedIsValid(), token_endpoint_auth_signing_alg_values_supportedLogicalToOdbc(), token_endpoint_auth_signing_alg_values_supportedOdbcToLogical(), token_endpoint_auth_signing_alg_values_supportedSet()
property token_endpoint_auth_methods_supported as %List;
OPTIONAL. An array, which is represented as a $list, containing a list of Client Authentication methods supported by this Token Endpoint. The options are client_secret_post, client_secret_basic, client_secret_jwt, and private_key_jwt, as described in Section 9 of OpenID Connect Core. If omitted, the default is client_secret_basic the HTTP Basic Authentication Scheme specified in Section 2.3.1 of RFC6749.
Property methods: token_endpoint_auth_methods_supportedGet(), token_endpoint_auth_methods_supportedGetStored(), token_endpoint_auth_methods_supportedIsValid(), token_endpoint_auth_methods_supportedLogicalToOdbc(), token_endpoint_auth_methods_supportedOdbcToLogical(), token_endpoint_auth_methods_supportedSet()
property token_endpoint_auth_signing_alg_values_supported as %List;
OPTIONAL. An array, which is represented as a $list, containing a list of the JWS signing algorithms (alg values) supported by the Token Endpoint for the signature on the 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.
Property methods: token_endpoint_auth_signing_alg_values_supportedGet(), token_endpoint_auth_signing_alg_values_supportedGetStored(), token_endpoint_auth_signing_alg_values_supportedIsValid(), token_endpoint_auth_signing_alg_values_supportedLogicalToOdbc(), token_endpoint_auth_signing_alg_values_supportedOdbcToLogical(), token_endpoint_auth_signing_alg_values_supportedSet()
property ui_locales_supported as %List;
OPTIONAL. Languages and scripts supported for the user interface, represented as an array, which is represented as a $list, of RFC5646 language tag values.
This property is currently not supported and is ignored during registration.
Property methods: ui_locales_supportedGet(), ui_locales_supportedGetStored(), ui_locales_supportedIsValid(), ui_locales_supportedLogicalToOdbc(), ui_locales_supportedOdbcToLogical(), ui_locales_supportedSet()
property userinfo_encryption_alg_values_supported as %List;
OPTIONAL. An array, which is represented as a $list, containing a list of the JWE encryption algorithms (alg values) supported by the UserInfo Endpoint to encode the Claims in a JWT.
Property methods: userinfo_encryption_alg_values_supportedGet(), userinfo_encryption_alg_values_supportedGetStored(), userinfo_encryption_alg_values_supportedIsValid(), userinfo_encryption_alg_values_supportedLogicalToOdbc(), userinfo_encryption_alg_values_supportedOdbcToLogical(), userinfo_encryption_alg_values_supportedSet()
property userinfo_encryption_enc_values_supported as %List;
OPTIONAL. An array, which is represented as a $list, containing a list of the JWE encryption algorithms (enc values) supported by the UserInfo Endpoint to encode the Claims in a JWT.
Property methods: userinfo_encryption_enc_values_supportedGet(), userinfo_encryption_enc_values_supportedGetStored(), userinfo_encryption_enc_values_supportedIsValid(), userinfo_encryption_enc_values_supportedLogicalToOdbc(), userinfo_encryption_enc_values_supportedOdbcToLogical(), userinfo_encryption_enc_values_supportedSet()
property userinfo_endpoint as %OAuth2.uri;
RECOMMENDED. URL of the OP's UserInfo Endpoint. This URL MUST use the https scheme and MAY contain port, path, and query parameter components.
Property methods: userinfo_endpointDisplayToLogical(), userinfo_endpointGet(), userinfo_endpointGetStored(), userinfo_endpointIsValid(), userinfo_endpointLogicalToDisplay(), userinfo_endpointLogicalToOdbc(), userinfo_endpointNormalize(), userinfo_endpointSet()
property userinfo_signing_alg_values_supported as %List;
OPTIONAL. An array, which is represented as a $list, containing a list of the JWS signing algorithms (alg values) supported by the UserInfo Endpoint to encode the Claims in a JWT. The value none MAY be included.
Property methods: userinfo_signing_alg_values_supportedGet(), userinfo_signing_alg_values_supportedGetStored(), userinfo_signing_alg_values_supportedIsValid(), userinfo_signing_alg_values_supportedLogicalToOdbc(), userinfo_signing_alg_values_supportedOdbcToLogical(), userinfo_signing_alg_values_supportedSet()

Inherited Members

Inherited Methods (Including Private)

Storage

Storage Model: CacheStorage (OAuth2.Server.Metadata)

^OAuth2.Server.MetadataD(ID)
=
%%CLASSNAME
issuer
authorization_endpoint
token_endpoint
userinfo_endpoint
revocation_endpoint
introspection_endpoint
jwks_uri
registration_endpoint
scopes_supported
response_types_supported
response_modes_supported
grant_types_supported
acr_values_supported
subject_types_supported
id_token_signing_alg_values_supported
id_token_encryption_alg_values_supported
id_token_encryption_enc_values_supported
userinfo_signing_alg_values_supported
userinfo_encryption_alg_values_supported
userinfo_encryption_enc_values_supported
access_token_signing_alg_values_supported
access_token_encryption_alg_values_supported
access_token_encryption_enc_values_supported
request_object_signing_alg_values_supported
request_object_encryption_alg_values_supported
request_object_encryption_enc_values_supported
token_endpoint_auth_methods_supported
token_endpoint_auth_signing_alg_values_supported
display_values_supported
claim_types_supported
claims_supported
claims_locales_supported
ui_locales_supported
claims_parameter_supported
request_parameter_supported
request_uri_parameter_supported
require_request_uri_registration
service_documentation
op_policy_uri
op_tos_uri