File

src/app/dto/oidc-discovery.dto.ts

Description

Data Transfer Object for OIDC Discovery Response. Based on OpenID Connect Discovery 1.0 specification.

Index

Properties

Properties

acr_values_supported
acr_values_supported: string[]
Type : string[]
Optional

JSON array containing a list of the Authentication Context Class References that this OP supports.

authorization_endpoint
authorization_endpoint: string
Type : string
Optional

URL of the OP's OAuth 2.0 Authorization Endpoint.

claim_types_supported
claim_types_supported: string[]
Type : string[]
Optional

JSON array containing a list of the Claim Types that the OpenID Provider supports.

claims_locales_supported
claims_locales_supported: string[]
Type : string[]
Optional

Languages and scripts supported for values in Claims being returned.

claims_parameter_supported
claims_parameter_supported: boolean
Type : boolean
Optional

Boolean value specifying whether the OP supports use of the claims parameter.

claims_supported
claims_supported: string[]
Type : string[]
Optional

JSON array containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for.

display_values_supported
display_values_supported: string[]
Type : string[]
Optional

JSON array containing a list of the display parameter values that the OpenID Provider supports.

grant_types_supported
grant_types_supported: string[]
Type : string[]
Optional

JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports.

id_token_encryption_alg_values_supported
id_token_encryption_alg_values_supported: string[]
Type : string[]
Optional

JSON array containing a list of the JWE encryption algorithms supported by the OP for the ID Token.

id_token_encryption_enc_values_supported
id_token_encryption_enc_values_supported: string[]
Type : string[]
Optional

JSON array containing a list of the JWE encryption methods supported by the OP for the ID Token.

id_token_signing_alg_values_supported
id_token_signing_alg_values_supported: string[]
Type : string[]

JSON array containing a list of the JWS signing algorithms supported by the OP for the ID Token.

issuer
issuer: string
Type : string

URL using the https scheme with no query or fragment component that the OP asserts as its Issuer Identifier.

jwks_uri
jwks_uri: string
Type : string

URL of the OP's JSON Web Key Set document.

op_policy_uri
op_policy_uri: string
Type : string
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.

op_tos_uri
op_tos_uri: string
Type : string
Optional

URL that the OpenID Provider provides to the person registering the Client to read about OpenID Provider's terms of service.

registration_endpoint
registration_endpoint: string
Type : string
Optional

URL of the OP's Dynamic Client Registration Endpoint.

request_object_encryption_alg_values_supported
request_object_encryption_alg_values_supported: string[]
Type : string[]
Optional

JSON array containing a list of the JWE encryption algorithms supported by the OP for Request Objects.

request_object_encryption_enc_values_supported
request_object_encryption_enc_values_supported: string[]
Type : string[]
Optional

JSON array containing a list of the JWE encryption methods supported by the OP for Request Objects.

request_object_signing_alg_values_supported
request_object_signing_alg_values_supported: string[]
Type : string[]
Optional

JSON array containing a list of the JWS signing algorithms supported by the OP for Request Objects.

request_parameter_supported
request_parameter_supported: boolean
Type : boolean
Optional

Boolean value specifying whether the OP supports use of the request parameter.

request_uri_parameter_supported
request_uri_parameter_supported: boolean
Type : boolean
Optional

Boolean value specifying whether the OP supports use of the request_uri parameter.

require_request_uri_registration
require_request_uri_registration: boolean
Type : boolean
Optional

Boolean value specifying whether the OP requires any request_uri values used to be pre-registered.

response_modes_supported
response_modes_supported: string[]
Type : string[]
Optional

JSON array containing a list of the OAuth 2.0 response_mode values that this OP supports.

response_types_supported
response_types_supported: string[]
Type : string[]

JSON array containing a list of the OAuth 2.0 response_type values that this OP supports.

scopes_supported
scopes_supported: string[]
Type : string[]
Optional

JSON array containing a list of the OAuth 2.0 scope values that this server supports.

service_documentation
service_documentation: string
Type : string
Optional

URL of a page containing human-readable information that developers might want or need to know when using the OpenID Provider.

subject_types_supported
subject_types_supported: string[]
Type : string[]

JSON array containing a list of the Subject Identifier types that this OP supports.

token_endpoint
token_endpoint: string
Type : string

URL of the OP's OAuth 2.0 Token Endpoint.

token_endpoint_auth_methods_supported
token_endpoint_auth_methods_supported: string[]
Type : string[]
Optional

JSON array containing a list of Client Authentication methods supported by this Token Endpoint.

token_endpoint_auth_signing_alg_values_supported
token_endpoint_auth_signing_alg_values_supported: string[]
Type : string[]
Optional

JSON array containing a list of the JWS signing algorithms 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.

ui_locales_supported
ui_locales_supported: string[]
Type : string[]
Optional

Languages and scripts supported for the user interface.

userinfo_encryption_alg_values_supported
userinfo_encryption_alg_values_supported: string[]
Type : string[]
Optional

JSON array containing a list of the JWE encryption algorithms supported by the OP for UserInfo Responses.

userinfo_encryption_enc_values_supported
userinfo_encryption_enc_values_supported: string[]
Type : string[]
Optional

