AuthorizationRequest
@hyperledger/identus-sdk v7.0.0
@hyperledger/identus-sdk / plugins/internal/oidc / AuthorizationRequest
Class: AuthorizationRequest
Defined in: src/plugins/internal/oidc/protocols/AuthorizationRequest.ts:9
Constructors
Constructor
new AuthorizationRequest(
authServerMeta: {acr_values_supported?:string[];authorization_encryption_alg_values_supported?:string[];authorization_encryption_enc_values_supported?:string[];authorization_endpoint?:string;authorization_response_iss_parameter_supported?:boolean;authorization_signing_alg_values_supported?:string[];backchannel_authentication_endpoint?:string;backchannel_authentication_request_signing_alg_values_supported?:string[];backchannel_logout_session_supported?:boolean;backchannel_logout_supported?:boolean;backchannel_token_delivery_modes_supported?:string[];backchannel_user_code_parameter_supported?:boolean;check_session_iframe?:string;claim_types_supported?:string[];claims_locales_supported?:string[];claims_parameter_supported?:boolean;claims_supported?:string[];code_challenge_methods_supported?:string[];device_authorization_endpoint?:string;display_values_supported?:string[];dpop_signing_alg_values_supported?:string[];end_session_endpoint?:string;frontchannel_logout_session_supported?:boolean;frontchannel_logout_supported?:boolean;grant_types_supported?:string[];id_token_encryption_alg_values_supported?:string[];id_token_encryption_enc_values_supported?:string[];id_token_signing_alg_values_supported?:string[];introspection_encryption_alg_values_supported?:string[];introspection_encryption_enc_values_supported?:string[];introspection_endpoint?:string;introspection_endpoint_auth_methods_supported?:string[];introspection_endpoint_auth_signing_alg_values_supported?:string[];introspection_signing_alg_values_supported?:string[];issuer:string;jwks_uri?:string;mtls_endpoint_aliases?: { };op_policy_uri?:string;op_tos_uri?:string;pushed_authorization_request_endpoint?:string;registration_endpoint?:string;request_object_encryption_alg_values_supported?:string[];request_object_encryption_enc_values_supported?:string[];request_object_signing_alg_values_supported?:string[];request_parameter_supported?:boolean;request_uri_parameter_supported?:boolean;require_pushed_authorization_requests?:boolean;require_request_uri_registration?:boolean;require_signed_request_object?:boolean;response_modes_supported?:string[];response_types_supported?:string[];revocation_endpoint?:string;revocation_endpoint_auth_methods_supported?:string[];revocation_endpoint_auth_signing_alg_values_supported?:string[];scopes_supported?:string[];service_documentation?:string;signed_metadata?:string;subject_types_supported?:string[];tls_client_certificate_bound_access_tokens?:boolean;token_endpoint?:string;token_endpoint_auth_methods_supported?:string[];token_endpoint_auth_signing_alg_values_supported?:string[];ui_locales_supported?:string[];userinfo_encryption_alg_values_supported?:string[];userinfo_encryption_enc_values_supported?:string[];userinfo_endpoint?:string;userinfo_signing_alg_values_supported?:string[]; },issuerMeta: {authorization_servers?:string[];batch_credential_endpoint?:string;credential_configurations_supported: {[key:string]: {credential_definition: {credentialSubject?: { };type:string[]; };credential_signing_alg_values_supported?:string[];cryptographic_binding_methods_supported?:string[];format:string;proof_types_supported?: {[key:string]: {proof_signing_alg_values_supported:string[]; }; };scope?:string; }; };credential_endpoint:string;credential_identifiers_supported?:boolean;credential_issuer:string;credential_response_encryption?: {alg_values_supported:string[];enc_values_supported:string[];encryption_required:boolean; };deferred_credential_endpoint?:string;display?: { };notification_endpoint?:string;signed_metadata?:string; }):AuthorizationRequest
Defined in: src/plugins/internal/oidc/protocols/AuthorizationRequest.ts:13
Parameters
| Parameter | Type | Description |
|---|---|---|
authServerMeta | { acr_values_supported?: string[]; authorization_encryption_alg_values_supported?: string[]; authorization_encryption_enc_values_supported?: string[]; authorization_endpoint?: string; authorization_response_iss_parameter_supported?: boolean; authorization_signing_alg_values_supported?: string[]; backchannel_authentication_endpoint?: string; backchannel_authentication_request_signing_alg_values_supported?: string[]; backchannel_logout_session_supported?: boolean; backchannel_logout_supported?: boolean; backchannel_token_delivery_modes_supported?: string[]; backchannel_user_code_parameter_supported?: boolean; check_session_iframe?: string; claim_types_supported?: string[]; claims_locales_supported?: string[]; claims_parameter_supported?: boolean; claims_supported?: string[]; code_challenge_methods_supported?: string[]; device_authorization_endpoint?: string; display_values_supported?: string[]; dpop_signing_alg_values_supported?: string[]; end_session_endpoint?: string; frontchannel_logout_session_supported?: boolean; frontchannel_logout_supported?: boolean; grant_types_supported?: string[]; id_token_encryption_alg_values_supported?: string[]; id_token_encryption_enc_values_supported?: string[]; id_token_signing_alg_values_supported?: string[]; introspection_encryption_alg_values_supported?: string[]; introspection_encryption_enc_values_supported?: string[]; introspection_endpoint?: string; introspection_endpoint_auth_methods_supported?: string[]; introspection_endpoint_auth_signing_alg_values_supported?: string[]; introspection_signing_alg_values_supported?: string[]; issuer: string; jwks_uri?: string; mtls_endpoint_aliases?: { }; op_policy_uri?: string; op_tos_uri?: string; pushed_authorization_request_endpoint?: string; registration_endpoint?: string; request_object_encryption_alg_values_supported?: string[]; request_object_encryption_enc_values_supported?: string[]; request_object_signing_alg_values_supported?: string[]; request_parameter_supported?: boolean; request_uri_parameter_supported?: boolean; require_pushed_authorization_requests?: boolean; require_request_uri_registration?: boolean; require_signed_request_object?: boolean; response_modes_supported?: string[]; response_types_supported?: string[]; revocation_endpoint?: string; revocation_endpoint_auth_methods_supported?: string[]; revocation_endpoint_auth_signing_alg_values_supported?: string[]; scopes_supported?: string[]; service_documentation?: string; signed_metadata?: string; subject_types_supported?: string[]; tls_client_certificate_bound_access_tokens?: boolean; token_endpoint?: string; token_endpoint_auth_methods_supported?: string[]; token_endpoint_auth_signing_alg_values_supported?: string[]; ui_locales_supported?: string[]; userinfo_encryption_alg_values_supported?: string[]; userinfo_encryption_enc_values_supported?: string[]; userinfo_endpoint?: string; userinfo_signing_alg_values_supported?: string[]; } | - |
authServerMeta.acr_values_supported? | string[] | JSON array containing a list of the Authentication Context Class References that this authorization server supports. |
authServerMeta.authorization_encryption_alg_values_supported? | string[] | JSON array containing a list of algorithms supported by the authorization server for introspection response encryption (alg value). |
authServerMeta.authorization_encryption_enc_values_supported? | string[] | JSON array containing a list of algorithms supported by the authorization server for introspection response encryption (enc value). |
authServerMeta.authorization_endpoint? | string | URL of the authorization server's authorization endpoint. |
authServerMeta.authorization_response_iss_parameter_supported? | boolean | Boolean value indicating whether the authorization server provides the iss parameter in the authorization response. |
authServerMeta.authorization_signing_alg_values_supported? | string[] | JSON array containing a list of algorithms supported by the authorization server for introspection response signing. |
authServerMeta.backchannel_authentication_endpoint? | string | CIBA Backchannel Authentication Endpoint. |
authServerMeta.backchannel_authentication_request_signing_alg_values_supported? | string[] | JSON array containing a list of the JWS signing algorithms supported for validation of signed CIBA authentication requests. |
authServerMeta.backchannel_logout_session_supported? | boolean | Boolean value specifying whether the authorization server can pass a sid (session ID) Claim in the Logout Token to identify the RP session with the OP. |
authServerMeta.backchannel_logout_supported? | boolean | Boolean value specifying whether the authorization server supports back-channel logout. |
authServerMeta.backchannel_token_delivery_modes_supported? | string[] | Supported CIBA authentication result delivery modes. |
authServerMeta.backchannel_user_code_parameter_supported? | boolean | Indicates whether the authorization server supports the use of the CIBA user_code parameter. |
authServerMeta.check_session_iframe? | string | URL of an authorization server iframe that supports cross-origin communications for session state information with the RP Client, using the HTML5 postMessage API. |
authServerMeta.claim_types_supported? | string[] | JSON array containing a list of the Claim Types that the authorization server supports. |
authServerMeta.claims_locales_supported? | string[] | Languages and scripts supported for values in Claims being returned, represented as a JSON array of RFC 5646 language tag values. |
authServerMeta.claims_parameter_supported? | boolean | Boolean value specifying whether the authorization server supports use of the claims parameter. |
authServerMeta.claims_supported? | string[] | JSON array containing a list of the Claim Names of the Claims that the authorization server MAY be able to supply values for. |
authServerMeta.code_challenge_methods_supported? | string[] | PKCE code challenge methods supported by this authorization server. |
authServerMeta.device_authorization_endpoint? | string | URL of the authorization server's device authorization endpoint. |
authServerMeta.display_values_supported? | string[] | JSON array containing a list of the display parameter values that the authorization server supports. |
authServerMeta.dpop_signing_alg_values_supported? | string[] | JSON array containing a list of the JWS algorithms supported for DPoP proof JWTs. |
authServerMeta.end_session_endpoint? | string | URL at the authorization server to which an RP can perform a redirect to request that the End-User be logged out at the authorization server. |
authServerMeta.frontchannel_logout_session_supported? | boolean | Boolean value specifying whether the authorization server can pass iss (issuer) and sid (session ID) query parameters to identify the RP session with the authorization server when the frontchannel_logout_uri is used. |
authServerMeta.frontchannel_logout_supported? | boolean | Boolean value specifying whether the authorization server supports HTTP-based logout. |
authServerMeta.grant_types_supported? | string[] | JSON array containing a list of the grant_type values that this authorization server supports. |
authServerMeta.id_token_encryption_alg_values_supported? | string[] | JSON array containing a list of the JWE alg values supported by the authorization server for the ID Token. |
authServerMeta.id_token_encryption_enc_values_supported? | string[] | JSON array containing a list of the JWE enc values supported by the authorization server for the ID Token. |
authServerMeta.id_token_signing_alg_values_supported? | string[] | JSON array containing a list of the JWS alg values supported by the authorization server for the ID Token. |
authServerMeta.introspection_encryption_alg_values_supported? | string[] | JSON array containing a list of algorithms supported by the authorization server for introspection response content key encryption (alg value). |
authServerMeta.introspection_encryption_enc_values_supported? | string[] | JSON array containing a list of algorithms supported by the authorization server for introspection response content encryption (enc value). |
authServerMeta.introspection_endpoint? | string | URL of the authorization server's introspection endpoint. |
authServerMeta.introspection_endpoint_auth_methods_supported? | string[] | JSON array containing a list of client authentication methods supported by this introspection endpoint. |
authServerMeta.introspection_endpoint_auth_signing_alg_values_supported? | string[] | JSON array containing a list of the JWS signing algorithms supported by the introspection endpoint for the signature on the JWT used to authenticate the client at the introspection endpoint. |
authServerMeta.introspection_signing_alg_values_supported? | string[] | JSON array containing a list of algorithms supported by the authorization server for introspection response signing. |
authServerMeta.issuer | string | Authorization server's Issuer Identifier URL. |
authServerMeta.jwks_uri? | string | URL of the authorization server's JWK Set document. |
authServerMeta.mtls_endpoint_aliases? | { } | JSON object containing alternative authorization server endpoints, which a client intending to do mutual TLS will use in preference to the conventional endpoints. |
authServerMeta.op_policy_uri? | string | 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. |
authServerMeta.op_tos_uri? | string | URL that the authorization server provides to the person registering the client to read about the authorization server's terms of service. |
authServerMeta.pushed_authorization_request_endpoint? | string | URL of the authorization server's pushed authorization request endpoint. |
authServerMeta.registration_endpoint? | string | URL of the authorization server's Dynamic Client Registration Endpoint. |
authServerMeta.request_object_encryption_alg_values_supported? | string[] | JSON array containing a list of the JWE alg values supported by the authorization server for Request Objects. |
authServerMeta.request_object_encryption_enc_values_supported? | string[] | JSON array containing a list of the JWE enc values supported by the authorization server for Request Objects. |
authServerMeta.request_object_signing_alg_values_supported? | string[] | JSON array containing a list of the JWS alg values supported by the authorization server for Request Objects. |
authServerMeta.request_parameter_supported? | boolean | Boolean value specifying whether the authorization server supports use of the request parameter. |
authServerMeta.request_uri_parameter_supported? | boolean | Boolean value specifying whether the authorization server supports use of the request_uri parameter. |
authServerMeta.require_pushed_authorization_requests? | boolean | Indicates whether the authorization server accepts authorization requests only via PAR. |
authServerMeta.require_request_uri_registration? | boolean | Boolean value specifying whether the authorization server requires any request_uri values used to be pre-registered. |
authServerMeta.require_signed_request_object? | boolean | Indicates where authorization request needs to be protected as Request Object and provided through either request or request_uri parameter. |
authServerMeta.response_modes_supported? | string[] | JSON array containing a list of the response_mode values that this authorization server supports. |
authServerMeta.response_types_supported? | string[] | JSON array containing a list of the response_type values that this authorization server supports. |
authServerMeta.revocation_endpoint? | string | URL of the authorization server's revocation endpoint. |
authServerMeta.revocation_endpoint_auth_methods_supported? | string[] | JSON array containing a list of client authentication methods supported by this revocation endpoint. |
authServerMeta.revocation_endpoint_auth_signing_alg_values_supported? | string[] | JSON array containing a list of the JWS signing algorithms supported by the revocation endpoint for the signature on the JWT used to authenticate the client at the revocation endpoint. |
authServerMeta.scopes_supported? | string[] | JSON array containing a list of the scope values that this authorization server supports. |
authServerMeta.service_documentation? | string | URL of a page containing human-readable information that developers might want or need to know when using the authorization server. |
authServerMeta.signed_metadata? | string | Signed JWT containing metadata values about the authorization server as claims. |
authServerMeta.subject_types_supported? | string[] | JSON array containing a list of the Subject Identifier types that this authorization server supports. |
authServerMeta.tls_client_certificate_bound_access_tokens? | boolean | Indicates authorization server support for mutual-TLS client certificate-bound access tokens. |
authServerMeta.token_endpoint? | string | URL of the authorization server's token endpoint. |
authServerMeta.token_endpoint_auth_methods_supported? | string[] | JSON array containing a list of client authentication methods supported by this token endpoint. |
authServerMeta.token_endpoint_auth_signing_alg_values_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. |
authServerMeta.ui_locales_supported? | string[] | Languages and scripts supported for the user interface, represented as a JSON array of language tag values from RFC 5646. |
authServerMeta.userinfo_encryption_alg_values_supported? | string[] | JSON array containing a list of the JWE alg values supported by the UserInfo Endpoint. |
authServerMeta.userinfo_encryption_enc_values_supported? | string[] | JSON array containing a list of the JWE enc values supported by the UserInfo Endpoint. |
authServerMeta.userinfo_endpoint? | string | URL of the authorization server's UserInfo Endpoint. |
authServerMeta.userinfo_signing_alg_values_supported? | string[] | JSON array containing a list of the JWS alg values supported by the UserInfo Endpoint. |
issuerMeta | { authorization_servers?: string[]; batch_credential_endpoint?: string; credential_configurations_supported: {[key: string]: { credential_definition: { credentialSubject?: { }; type: string[]; }; credential_signing_alg_values_supported?: string[]; cryptographic_binding_methods_supported?: string[]; format: string; proof_types_supported?: {[key: string]: { proof_signing_alg_values_supported: string[]; }; }; scope?: string; }; }; credential_endpoint: string; credential_identifiers_supported?: boolean; credential_issuer: string; credential_response_encryption?: { alg_values_supported: string[]; enc_values_supported: string[]; encryption_required: boolean; }; deferred_credential_endpoint?: string; display?: { }; notification_endpoint?: string; signed_metadata?: string; } | - |
issuerMeta.authorization_servers? | string[] | - |
issuerMeta.batch_credential_endpoint? | string | - |
issuerMeta.credential_configurations_supported | {[key: string]: { credential_definition: { credentialSubject?: { }; type: string[]; }; credential_signing_alg_values_supported?: string[]; cryptographic_binding_methods_supported?: string[]; format: string; proof_types_supported?: {[key: string]: { proof_signing_alg_values_supported: string[]; }; }; scope?: string; }; } | - |
issuerMeta.credential_endpoint | string | - |
issuerMeta.credential_identifiers_supported? | boolean | - |
issuerMeta.credential_issuer | string | - |
issuerMeta.credential_response_encryption? | { alg_values_supported: string[]; enc_values_supported: string[]; encryption_required: boolean; } | - |
issuerMeta.credential_response_encryption.alg_values_supported | string[] | - |
issuerMeta.credential_response_encryption.enc_values_supported | string[] | - |
issuerMeta.credential_response_encryption.encryption_required | boolean | - |
issuerMeta.deferred_credential_endpoint? | string | - |
issuerMeta.display? | { } | - |
issuerMeta.notification_endpoint? | string | - |
issuerMeta.signed_metadata? | string | - |
Returns
AuthorizationRequest
Properties
| Property | Modifier | Type | Default value | Description | Defined in |
|---|---|---|---|---|---|
authServerMeta | readonly | { acr_values_supported?: string[]; authorization_encryption_alg_values_supported?: string[]; authorization_encryption_enc_values_supported?: string[]; authorization_endpoint?: string; authorization_response_iss_parameter_supported?: boolean; authorization_signing_alg_values_supported?: string[]; backchannel_authentication_endpoint?: string; backchannel_authentication_request_signing_alg_values_supported?: string[]; backchannel_logout_session_supported?: boolean; backchannel_logout_supported?: boolean; backchannel_token_delivery_modes_supported?: string[]; backchannel_user_code_parameter_supported?: boolean; check_session_iframe?: string; claim_types_supported?: string[]; claims_locales_supported?: string[]; claims_parameter_supported?: boolean; claims_supported?: string[]; code_challenge_methods_supported?: string[]; device_authorization_endpoint?: string; display_values_supported?: string[]; dpop_signing_alg_values_supported?: string[]; end_session_endpoint?: string; frontchannel_logout_session_supported?: boolean; frontchannel_logout_supported?: boolean; grant_types_supported?: string[]; id_token_encryption_alg_values_supported?: string[]; id_token_encryption_enc_values_supported?: string[]; id_token_signing_alg_values_supported?: string[]; introspection_encryption_alg_values_supported?: string[]; introspection_encryption_enc_values_supported?: string[]; introspection_endpoint?: string; introspection_endpoint_auth_methods_supported?: string[]; introspection_endpoint_auth_signing_alg_values_supported?: string[]; introspection_signing_alg_values_supported?: string[]; issuer: string; jwks_uri?: string; mtls_endpoint_aliases?: { }; op_policy_uri?: string; op_tos_uri?: string; pushed_authorization_request_endpoint?: string; registration_endpoint?: string; request_object_encryption_alg_values_supported?: string[]; request_object_encryption_enc_values_supported?: string[]; request_object_signing_alg_values_supported?: string[]; request_parameter_supported?: boolean; request_uri_parameter_supported?: boolean; require_pushed_authorization_requests?: boolean; require_request_uri_registration?: boolean; require_signed_request_object?: boolean; response_modes_supported?: string[]; response_types_supported?: string[]; revocation_endpoint?: string; revocation_endpoint_auth_methods_supported?: string[]; revocation_endpoint_auth_signing_alg_values_supported?: string[]; scopes_supported?: string[]; service_documentation?: string; signed_metadata?: string; subject_types_supported?: string[]; tls_client_certificate_bound_access_tokens?: boolean; token_endpoint?: string; token_endpoint_auth_methods_supported?: string[]; token_endpoint_auth_signing_alg_values_supported?: string[]; ui_locales_supported?: string[]; userinfo_encryption_alg_values_supported?: string[]; userinfo_encryption_enc_values_supported?: string[]; userinfo_endpoint?: string; userinfo_signing_alg_values_supported?: string[]; } | undefined | - | src/plugins/internal/oidc/protocols/AuthorizationRequest.ts:14 |
authServerMeta.acr_values_supported? | public | string[] | undefined | JSON array containing a list of the Authentication Context Class References that this authorization server supports. | src/plugins/internal/oidc/types.ts:354 |
authServerMeta.authorization_encryption_alg_values_supported? | public | string[] | undefined | JSON array containing a list of algorithms supported by the authorization server for introspection response encryption (alg value). | src/plugins/internal/oidc/types.ts:483 |
authServerMeta.authorization_encryption_enc_values_supported? | public | string[] | undefined | JSON array containing a list of algorithms supported by the authorization server for introspection response encryption (enc value). | src/plugins/internal/oidc/types.ts:488 |
authServerMeta.authorization_endpoint? | public | string | undefined | URL of the authorization server's authorization endpoint. | src/plugins/internal/oidc/types.ts:234 |
authServerMeta.authorization_response_iss_parameter_supported? | public | boolean | undefined | Boolean value indicating whether the authorization server provides the iss parameter in the authorization response. | src/plugins/internal/oidc/types.ts:473 |
authServerMeta.authorization_signing_alg_values_supported? | public | string[] | undefined | JSON array containing a list of algorithms supported by the authorization server for introspection response signing. | src/plugins/internal/oidc/types.ts:478 |
authServerMeta.backchannel_authentication_endpoint? | public | string | undefined | CIBA Backchannel Authentication Endpoint. | src/plugins/internal/oidc/types.ts:492 |
authServerMeta.backchannel_authentication_request_signing_alg_values_supported? | public | string[] | undefined | JSON array containing a list of the JWS signing algorithms supported for validation of signed CIBA authentication requests. | src/plugins/internal/oidc/types.ts:497 |
authServerMeta.backchannel_logout_session_supported? | public | boolean | undefined | Boolean value specifying whether the authorization server can pass a sid (session ID) Claim in the Logout Token to identify the RP session with the OP. | src/plugins/internal/oidc/types.ts:534 |
authServerMeta.backchannel_logout_supported? | public | boolean | undefined | Boolean value specifying whether the authorization server supports back-channel logout. | src/plugins/internal/oidc/types.ts:538 |
authServerMeta.backchannel_token_delivery_modes_supported? | public | string[] | undefined | Supported CIBA authentication result delivery modes. | src/plugins/internal/oidc/types.ts:501 |
authServerMeta.backchannel_user_code_parameter_supported? | public | boolean | undefined | Indicates whether the authorization server supports the use of the CIBA user_code parameter. | src/plugins/internal/oidc/types.ts:505 |
authServerMeta.check_session_iframe? | public | string | undefined | URL of an authorization server iframe that supports cross-origin communications for session state information with the RP Client, using the HTML5 postMessage API. | src/plugins/internal/oidc/types.ts:510 |
authServerMeta.claim_types_supported? | public | string[] | undefined | JSON array containing a list of the Claim Types that the authorization server supports. | src/plugins/internal/oidc/types.ts:410 |
authServerMeta.claims_locales_supported? | public | string[] | undefined | Languages and scripts supported for values in Claims being returned, represented as a JSON array of RFC 5646 language tag values. | src/plugins/internal/oidc/types.ts:420 |
authServerMeta.claims_parameter_supported? | public | boolean | undefined | Boolean value specifying whether the authorization server supports use of the claims parameter. | src/plugins/internal/oidc/types.ts:425 |
authServerMeta.claims_supported? | public | string[] | undefined | JSON array containing a list of the Claim Names of the Claims that the authorization server MAY be able to supply values for. | src/plugins/internal/oidc/types.ts:415 |
authServerMeta.code_challenge_methods_supported? | public | string[] | undefined | PKCE code challenge methods supported by this authorization server. | src/plugins/internal/oidc/types.ts:328 |
authServerMeta.device_authorization_endpoint? | public | string | undefined | URL of the authorization server's device authorization endpoint. | src/plugins/internal/oidc/types.ts:336 |
authServerMeta.display_values_supported? | public | string[] | undefined | JSON array containing a list of the display parameter values that the authorization server supports. | src/plugins/internal/oidc/types.ts:406 |
authServerMeta.dpop_signing_alg_values_supported? | public | string[] | undefined | JSON array containing a list of the JWS algorithms supported for DPoP proof JWTs. | src/plugins/internal/oidc/types.ts:514 |
authServerMeta.end_session_endpoint? | public | string | undefined | URL at the authorization server to which an RP can perform a redirect to request that the End-User be logged out at the authorization server. | src/plugins/internal/oidc/types.ts:519 |
authServerMeta.frontchannel_logout_session_supported? | public | boolean | undefined | Boolean value specifying whether the authorization server can pass iss (issuer) and sid (session ID) query parameters to identify the RP session with the authorization server when the frontchannel_logout_uri is used. | src/plugins/internal/oidc/types.ts:525 |
authServerMeta.frontchannel_logout_supported? | public | boolean | undefined | Boolean value specifying whether the authorization server supports HTTP-based logout. | src/plugins/internal/oidc/types.ts:529 |
authServerMeta.grant_types_supported? | public | string[] | undefined | JSON array containing a list of the grant_type values that this authorization server supports. | src/plugins/internal/oidc/types.ts:265 |
authServerMeta.id_token_encryption_alg_values_supported? | public | string[] | undefined | JSON array containing a list of the JWE alg values supported by the authorization server for the ID Token. | src/plugins/internal/oidc/types.ts:369 |
authServerMeta.id_token_encryption_enc_values_supported? | public | string[] | undefined | JSON array containing a list of the JWE enc values supported by the authorization server for the ID Token. | src/plugins/internal/oidc/types.ts:374 |
authServerMeta.id_token_signing_alg_values_supported? | public | string[] | undefined | JSON array containing a list of the JWS alg values supported by the authorization server for the ID Token. | src/plugins/internal/oidc/types.ts:364 |
authServerMeta.introspection_encryption_alg_values_supported? | public | string[] | undefined | JSON array containing a list of algorithms supported by the authorization server for introspection response content key encryption (alg value). | src/plugins/internal/oidc/types.ts:463 |
authServerMeta.introspection_encryption_enc_values_supported? | public | string[] | undefined | JSON array containing a list of algorithms supported by the authorization server for introspection response content encryption (enc value). | src/plugins/internal/oidc/types.ts:468 |
authServerMeta.introspection_endpoint? | public | string | undefined | URL of the authorization server's introspection endpoint. | src/plugins/internal/oidc/types.ts:313 |
authServerMeta.introspection_endpoint_auth_methods_supported? | public | string[] | undefined | JSON array containing a list of client authentication methods supported by this introspection endpoint. | src/plugins/internal/oidc/types.ts:318 |
authServerMeta.introspection_endpoint_auth_signing_alg_values_supported? | public | string[] | undefined | JSON array containing a list of the JWS signing algorithms supported by the introspection endpoint for the signature on the JWT used to authenticate the client at the introspection endpoint. | src/plugins/internal/oidc/types.ts:324 |
authServerMeta.introspection_signing_alg_values_supported? | public | string[] | undefined | JSON array containing a list of algorithms supported by the authorization server for introspection response signing. | src/plugins/internal/oidc/types.ts:458 |
authServerMeta.issuer | public | string | undefined | Authorization server's Issuer Identifier URL. | src/plugins/internal/oidc/types.ts:230 |
authServerMeta.jwks_uri? | public | string | undefined | URL of the authorization server's JWK Set document. | src/plugins/internal/oidc/types.ts:242 |
authServerMeta.mtls_endpoint_aliases? | public | { } | undefined | JSON object containing alternative authorization server endpoints, which a client intending to do mutual TLS will use in preference to the conventional endpoints. | src/plugins/internal/oidc/types.ts:345 |
authServerMeta.op_policy_uri? | public | string | undefined | 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. | src/plugins/internal/oidc/types.ts:290 |
authServerMeta.op_tos_uri? | public | string | undefined | URL that the authorization server provides to the person registering the client to read about the authorization server's terms of service. | src/plugins/internal/oidc/types.ts:295 |
authServerMeta.pushed_authorization_request_endpoint? | public | string | undefined | URL of the authorization server's pushed authorization request endpoint. | src/plugins/internal/oidc/types.ts:449 |
authServerMeta.registration_endpoint? | public | string | undefined | URL of the authorization server's Dynamic Client Registration Endpoint. | src/plugins/internal/oidc/types.ts:246 |
authServerMeta.request_object_encryption_alg_values_supported? | public | string[] | undefined | JSON array containing a list of the JWE alg values supported by the authorization server for Request Objects. | src/plugins/internal/oidc/types.ts:396 |
authServerMeta.request_object_encryption_enc_values_supported? | public | string[] | undefined | JSON array containing a list of the JWE enc values supported by the authorization server for Request Objects. | src/plugins/internal/oidc/types.ts:401 |
authServerMeta.request_object_signing_alg_values_supported? | public | string[] | undefined | JSON array containing a list of the JWS alg values supported by the authorization server for Request Objects. | src/plugins/internal/oidc/types.ts:391 |
authServerMeta.request_parameter_supported? | public | boolean | undefined | Boolean value specifying whether the authorization server supports use of the request parameter. | src/plugins/internal/oidc/types.ts:430 |
authServerMeta.request_uri_parameter_supported? | public | boolean | undefined | Boolean value specifying whether the authorization server supports use of the request_uri parameter. | src/plugins/internal/oidc/types.ts:435 |
authServerMeta.require_pushed_authorization_requests? | public | boolean | undefined | Indicates whether the authorization server accepts authorization requests only via PAR. | src/plugins/internal/oidc/types.ts:453 |
authServerMeta.require_request_uri_registration? | public | boolean | undefined | Boolean value specifying whether the authorization server requires any request_uri values used to be pre-registered. | src/plugins/internal/oidc/types.ts:440 |
authServerMeta.require_signed_request_object? | public | boolean | undefined | Indicates where authorization request needs to be protected as Request Object and provided through either request or request_uri parameter. | src/plugins/internal/oidc/types.ts:445 |
authServerMeta.response_modes_supported? | public | string[] | undefined | JSON array containing a list of the response_mode values that this authorization server supports. | src/plugins/internal/oidc/types.ts:260 |
authServerMeta.response_types_supported? | public | string[] | undefined | JSON array containing a list of the response_type values that this authorization server supports. | src/plugins/internal/oidc/types.ts:255 |
authServerMeta.revocation_endpoint? | public | string | undefined | URL of the authorization server's revocation endpoint. | src/plugins/internal/oidc/types.ts:299 |
authServerMeta.revocation_endpoint_auth_methods_supported? | public | string[] | undefined | JSON array containing a list of client authentication methods supported by this revocation endpoint. | src/plugins/internal/oidc/types.ts:304 |
authServerMeta.revocation_endpoint_auth_signing_alg_values_supported? | public | string[] | undefined | JSON array containing a list of the JWS signing algorithms supported by the revocation endpoint for the signature on the JWT used to authenticate the client at the revocation endpoint. | src/plugins/internal/oidc/types.ts:309 |
authServerMeta.scopes_supported? | public | string[] | undefined | JSON array containing a list of the scope values that this authorization server supports. | src/plugins/internal/oidc/types.ts:250 |
authServerMeta.service_documentation? | public | string | undefined | URL of a page containing human-readable information that developers might want or need to know when using the authorization server. | src/plugins/internal/oidc/types.ts:279 |
authServerMeta.signed_metadata? | public | string | undefined | Signed JWT containing metadata values about the authorization server as claims. | src/plugins/internal/oidc/types.ts:332 |
authServerMeta.subject_types_supported? | public | string[] | undefined | JSON array containing a list of the Subject Identifier types that this authorization server supports. | src/plugins/internal/oidc/types.ts:359 |
authServerMeta.tls_client_certificate_bound_access_tokens? | public | boolean | undefined | Indicates authorization server support for mutual-TLS client certificate-bound access tokens. | src/plugins/internal/oidc/types.ts:340 |
authServerMeta.token_endpoint? | public | string | undefined | URL of the authorization server's token endpoint. | src/plugins/internal/oidc/types.ts:238 |
authServerMeta.token_endpoint_auth_methods_supported? | public | string[] | undefined | JSON array containing a list of client authentication methods supported by this token endpoint. | src/plugins/internal/oidc/types.ts:269 |
authServerMeta.token_endpoint_auth_signing_alg_values_supported? | public | string[] | undefined | 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. | src/plugins/internal/oidc/types.ts:274 |
authServerMeta.ui_locales_supported? | public | string[] | undefined | Languages and scripts supported for the user interface, represented as a JSON array of language tag values from RFC 5646. | src/plugins/internal/oidc/types.ts:284 |
authServerMeta.userinfo_encryption_alg_values_supported? | public | string[] | undefined | JSON array containing a list of the JWE alg values supported by the UserInfo Endpoint. | src/plugins/internal/oidc/types.ts:382 |
authServerMeta.userinfo_encryption_enc_values_supported? | public | string[] | undefined | JSON array containing a list of the JWE enc values supported by the UserInfo Endpoint. | src/plugins/internal/oidc/types.ts:386 |
authServerMeta.userinfo_endpoint? | public | string | undefined | URL of the authorization server's UserInfo Endpoint. | src/plugins/internal/oidc/types.ts:349 |
authServerMeta.userinfo_signing_alg_values_supported? | public | string[] | undefined | JSON array containing a list of the JWS alg values supported by the UserInfo Endpoint. | src/plugins/internal/oidc/types.ts:378 |
issuerMeta | readonly | { authorization_servers?: string[]; batch_credential_endpoint?: string; credential_configurations_supported: {[key: string]: { credential_definition: { credentialSubject?: { }; type: string[]; }; credential_signing_alg_values_supported?: string[]; cryptographic_binding_methods_supported?: string[]; format: string; proof_types_supported?: {[key: string]: { proof_signing_alg_values_supported: string[]; }; }; scope?: string; }; }; credential_endpoint: string; credential_identifiers_supported?: boolean; credential_issuer: string; credential_response_encryption?: { alg_values_supported: string[]; enc_values_supported: string[]; encryption_required: boolean; }; deferred_credential_endpoint?: string; display?: { }; notification_endpoint?: string; signed_metadata?: string; } | undefined | - | src/plugins/internal/oidc/protocols/AuthorizationRequest.ts:15 |
issuerMeta.authorization_servers? | public | string[] | undefined | - | src/plugins/internal/oidc/types.ts:86 |
issuerMeta.batch_credential_endpoint? | public | string | undefined | - | src/plugins/internal/oidc/types.ts:95 |
issuerMeta.credential_configurations_supported | public | {[key: string]: { credential_definition: { credentialSubject?: { }; type: string[]; }; credential_signing_alg_values_supported?: string[]; cryptographic_binding_methods_supported?: string[]; format: string; proof_types_supported?: {[key: string]: { proof_signing_alg_values_supported: string[]; }; }; scope?: string; }; } | undefined | - | src/plugins/internal/oidc/types.ts:111 |
issuerMeta.credential_endpoint | public | string | undefined | - | src/plugins/internal/oidc/types.ts:90 |
issuerMeta.credential_identifiers_supported? | public | boolean | undefined | - | src/plugins/internal/oidc/types.ts:175 |
issuerMeta.credential_issuer | public | string | undefined | - | src/plugins/internal/oidc/types.ts:80 |
issuerMeta.credential_response_encryption? | public | { alg_values_supported: string[]; enc_values_supported: string[]; encryption_required: boolean; } | undefined | - | src/plugins/internal/oidc/types.ts:155 |
issuerMeta.credential_response_encryption.alg_values_supported | public | string[] | undefined | - | src/plugins/internal/oidc/types.ts:159 |
issuerMeta.credential_response_encryption.enc_values_supported | public | string[] | undefined | - | src/plugins/internal/oidc/types.ts:163 |
issuerMeta.credential_response_encryption.encryption_required | public | boolean | undefined | - | src/plugins/internal/oidc/types.ts:169 |
issuerMeta.deferred_credential_endpoint? | public | string | undefined | - | src/plugins/internal/oidc/types.ts:100 |
issuerMeta.display? | public | { } | undefined | - | src/plugins/internal/oidc/types.ts:178 |
issuerMeta.notification_endpoint? | public | string | undefined | - | src/plugins/internal/oidc/types.ts:105 |
issuerMeta.signed_metadata? | public | string | undefined | - | src/plugins/internal/oidc/types.ts:108 |
meta | readonly | AuthorizationRequestMetadata | {} | - | src/plugins/internal/oidc/protocols/AuthorizationRequest.ts:11 |
url | public | URL | undefined | - | src/plugins/internal/oidc/protocols/AuthorizationRequest.ts:10 |
Accessors
params
Get Signature
get params():
URLSearchParams
Defined in: src/plugins/internal/oidc/protocols/AuthorizationRequest.ts:21
Returns
URLSearchParams
Methods
setCodeChallenge()
setCodeChallenge(
method:"S256",challenge:string,verifier:string):void
Defined in: src/plugins/internal/oidc/protocols/AuthorizationRequest.ts:25
Parameters
| Parameter | Type |
|---|---|
method | "S256" |
challenge | string |
verifier | string |
Returns
void
setNonce()
setNonce(
nonce:string):void
Defined in: src/plugins/internal/oidc/protocols/AuthorizationRequest.ts:31
Parameters
| Parameter | Type |
|---|---|
nonce | string |
Returns
void