OAuth 2.0 client application settings
This page lists all the settings you can configure for an OAuth 2.0 or OpenID Connect (OIDC) client in Advanced Identity Cloud.
The available settings depend on where you manage the client:
-
The Advanced Identity Cloud admin console exposes the settings for:
-
Custom OIDC applications (go to Applications > Applications)
-
Standalone OAuth 2.0 clients (go to Applications > OAuth2 Clients)
-
-
The AM native admin console exposes the complete OAuth 2.0 client profile, including settings that aren’t available in the Advanced Identity Cloud admin console.
Go to Native Consoles > Access Management > Realms > Realm Name > Applications > OAuth 2.0 > Clients > Client ID.
-
The OAuth 2.0 client admin endpoint supports client profile management through REST.
-
Dynamic client registration supports the standard OAuth 2.0 and OIDC registration metadata.
Core
- Client type
-
The client type.
Confidential clients maintain the confidentiality of their credentials; for example, a web application running on a server where its credentials are protected. Public clients run the risk of exposing their passwords to a host or user agent; for example, a JavaScript client running in a browser.
- Allow wildcard ports in redirection URIs
-
Whether Advanced Identity Cloud allows the use of wildcards (* characters) in the redirection URI port to match one or more ports.
The URL configured in the redirection URI must be either
localhost,127.0.0.1, or::1. For example,http://localhost:*/,https://127.0.0.1:80*/, orhttps://[::1]:*443/.For example, enable this setting for desktop apps that start a web server on a random free port during the OAuth 2.0 flow.
- Redirection URIs
-
The client redirection endpoint URIs as described in RFC 6749 (Redirection Endpoint). Advanced Identity Cloud’s OAuth 2.0 authorization service redirects the resource owner’s user agent to this endpoint during the authorization code grant process. If your client has more than one redirection URI, you must specify the redirection URI to use in the authorization request.
Redirection URI values must not contain a fragment (
#) and must be an exact match. Wildcards are considered special characters for ports if you enable Allow wildcard ports in redirection URIs.OIDC clients require redirection URIs.
- Scope(s)
-
The scopes to present to the resource owner when the resource owner must authorize client access to protected resources.
The
openidscope is required for OIDC clients. This scope indicates that the client is making an OIDC request to the authorization server.Enter scopes as simple strings; for example,
openid,read,email,profile, or as a pipe-separated string in the format:scope|locale|localized description. For example,read|en|Permission to view email messages.Locale strings have the format:
language_country_variant. For example,en,en_GB, oren_US_WIN. If you omit thelocaleand pipe, Advanced Identity Cloud displays the localized description to users with undefined locales. If you omit the localized description, nothing is displayed to all users. For example, a scope ofread|lets the client use thereadscope but doesn’t display it to the user when requested.Advanced Identity Cloud reserves special scopes to let resource servers introspect tokens issued to other clients. Learn more in Special Scopes.
Learn more about scopes, default scopes, and how Advanced Identity Cloud uses them in Scopes.
- Authorization Detail Type(s)
-
The fine-grained authorization detail types this client can request, as defined in RFC 9396: OAuth 2.0 Rich Authorization Requests.
This property requires Enable Rich Authorization Requests with RCS to be set on the OAuth 2 provider.
The value must be a set of unique strings, for example,
["account_information", "payment_information"].When an authorize request includes
authorization_detailsand every requested type is configured on this client, Advanced Identity Cloud forwards theauthorization_detailsto the remote consent service. If any requested type isn’t configured on this client, Advanced Identity Cloud returns aninvalid_authorization_detailserror.Learn more in Remote consent.
Default: empty. If empty, this client doesn’t support any authorization detail types.
- Default Scope(s)
-
Scopes Advanced Identity Cloud uses when the client doesn’t request any scopes during a grant flow, in
scopeorscope|locale|localized descriptionformat.Scopes set in this property take the same format as those set in Scope(s).
Learn more about scopes, default scopes, and how Advanced Identity Cloud uses them in Scopes.
- Client Name
-
A human-readable name for the client.
- Authorization Code Lifetime (seconds)
-
The time, in seconds, that an authorization code is valid. If you set this property to zero, Advanced Identity Cloud uses the authorization code lifetime of the OAuth2 provider.
Default:
0 - Refresh Token Lifetime (seconds)
-
The time, in seconds, that a refresh token is valid. If you set this property to zero, Advanced Identity Cloud uses the refresh token lifetime of the OAuth2 provider. If you set this property to
-1, the token never expires.Default:
0 - Access Token Lifetime (seconds)
-
The time, in seconds, that an access token is valid. If you set this property to zero, Advanced Identity Cloud uses the access token lifetime of the OAuth2 provider.
Default:
0
Advanced settings
- Token Exchange Auth Level
-
The authentication level Advanced Identity Cloud sets for tokens created through Token exchange if the subject token doesn’t have an initial authentication level, for example, when exchanging an ID token for an access token.
Default: 0
- Display name
-
The client name to display to the resource owner when the resource owner is asked to authorize client access to protected resources. Valid formats include
nameorlocale|localized name.Enter the Display name as a single string or as a pipe-separated string for locale and localized name, for example,
en|My Example Company.Locale strings have the format:
language_country_variant. For example,en,en_GB, oren_US_WIN. If thelocaleis omitted, the name is displayed to all users with undefined locales. - Display description
-
The client description to display to the resource owner when the resource owner is asked to authorize client access to protected resources. Valid formats include
descriptionorlocale|localized description.Enter the Display description as a single string or as a pipe-separated string for locale and localized description, for example,
en|The company intranet is requesting the following access permission.Locale strings have the format:
language_country_variant. For example,en,en_GB, oren_US_WIN. If thelocaleis omitted, the description is displayed to all users with undefined locales.
- JavaScript Origins
-
The origin URLs allowed by the client to make cross-origin resource sharing (CORS) requests to Advanced Identity Cloud.
For example, you might add the URL of a resource server being protected by an app that uses the Ping SDKs, so that it can access the OAuth 2.0 endpoints from a different domain than Advanced Identity Cloud.
This property doesn’t support using a non-standard header. To use a custom header, you must create a new CORS configuration.
Wildcards aren’t supported; each value must be an exact match for the origin of the CORS request.
The global CORS service collects the value of this property from each OAuth 2.0 client, and combines it with its own configuration.
Ensure that customers allowlist all headers for CORS and OAuth 2.0 client integration with Advanced Identity Cloud. Find more information in Allow cross-domain requests with CORS.
- Request uris
-
The
request_urivalues that a dynamic client would pre-register.URIs must be pre-registered in this field before the client can request them in the
request_uriparameter. - Grant Types
-
The set of OAuth 2.0 grant flows allowed for this client. The following flows are available:
-
Authorization Code -
Back Channel Request -
Client Credentials -
Device Code -
Implicit -
JWT Bearer -
Refresh Token -
Resource Owner Password Credentials -
SAML2 -
Token Exchange
Default:
Client Credentials,Token Exchange. When registering clients dynamically, if no grant types are specified in the registration request, the defaultAuthorization Codegrant type is assumed, and configured in the client. Any grant types selected in a client must also be enabled in the OAuth2 provider. -
- Response Types
-
The response types the client uses. The response type value specifies the flow that determines how the ID token and access token are returned to the client. Learn more in OAuth 2.0 Multiple Response Type Encoding Practices.
Configure this field only if the client uses OAuth 2.0 / OIDC grant flows that interact with the
/oauth2/authorizeendpoint.The following response types are available:
-
code. Specifies that the client requests an authorization code during the Authorization code grant flow for OAuth 2.0 and OpenID Connect.This response type also applies to the Authorization Code grant with Proof Key for Code Exchange (PKCE) flows.
-
token. Specifies that the client requests an access token during the Implicit grant flow. -
id_token. Specifies that the client requests an ID token during the OIDC Implicit grant flow. -
code token. Specifies that the client requests an access token and an authorization code during the OIDC Hybrid grant flow. -
code id_token. Specifies that the client requests an authorization code and an ID token during the OIDC Hybrid grant flow. -
code token id_token. Specifies that the client application requests an authorization code, an access token, and an ID token, during the OIDC Hybrid grant flow. -
token id_token. Specifies that the client requests an access token and an ID token during the OIDC Implicit grant flow.
-
- Contacts
-
The email addresses of users who administer the client.
- Token Endpoint Authentication Method
-
The authentication method with which a client authenticates to Advanced Identity Cloud (as an authorization server) at the token endpoint. The authentication method applies to OIDC requests with scope
openid.-
client_secret_basic. Clients authenticate with Advanced Identity Cloud (as an authorization server) using the HTTP Basic authentication scheme after receiving aclient_secretvalue. -
client_secret_post. Clients authenticate with Advanced Identity Cloud (as an authorization server) by including the client credentials in the request body after receiving aclient_secretvalue. -
private_key_jwt. Clients sign a JSON web token (JWT) with a registered public key. -
tls_client_auth. Clients use a CA-signed certificate for mutual TLS authentication. -
self_signed_tls_client_auth. Clients use a self-signed certificate for mutual TLS authentication. -
none. Clients are public and don’t authenticate.
Learn more in Client application authentication, and Client Authentication in the OpenID Connect Core 1.0 incorporating errata set 1 specification.
-
- TLS Client Auth Certificate Authority Secret Label Identifier
-
An identifier that Advanced Identity Cloud uses to construct a secret label for this client’s PKI mTLS certificate validation.
When set, Advanced Identity Cloud constructs the secret label
am.applications.oauth2.client.identifier.tls.cert.authenticationand uses it to look up the CA certificates that validate this client’s mTLS certificate. If a matching secret mapping exists, Advanced Identity Cloud uses those CA certificates instead of the realm-levelam.services.oauth2.tls.client.cert.authenticationlabel. If no matching mapping exists, Advanced Identity Cloud uses the realm-level trusted CA, if one is configured.The identifier can contain only alphanumeric characters and periods (
.), and can’t start or end with a period. As a best practice, use a different secret label identifier per client.Default: empty (realm-level CA secret is used, if configured).
- Accepted JWT Issuers
-
For private key JWT authentication, specify issuers for Advanced Identity Cloud to accept in addition to the client ID.
For example, if
https://my.issuer.comis on this list, an OAuth 2.0 client,myClient, can authenticate with a JWT from that issuer.This setting doesn’t apply to OIDC clients. For OIDC authentication, the JWT issuer must match the client ID.
- Sector Identifier URI
-
The value of this field must be a URL (including the
httpsscheme) that references a JSON file containing an array ofredirect_urivalues. Advanced Identity Cloud uses the host component of this URL to compute pairwise subject identifiers.If you configure a single Post Logout Redirect URI, the Sector Identifier URI takes this value by default. If you configure several Post Logout Redirect URIs and specify a pairwise Subject Type, you must set a value for the Sector Identifier URI.
- Subject Type
-
The subject identifier type, which is a locally unique identifier that the client consumes. The subject type can be one of the following:
-
public. Provides the samesub(subject) value to all clients. -
pairwise. Provides a differentsub(subject) value to each client to prevent correlation between clients.
If you specify a pairwisesubject type, read Sector Identifier URI. -
- Access Token
-
The
registration_access_tokenvalue that you provide when registering the client, and then subsequently when reading or updating the client profile. - Client URI
-
The URI containing further information about this client. The URI is displayed as a link in user-facing pages, such as consent pages.
The URI can be made locale-specific by specifying a pipe-separated string in the format: URI|locale. For example,
https://www.example.es:8443/aplicacion/informacion.html|es. - Logo URI
-
The URI of a logo for the client. The logo is displayed in user-facing pages, such as consent pages.
The logo can be made locale-specific by specifying a pipe-separated string in the format: URI|locale. For example,
https://www.example.es:8443/aplicacion/imagen.png|es. - Privacy Policy URI
-
The URI containing the client’s privacy policy documentation. The URI is displayed as a link in user-facing pages, such as consent pages.
The URI can be made locale-specific by specifying a pipe-separated string in the format: URI|locale. For example,
https://www.example.es:8443/aplicacion/legal.html|es. - Terms of Service URI
-
The URI that contains the client’s terms of service. The URI is displayed as a link in user-facing pages, such as consent pages.
The URI can be made locale-specific by specifying a pipe-separated string in the format: URI|locale. For example,
https://www.example.es:8443/aplicacion/terminos.html|es.
- Tree Name
-
If configured, Advanced Identity Cloud redirects OAuth 2.0 / OIDC client requests to the specified journey when acting as an authorization server.
Learn more about configuring an OIDC application journey in application journeys.
- Refresh Token Grace Period (seconds)
-
The time, in seconds, that a refresh token can be reused for this client. This grace period lets the client recover seamlessly if the response from an original refresh token request isn’t received because of a network problem or other transient issue. During the grace period, the refresh token can be reused multiple times if the network problem persists. When the grace period ends, the refresh token is revoked.
The refresh token grace period applies only to tokens in a one-to-one storage scheme.
This property can take the following values:
-
0The client inherits the refresh token grace period set in the OAuth 2.0 provider configuration. This is the default setting. -
-1There is no refresh token grace period for this client. -
Any positive integer up to the maximum.
This value overrides the grace period set in the OAuth 2.0 provider configuration.
Having a long grace period poses a security risk. Keep the grace period as small as possible. By default, the grace period can’t exceed 120 seconds. -
- Implied Consent
-
Enable the implied consent feature. When enabled, the resource owner isn’t asked for consent during authorization flows. The OAuth2 Provider must also be configured to allow clients to skip consent.
- OAuth 2.0 Mix-Up Mitigation enabled
-
Enable OAuth 2.0 mix-up mitigation on the authorization server side.
Enable this setting only if this OAuth 2.0 client supports the OAuth 2.0 Mix-Up Mitigation draft, otherwise Advanced Identity Cloud will fail to validate access token requests received from this client.
- Custom Properties
-
Additional properties that allow users to augment the set of properties supported by the client.
- Software Statement
-
The digitally signed software statement used during dynamic client registration.
- Software Identity
-
A unique identifier assigned by the client developer or software publisher to identity the client software.
- Software Version
-
A version identifier string for the identifier set in the Software Identity.
- Require Pushed Authorization Requests
-
If enabled, the client must use the PAR endpoint to initiate authorization requests.
Even if this value is set to false, the authorization server can be configured to enforce PAR for all clients. - Allowed Resource Server Audience Values
-
List of audience (
aud) claim values that are allowed for resource servers. The value(s) must match those expected by the resource server for which the access tokens are requested.
OpenID Connect settings
- Claim(s)
-
One or more claim name translations that will override those specified for the journey session. Claims are values that are presented to the user to inform them what data is being made available to the client.
You can enter claims as simple strings, such as
name,email,profile, orsub, or as a pipe-separated string in the format:scope|locale|localized description. For example,name|en|Full name of user.Locale strings have the format: language_country_variant. For example,
en,en_GB, oren_US_WIN. If you omit thelocaleand pipe, Advanced Identity Cloud displays the localized description to users with undefined locales. If you omit the localized description, Advanced Identity Cloud displays nothing to all users. For example, a claim ofname|lets the client use thenameclaim but doesn’t display it to the user when requested.If you don’t specify a value here, the value is computed from the OAuth 2.0 provider.
- Post Logout Redirect URIs
-
One or more allowable URIs to which Advanced Identity Cloud can redirect the user-agent after the client logout process.
- Client Session URI
-
The relying party (client) URI to which the OpenID Provider (OP) sends session changed notification messages using the HTML 5
postMessageAPI. - Default Max Age
-
The maximum time in seconds that a client can be authenticated. If the client last authenticated earlier than this value, it must reauthenticate. The request parameter
max_ageoverrides this setting, if specified.Minimum value:
0. A value of0forces the client to reauthenticate rather than use an existing session that might have been set in their browser by another client.Default:
600 - Default Max Age Enabled
-
Enable the default max age feature.
- Default ACR values
-
Default Authentication Context Class Reference values.
Strings to request as Voluntary Claims by default in all incoming requests.
Values specified in the
acr_valuesrequest parameter or an individualacrclaim request override these default values. - OpenID Connect JWT Token Lifetime (seconds)
-
The time in seconds for a JWT to be valid. If this field is set to zero, the JWT token lifetime of the OAuth2 provider is used.
Don’t set a token lifetime greater than 86400 seconds (one day). Default:
0 - Backchannel Logout URL
-
The URL to where Advanced Identity Cloud will send the logout token during backchannel logout.
This URL can use the http or the https scheme, and may contain a port, a path, or query parameters, depending on the implementation of the relying party. For example,
https://my-rp.example.com:443/logout.Learn more in Backchannel logout.
- Backchannel Logout Session Required
-
Whether to add the session ID (
sid) to the logout token. The session ID identifies the relying party’s session with the provider.Learn more in Backchannel logout.
Signing and encryption settings
|
Advanced Identity Cloud returns an error if you try to save a client profile with an unsupported signing or encryption algorithm. For example, when you save the configuration, Advanced Identity Cloud returns an error if there is a typo on an algorithm, or a symmetric signing or encryption algorithm is configured on a public client (these algorithms are derived from the client’s secret, which public clients don’t have). Dynamically registered clients must also send supported algorithms as part of their configuration, otherwise Advanced Identity Cloud rejects the registration request. Different features support different algorithms. Find more information in the Advanced Identity Cloud admin console. |
- Json Web Key URI
-
The URI that contains the client’s public keys in JSON web key format.
When the client authenticates to Advanced Identity Cloud using the
private_key_jwtmethod, Advanced Identity Cloud checks this field to find the public key to validate the JWT. - JWKs URI content cache timeout in ms
-
The period of time, in milliseconds, that the content of the JWKs' URI is cached before being refreshed. Caching the content avoids fetching it for every token encryption or validation.
Default:
3600000 - JWKs URI content cache miss cache time
-
The period of time, in milliseconds, that Advanced Identity Cloud waits before fetching the URI’s content again when a key ID (
kid) isn’t in the JWK set already cached.For example, if a request comes in with a
kidthat isn’t in the cached JWKs, Advanced Identity Cloud checks the value of JWKs' URI content cache miss cache time. If the amount of time specified in this property has already passed since the last time Advanced Identity Cloud fetched the JWKs, Advanced Identity Cloud fetches them again. Otherwise, the request is rejected.Use this property as a rate limit to prevent denial-of-service attacks against the URI.
Default:
60000 - Token Endpoint Authentication Signing Algorithm
-
The JWS algorithm that must be used for signing JWTs used to authenticate the client at the Token Endpoint.
Advanced Identity Cloud rejects JWTs that aren’t signed with the selected algorithm in token requests from the client using the
private_key_jwtauthentication method.Default:
RS256 - Json Web Key
-
Raw JSON web key value containing the client’s public keys.
- ID Token Signing Algorithm
-
The algorithm the ID token must be signed with.
- Enable ID Token Encryption
-
Enable ID token encryption using the specified ID token encryption algorithm.
- ID Token Encryption Algorithm
-
The algorithm the ID token must be encrypted with.
Default value:
RSA-OAEP-256. - ID Token Encryption Method
-
The method the ID token must be encrypted with.
Default value:
A128CBC-HS256.
- Authorization Response JWT Signing Algorithm
-
The algorithm used to sign an authorization response JWT.
If configured, it must match one of the values set in the
Authorization Response Signing Algorithms Supportedproperty of the OAuth2 provider.Default value:
RS256.
- Authorization Response JWT Encryption Algorithm
-
The algorithm used to encrypt an authorization response JWT.
To disable encryption of the authorization response JWT, ensure this property isn’t set.
To enable encryption, set the property to a valid value that matches one of the values set in the
Authorization Response Encryption Algorithms Supportedproperty of the OAuth2 provider.
- Authorization Response JWT Encryption Method
-
The encryption method to secure an authorization response JWT.
The value must match one of the values set in the
Authorization Response Encryption Methods Supportedproperty of the OAuth2 provider.Default value:
A128CBC-HS256, whenAuthorization Response JWT Encryption Algorithmis set. - ID Token Encryption Public Key
-
The RSA public key for encrypting ID tokens in X.509 PEM format. For example:
-----BEGIN PUBLIC KEY----- ...... -----END PUBLIC KEY-----For improved security and to support secret rotation, create an ESV secret that holds this key. Map the secret to the
am.applications.oauth2.client.identifier.id.token.enc.public.keydynamic secret label, where identifier is the value of the Secret Label Identifier set in this client’s configuration.If you specify a Secret Label Identifier and Advanced Identity Cloud finds a corresponding secret mapping, it ignores the value of this field. Find more information in Use ESVs for signing and encryption keys.
- Client JWT Bearer Public Key
-
The Base64-encoded X509 certificate in PEM format, containing the public key pair for signing the Client Bearer JWT. This certificate isn’t used during the signing process. It’s used to obtain the client’s JWT bearer public key. The client uses the private key to sign client authentication and access token request JWTs, while Advanced Identity Cloud uses the public key for verification.
For improved security and to support secret rotation, create an ESV secret that holds this certificate. Map the secret to the
am.applications.oauth2.client.identifier.jwt.public.keydynamic secret label, where identifier is the value of the Secret Label Identifier set in this client’s configuration.If you specify a Secret Label Identifier and Advanced Identity Cloud finds a corresponding secret mapping, it ignores the value of this field. Find more information in Use ESVs for signing and encryption keys.
- mTLS Self-Signed Certificate
-
A base64-encoded X.509 certificate in PEM format that clients can use to authenticate to the
access_tokenendpoint during mutual TLS authentication.Only applies when clients use self-signed certificates to authenticate.
For improved security and to support secret rotation, create an ESV secret that holds this certificate. Map this secret to the
am.applications.oauth2.client.identifier.mtls.trusted.certsecret label, whereidentifieris the value of the Secret Label Identifier configured for the client on the Core tab.If you specify a Secret Label Identifier and Advanced Identity Cloud finds a corresponding secret mapping, it ignores the value of this field. Find more information in Use ESVs for signing and encryption keys.
- mTLS Subject DN
-
The Subject DN of the client certificate used for mutual TLS authentication. For example,
CN=myOauth2Client.Only applies when clients use CA-signed certificates to authenticate.
- Use Certificate-Bound Access Tokens
-
Whether access tokens issued to this client should be bound to the X.509 certificate the client uses to authenticate to the
access_tokenendpoint.If enabled, Advanced Identity Cloud adds a confirmation key labelled
x5t#S256to all access tokens. The confirmation key contains the SHA-256 hash of the client’s certificate.
- Public key selector
-
The format of the public keys for JWT profile client authentication, ID token encryption, and mTLS self-signed certificate authentication. Valid formats are:
-
JWKs_URIConfigure a URI that exposes the client public keys in the Json Web Key URI field. Make sure the following related properties have sensible values for your environment:
-
JWKs URI content cache timeout in ms
-
JWKs URI content cache miss cache time
-
-
JWKsEnter a JWK Set containing one or more keys in the Json Web Key field. For example:
{ "keys": [ { "kty": "RSA", "n": "..." } ] } -
X509Enter a key object or a single certificate in one of the following fields, depending on the feature you’re configuring:
-
ID Token Encryption Public Key (for ID token encryption)
Requires an RSA public key object in X.509 PEM format. For example:
-----BEGIN PUBLIC KEY----- ...... -----END PUBLIC KEY-----For improved security and to support secret rotation, create an ESV secret that holds this certificate. Map the certificate to the
am.applications.oauth2.client.identifier.id.token.enc.public.keydynamic secret label, where identifier is the value of the Secret Label Identifier set in this client’s configuration. -
Client JWT Bearer Public Key (for JWT client authentication)
Requires an X.509 certificate in PEM format. For example:
-----BEGIN CERTIFICATE----- ..... -----END CERTIFICATE-----For improved security and to support secret rotation, create an ESV secret that holds this certificate. Map the certificate to the
am.applications.oauth2.client.identifier.jwt.public.keydynamic secret label, where identifier is the value of the Secret Label Identifier set in this client’s configuration. -
mTLS Self-Signed Certificate (for mTLS client authentication)
Requires an X.509 certificate in PEM format. For example:
-----BEGIN CERTIFICATE----- ..... -----END CERTIFICATE-----For improved security and to support secret rotation, create an ESV secret that holds this certificate. Map the certificate to the
am.applications.oauth2.client.identifier.mtls.trusted.certdynamic secret label, where identifier is the value of the Secret Label Identifier set in this client’s configuration.
-
Default:
JWKs_URI -
- User info response format.
-
The output format from the /oauth2/userinfo endpoint.
Default: User info JSON response format.
The supported output formats are as follows:
-
User info JSON response format.
-
User info encrypted JWT response format.
-
User info signed JWT response format.
-
User info signed then encrypted response format.
Find more information on the output format of the UserInfo Response in Successful UserInfo Response in the OpenID Connect Core 1.0 specification.
-
- User info signed response algorithm
-
The JSON Web Signature (JWS) algorithm for signing UserInfo Responses. If specified, the response is JSON Web Token (JWT) serialized, and signed using JWS.
If you don’t set this property, the default is to return the claims as a UTF-8-encoded JSON object using the
application/jsoncontent type. - User info encrypted response algorithm
-
The JSON Web Encryption (JWE) algorithm for encrypting UserInfo Responses.
If both signing and encryption are requested, the response is signed then encrypted, and the result is a nested JWT.
If you don’t set this property, the default is no encryption.
- User info encrypted response encryption algorithm
-
The JWE encryption method for encrypting UserInfo Responses. If specified, you must also specify an encryption algorithm in the User info encrypted response algorithm property.
Advanced Identity Cloud supports the following encryption methods:
-
A128GCM,A192GCM, andA256GCM- AES in Galois Counter Mode (GCM) authenticated encryption mode. -
A128CBC-HS256,A192CBC-HS384, andA256CBC-HS512- AES encryption in CBC mode, with HMAC-SHA-2 for integrity.
Default:
A128CBC-HS256 -
- Request parameter signing algorithm
-
The JWS algorithm for signing the request parameter.
Must match one of the values configured in the Request parameter Signing Algorithms supported property of the OAuth2 Provider.
Find more information in Advanced OpenID Connect.
- Request parameter encryption algorithm
-
The algorithm for encrypting the request parameter.
Must match one of the values configured in the Request parameter Encryption Algorithms supported property of the OAuth2 Provider.
Find more information in Advanced OpenID Connect.
- Request parameter encryption method
-
The method for encrypting the request parameter.
Must match one of the values configured in the Request parameter Encryption Methods supported property of the OAuth2 Provider.
Find more information in Advanced OpenID Connect.
Default:
A128CBC-HS256
- Token introspection response format
-
The format of the token introspection response. The possible values for this property are:
-
JSON response format
-
Signed JWT response format
-
Signed then encrypted JWT response format
Even if the client has configured the response to be JSON-formatted, it can request a signed JWT by adding one of the following headers to the introspection request:
-
Accept: application/jwt(default, for compatibility with older clients) -
Accept: application/token-introspection+jwt(for compatibility with RFC 9701)
However, when a client that’s configured to use either of the JWT-formatted responses requests a JSON response, Advanced Identity Cloud returns an error. Learn more in /oauth2/introspect.
The JWT response format follows RFC 9701: JWT Response for OAuth Token Introspection.
The following properties cover related signing and encryption algorithms:
Default:
JSON response format -
- Token introspection response signing algorithm
-
The algorithm used to sign the token introspection response when it’s formatted as a signed JWT.
Must match a value configured in the Token Introspection Response Signing Algorithms Supported property of the OAuth2 Provider.
Find more information in Advanced OpenID Connect.
Advanced Identity Cloud supports the following signing algorithms:
-
HS256- HMAC with SHA-256. -
HS384- HMAC with SHA-384. -
HS512- HMAC with SHA-512. -
ES256- ECDSA with SHA-256 and NIST standard P-256 elliptic curve. -
ES384- ECDSA with SHA-384 and NIST standard P-384 elliptic curve. -
ES512- ECDSA with SHA-512 and NIST standard P-521 elliptic curve. -
RS256- RSASSA-PKCS-v1_5 using SHA-256. -
RS384- RSASSA-PKCS-v1_5 using SHA-384. -
RS512- RSASSA-PKCS-v1_5 using SHA-512. -
EdDSA- EdDSA with SHA-512.
The signing key used depends on the algorithm chosen.
This table shows the secret label used to sign OIDC tokens and backchannel logout tokens:
Secret label Default alias Algorithms(1) am.services.oauth2.oidc.signing.ES256es256testES256
am.services.oauth2.oidc.signing.ES384es384testES384
am.services.oauth2.oidc.signing.ES512es512testES512
am.services.oauth2.oidc.signing.RSArsajwtsigningkeyPS256
PS384
PS512
RS256
RS384
RS512am.services.oauth2.oidc.signing.EDDSAEdDSA with SHA-512
(1) For confidential clients, if you select an HMAC algorithm for signing ID tokens (HS256, HS384, or HS512), the Client Secret property value in the OAuth 2.0 Client is used as the HMAC secret instead of an ESV secret.
Because Advanced Identity Cloud and the client share the HMAC secret, a malicious user compromising the client could potentially create tokens that Advanced Identity Cloud would trust. To protect against misuse, Advanced Identity Cloud also signs the token using a non-shared signing key configured in the
am.services.oauth2.jwt.authenticity.signingsecret label.Default:
RS256 -
- Token introspection response encryption algorithm
-
The algorithm used to encrypt the token introspection response when it’s formatted as a signed then encrypted JWT.
Must match a value configured in the Token Introspection Response Encryption Algorithms Supported property of the OAuth2 Provider.
Find more information in Advanced OpenID Connect.
Advanced Identity Cloud supports the following encryption algorithms:
-
A128KW- AES Key Wrapping with 128-bit key derived from the client secret. -
A192KW- AES Key Wrapping with 192-bit key derived from the client secret. -
A256KW- AES Key Wrapping with 256-bit key derived from the client secret. -
RSA-OAEP- RSA with Optimal Asymmetric Encryption Padding (OAEP) with SHA-1 and MGF-1. -
RSA-OAEP-256- RSA with OAEP with SHA-256 and MGF-1. -
RSA1_5- RSA with PKCS#1 v1.5 padding. -
dir- Direct encryption with AES using the hashed client secret. -
ECDH-ES- Elliptic Curve Diffie-Hellman -
ECDH-ES+A128KW- Elliptic Curve Diffie-Hellman + AES Key Wrapping with 128-bit key. -
ECDH-ES+A192KW- Elliptic Curve Diffie-Hellman + AES Key Wrapping with 192-bit key. -
ECDH-ES+A256KW- Elliptic Curve Diffie-Hellman + AES Key Wrapping with 256-bit key.
The algorithms that aren’t derived from the client secret use the client’s public keys. Learn more in Public key selector.
-
Default: RSA-OAEP-256
- Token introspection encrypted response encryption algorithm
-
The JSON Web Encryption JWE
encalgorithm required to encrypt token introspection responses. Advanced Identity Cloud uses this algorithm to encrypt the JWE plain text when the selected introspection response format issigned then encrypted.Find more information in Advanced OpenID Connect.
Advanced Identity Cloud supports the following encryption:
-
A128GCM,A192GCM, andA256GCM- AES in Galois Counter Mode (GCM) authenticated encryption mode. -
A128CBC-HS256,A192CBC-HS384, andA256CBC-HS512- AES encryption in CBC mode, with HMAC-SHA-2 for integrity.
Default:
A128CBC-HS256 -
OAuth2 Provider Overrides
- Enable OAuth2 Provider Overrides
-
Enable the OAuth2 provider configuration to be overridden by the settings in this section.
When enabled, these client-level attributes override the corresponding attributes set in the OAuth2 provider.
The overriding attributes only apply if you enable this setting.
- Issue Refresh Tokens
-
Whether to issue a refresh token when returning an access token.
- Issue Refresh Tokens on Refreshing Access Tokens
-
Whether to issue a refresh token when refreshing an access token.
- Use Policy Engine for Scope decisions
-
With this setting enabled, the policy engine is consulted for each scope value that’s requested.
Scope decisions based on the policy engine are determined in the following way:
-
If a policy returns an action of
GRANT=true, the scope is consented automatically. The client isn’t consulted in a client-interaction flow. -
If a policy returns an action of
GRANT=false, the scope isn’t added to any resulting token. Advanced Identity Cloud doesn’t display it to the client in a client-interaction flow. -
If no policy returns a value for the GRANT action:
-
For user-facing grant types, such as the authorization or device code flows, the user is asked for consent or saved consent is used.
-
For grant types that aren’t user-facing, such as those using password or client credentials, the scope isn’t added to any resulting token.
-
-
- Scopes Policy Set
-
The policy set that defines the context in which policy evaluations occur when
Use Policy Engine for Scope decisionsis enabled.Default value:
oauth2Scopes - Access Token Modification Plugin Type
-
The type of extension used to modify the access token:
-
SCRIPTEDruns the script defined inAccess Token Modification Script. -
JAVAruns the class defined inAccess Token Modifier Plugin Implementation Class. (Not supported in Advanced Identity Cloud.) -
PROVIDERuses the access token modification settings configured on the OAuth2 provider.
Default value:
PROVIDER -
- Access Token Modification Script
-
This script is run when issuing an access token. The script lets you modify the token, for example, by altering the data fields, before it is persisted or returned to the client.
The script is run if
Access Token Modification Plugin Typeis set toSCRIPTED.Learn more in Access tokens.
Default value:
--- Select a script --- - Access Token Modifier Plugin Implementation Class
-
Not supported in Advanced Identity Cloud.
- OAuth2 Access Token May Act Script
-
The script that’s executed when issuing an access token explicitly to modify the
may_actclaim placed on the token.Learn more in Token exchange.
Default value:
--- Select a script --- - OIDC ID Token May Act Script
-
The script that’s executed when issuing an OpenID Connect ID token explicitly to modify the
may_actclaim placed on the token.Default value:
--- Select a script --- - OIDC Claims Plugin Type
-
The extension type used to modify OIDC claims:
-
SCRIPTEDruns the script defined inOIDC Claims Script. -
JAVAruns the class defined inOIDC Claims Plugin Implementation Class. (Not supported in Advanced Identity Cloud.) -
PROVIDERuses the OIDC claims plugin settings configured on the OAuth2 provider.
Default value:
PROVIDER -
- OIDC Claims Script
-
This script is run when issuing an ID token or during a request to the
/userinfoOpenID Connect endpoint. Use this script to retrieve claim values based on an issued access token.The script is run if
OIDC Claims Plugin Typeis set toSCRIPTED.Find more information in OIDC claims.
Default value:
--- Select a script --- - OIDC Claims Plugin Implementation Class
-
Not supported in Advanced Identity Cloud.
- Use Force Authentication for max-age
-
-
When this setting is
false(default):-
If authorization is attempted after
max_agehas expired, Advanced Identity Cloud logs out the existing session and starts a re-authentication. -
Re-authentication triggered by the
max_ageparameter creates a new session.
-
-
When this setting is
true:-
If authorization is attempted after
max_agehas expired, Advanced Identity Cloud doesn’t destroy the existing session. -
Re-authentication triggered by the
max_ageparameter returns the same session.
-
For security reasons, you should leave this property set to the default value (
false), so that a new session is created when the user re-authenticates. -
- Custom Login URL Template
-
Supports Freemarker syntax, with the following variables:
Variable Description gotoUrlThe URL to redirect to after login.
acrValuesThe Authentication Context Class Reference (acr) values for the authorization request.
realmThe Advanced Identity Cloud realm the authorization request was made on.
serviceThe name of the authentication journey requested to perform resource owner authentication.
localeA space-separated list of locales, ordered by preference.
The following example template redirects users to a non-Advanced Identity Cloud front end to handle login. The front end then redirects back to the
/oauth2/authorizeendpoint with any required parameters:http://mylogin.com/login?goto=${goto}<#if acrValues??>&acr_values=${acrValues}</#if><#if realm??>&realm=${realm}</#if><#if service??>&service=${service}</#if><#if locale??>&locale=${locale}</#if>The default Advanced Identity Cloud login page is constructed using the Base URL Source service. - Use Client-Side Access & Refresh Tokens
-
When enabled, Advanced Identity Cloud issues client-side access and refresh tokens that can be inspected by resource servers.
- Encrypt Client-Side Tokens
-
Whether client-side access and refresh tokens should be encrypted.
Enabling token encryption disables token signing because encryption uses direct symmetric encryption.
- Allow Clients to Skip Consent
-
If enabled, clients can be configured so that the resource owner isn’t asked for consent during authorization flows.
- Enable Remote Consent
-
Enables consent to be gathered by a separate service.
- Remote Consent Service ID
-
The ID of an existing remote consent service agent.
- Scope Evaluation Plugin Type
-
This setting can have the following possible values:
-
SCRIPTEDto run the script defined inScope Evaluation Script. -
JAVAto run the class defined inScope Evaluation Plugin Implementation Class. (Not supported in Advanced Identity Cloud.) -
PROVIDERto use the scope evaluation plugin settings configured on the OAuth2 provider.
Default value:
PROVIDER -
- Scope Evaluation Script
-
This script retrieves and evaluates the scope information for an OAuth2 access token.
The script lets you populate the scopes with profile attribute values. For example, if one of the scopes is
mail, Advanced Identity Cloud setsmailto the resource owner’s email address in the token information returned.Default value:
--- Select a script --- - Scope Evaluation Plugin Implementation Class
-
Not supported in Advanced Identity Cloud.
- Scope Validation Plugin Type
-
This setting can have the following possible values:
-
SCRIPTEDto run the script defined inScope Validation Script. -
JAVAto run the class defined inScope Validation Plugin Implementation Class. (Not supported in Advanced Identity Cloud.) -
PROVIDERto use the scope validation plugin settings configured on the OAuth2 provider.
Default value:
PROVIDER -
- Scope Validation Script
-
This script validates and customizes the set of requested scopes for authorize, access token, refresh token, and backchannel authorize requests.
Default value:
--- Select a script --- - Scope Validation Plugin Implementation Class
-
Not supported in Advanced Identity Cloud.
- Authorize Endpoint Data Provider Plugin Type
-
This setting can have the following possible values:
-
SCRIPTEDto run the script defined inAuthorize Endpoint Data Provider Script. -
JAVAto run the class defined inAuthorize Endpoint Data Provider Plugin Implementation Class. (Not supported in Advanced Identity Cloud.) -
PROVIDERto use the Authorize Endpoint Data Provider plugin settings configured on the OAuth2 provider.
Default value:
PROVIDER -
- Authorize Endpoint Data Provider Script
-
Use this script to retrieve additional data from an authorization request, such as data from the user’s session or from an external service.
Default value:
--- Select a script --- - Authorize Endpoint Data Provider Plugin Implementation Class
-
Not supported in Advanced Identity Cloud.
- Overrideable Id_Token Claims
-
List of claims in the ID token that can be overridden in the OIDC claims script. These should be the subset of the core OpenID Connect claims; for example
audorazp.
- Enable Application Context
-
When enabled, this setting makes the application context available in all OAuth 2.0 / OIDC flows through the
oauthApplicationbinding in Scripted Decision node scripts. - Accept Audience Parameters in Token Exchange Requests
-
If this setting is
false(default), Advanced Identity Cloud ignores audience parameter values in token exchange requests.If this setting is
true, Advanced Identity Cloud validates audience parameter values in token exchange requests against the values defined in Allowed Resource Server Audience Values.If validation fails, the token exchange request is rejected.
Find more information in The
audclaim. - Use token_introspection claim for JWT
-
Whether Advanced Identity Cloud wraps the introspected token’s claims inside a
token_introspectionclaim in the JWT introspection response, as required by RFC 9701.When enabled, Advanced Identity Cloud separates the JWT’s own top-level claims (
iss,aud,iat) from the introspected token’s claims, which appear insidetoken_introspection. Theaudclaim of the introspected token is always included in the JWT response, including for client-side tokens. The JSON introspection response also includes theaudclaim of the introspected token, if present.When not enabled, Advanced Identity Cloud returns a flat JWT structure and omits the
audclaim from the response. JSON responses also omit theaudclaim.Learn more in RFC 9701 token_introspection claim.
Default value:
false - Validate Client Certificate Chain
-
When enabled, Advanced Identity Cloud validates the entire certificate chain (leaf certificate plus intermediates) instead of only the leaf certificate for this client, overriding the provider-level default.
This setting applies only when TLS Client Certificate Header Format is set to
BASE64_ENCODED_CERTon the OAuth 2 provider. - Restrict Token Exchange Scopes to Subject Token Scopes
-
When enabled, Advanced Identity Cloud rejects token exchange requests that request scopes beyond those granted on the subject token. This property applies only when the subject token is an access token. ID tokens don’t carry granted scopes.