JSON array containing a list of the JWE encryption methods supported by the OP for UserInfo Responses.

userinfo_endpoint
userinfo_endpoint: string
Type : string
Optional

URL of the OP's UserInfo Endpoint.

userinfo_signing_alg_values_supported
userinfo_signing_alg_values_supported: string[]
Type : string[]
Optional

JSON array containing a list of the JWS signing algorithms supported by the OP for UserInfo Responses.

export interface OidcDiscoveryDto {
    /**
     * URL using the https scheme with no query or fragment component that the OP asserts as its Issuer Identifier.
     */
    issuer: string;

    /**
     * URL of the OP's OAuth 2.0 Authorization Endpoint.
     */
    authorization_endpoint?: string;

    /**
     * URL of the OP's OAuth 2.0 Token Endpoint.
     */
    token_endpoint: string;

    /**
     * URL of the OP's UserInfo Endpoint.
     */
    userinfo_endpoint?: string;

    /**
     * URL of the OP's JSON Web Key Set document.
     */
    jwks_uri: string;

    /**
     * URL of the OP's Dynamic Client Registration Endpoint.
     */
    registration_endpoint?: string;

    /**
     * JSON array containing a list of the OAuth 2.0 scope values that this server supports.
     */
    scopes_supported?: string[];

    /**
     * JSON array containing a list of the OAuth 2.0 response_type values that this OP supports.
     */
    response_types_supported: string[];

    /**
     * JSON array containing a list of the OAuth 2.0 response_mode values that this OP supports.
     */
    response_modes_supported?: string[];

    /**
     * JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports.
     */
    grant_types_supported?: string[];

    /**
     * JSON array containing a list of the Authentication Context Class References that this OP supports.
     */
    acr_values_supported?: string[];

    /**
     * JSON array containing a list of the Subject Identifier types that this OP supports.
     */
    subject_types_supported: string[];

    /**
     * JSON array containing a list of the JWS signing algorithms supported by the OP for the ID Token.
     */
    id_token_signing_alg_values_supported: string[];

    /**
     * JSON array containing a list of the JWE encryption algorithms supported by the OP for the ID Token.
     */
    id_token_encryption_alg_values_supported?: string[];

    /**
     * JSON array containing a list of the JWE encryption methods supported by the OP for the ID Token.
     */
    id_token_encryption_enc_values_supported?: string[];

    /**
     * JSON array containing a list of the JWS signing algorithms supported by the OP for UserInfo Responses.
     */
    userinfo_signing_alg_values_supported?: string[];

    /**
     * JSON array containing a list of the JWE encryption algorithms supported by the OP for UserInfo Responses.
     */
    userinfo_encryption_alg_values_supported?: string[];

    /**
     * JSON array containing a list of the JWE encryption methods supported by the OP for UserInfo Responses.
     */
    userinfo_encryption_enc_values_supported?: string[];

    /**
     * JSON array containing a list of the JWS signing algorithms supported by the OP for Request Objects.
     */
    request_object_signing_alg_values_supported?: string[];

    /**
     * JSON array containing a list of the JWE encryption algorithms supported by the OP for Request Objects.
     */
    request_object_encryption_alg_values_supported?: string[];

    /**
     * JSON array containing a list of the JWE encryption methods supported by the OP for Request Objects.
     */
    request_object_encryption_enc_values_supported?: string[];

    /**
     * JSON array containing a list of Client Authentication methods supported by this Token Endpoint.
     */
    token_endpoint_auth_methods_supported?: string[];

    /**
     * JSON array containing a list of the JWS signing algorithms 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.
     */
    token_endpoint_auth_signing_alg_values_supported?: string[];

    /**
     * JSON array containing a list of the display parameter values that the OpenID Provider supports.
     */
    display_values_supported?: string[];

    /**
     * JSON array containing a list of the Claim Types that the OpenID Provider supports.
     */
    claim_types_supported?: string[];

    /**
     * JSON array containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for.
     */
    claims_supported?: string[];

    /**
     * URL of a page containing human-readable information that developers might want or need to know when using the OpenID Provider.
     */
    service_documentation?: string;

    /**
     * Languages and scripts supported for values in Claims being returned.
     */
    claims_locales_supported?: string[];

    /**
     * Languages and scripts supported for the user interface.
     */
    ui_locales_supported?: string[];

    /**
     * Boolean value specifying whether the OP supports use of the claims parameter.
     */
    claims_parameter_supported?: boolean;

    /**
     * Boolean value specifying whether the OP supports use of the request parameter.
     */
    request_parameter_supported?: boolean;

    /**
     * Boolean value specifying whether the OP supports use of the request_uri parameter.
     */
    request_uri_parameter_supported?: boolean;

    /**
     * Boolean value specifying whether the OP requires any request_uri values used to be pre-registered.
     */
    require_request_uri_registration?: boolean;

    /**
     * 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.
     */
    op_policy_uri?: string;

    /**
     * URL that the OpenID Provider provides to the person registering the Client to read about OpenID Provider's terms of service.
     */
    op_tos_uri?: string;
}

results matching ""

    No results matching ""