Interface: Client

💗 Help the project

Recognized Client Metadata that have an effect on the exposed functionality.

see IANA OAuth Client Registration Metadata registry

Table of contents

Properties

• client_id
• authorization_signed_response_alg
• client_secret
• default_max_age
• id_token_signed_response_alg
• introspection_signed_response_alg
• require_auth_time
• token_endpoint_auth_method
• userinfo_signed_response_alg

Properties

client_id

• client_id: string

Client identifier.

---

authorization_signed_response_alg

• Optional authorization_signed_response_alg: JWSAlgorithm

JWS alg algorithm required for signing authorization responses. When not configured the default is to allow only supported algorithms listed in as.authorization_signing_alg_values_supported and fall back to RS256 when the authorization server metadata is not set.

---

client_secret

• Optional client_secret: string

Client secret.

---

default_max_age

• Optional default_max_age: number

Default Maximum Authentication Age.

---

id_token_signed_response_alg

• Optional id_token_signed_response_alg: JWSAlgorithm

JWS alg algorithm required for signing the ID Token issued to this Client. When not configured the default is to allow only supported algorithms listed in as.id_token_signing_alg_values_supported and fall back to RS256 when the authorization server metadata is not set.

---

introspection_signed_response_alg

• Optional introspection_signed_response_alg: JWSAlgorithm

JWS alg algorithm REQUIRED for signed introspection responses. When not configured the default is to allow only supported algorithms listed in as.introspection_signing_alg_values_supported and fall back to RS256 when the authorization server metadata is not set.

---

require_auth_time

• Optional require_auth_time: boolean

Boolean value specifying whether the auth_time Claim in the ID Token is REQUIRED. Default is false.

---

token_endpoint_auth_method

• Optional token_endpoint_auth_method: ClientAuthenticationMethod

Client authentication method for the client's authenticated requests. Default is client_secret_basic.

---

userinfo_signed_response_alg

• Optional userinfo_signed_response_alg: JWSAlgorithm

JWS alg algorithm REQUIRED for signing UserInfo Responses. When not configured the default is to allow only supported algorithms listed in as.userinfo_signing_alg_values_supported and fall back to RS256 when the authorization server metadata is not set.