Realm Services Configuration

You can configure services in AM in two places:

  • Under Configure > Global Services, you can find the CORS service and the Dashboard service. These services affect all the realms in AM.

  • Under Realms > Realm Name > Services, you can enable, remove, or configure different services for the realm.

Base URL Source

The following settings are available in this service:

Base URL Source

Specifies the source of the base URL. Choose from the following:

  • Extension class. Specifies that the extension class returns a base URL from a provided HttpServletRequest. In the Extension class name field, enter org.forgerock.openam.services.baseurl.BaseURLProvider.

  • Fixed value. Specifies that the base URL is retrieved from a specific base URL value. In the Fixed value base URL field, enter the base URL value.

  • Forwarded header. Specifies that the base URL is retrieved from a forwarded header field in the HTTP request. The Forwarded HTTP header field is standardized and specified in RFC7239.

  • Host/protocol from incoming request. Specifies that the hostname, server name, and port are retrieved from the incoming HTTP request.

  • X-Forwarded-* headers. Specifies that the base URL is retrieved from non-standard header fields, such as X-Forwarded-For, X-Forwarded-By, and X-Forwarded-Proto.

    The possible values for this property are:

  • Label: Fixed value (Value: FIXED_VALUE)

  • Label: Forwarded header (Value: FORWARDED_HEADER)

  • Label: X-Forwarded- headers* (Value: X_FORWARDED_HEADERS)

  • Label: Host/protocol from incoming request (Value: REQUEST_VALUES)

  • Label: Extension class (Value: EXTENSION_CLASS)

amster attribute: source

Fixed value base URL

If Fixed value is selected as the Base URL source, enter the base URL in the Fixed value base URL field.

amster attribute: fixedValue

Extension class name

If Extension class is selected as the Base URL source, enter org.forgerock.openam.services.baseurl.BaseURLProvider in the Extension class name field.

amster attribute: extensionClassName

Context path

Specifies the context path for the base URL.

If provided, the base URL includes the deployment context path appended to the calculated URL.

For example, /openam.

amster attribute: contextPath

CORS Service

Configuration

The following settings appear on the Configuration tab:

Enable the CORS filter

If disable, no CORS headers will be added to responses.

Default value: true

amster attribute: enabled

Secondary Configurations

This service has the following Secondary Configurations.

configuration

Enable the CORS filter

If disable, no CORS headers will be added to responses.

Default value: false

amster attribute: enabled

Accepted Origins

The set of accepted origins.

amster attribute: acceptedOrigins

Accepted Methods

The set of (non-simple) accepted methods, included in the pre-flight response in the header Access-Control-Allow-Methods.

amster attribute: acceptedMethods

Accepted Headers

The set of (non-simple) accepted headers, included in the pre-flight response in the header Access-Control-Allow-Headers.

amster attribute: acceptedHeaders

Exposed Headers

The set of headers to transmit in the header Access-Control-Expose-Headers.

amster attribute: exposedHeaders

Max Age

The max age (in seconds) for caching, included in the pre-flight response in the header Access-Control-Max-Age.

Default value: 0

amster attribute: maxAge

Allow Credentials

Whether to transmit the Access-Control-Allow-Credentials: true header in the response.

Default value: false

amster attribute: allowCredentials

Dashboard

Realm Defaults

The following settings appear on the Realm Defaults tab:

Available Dashboard Apps

List of application dashboard names available by default for realms with the Dashboard service configured.

amster attribute: assignedDashboard

Secondary Configurations

This service has the following Secondary Configurations.

instances

Dashboard Class Name

Identifies how to access the application, for example SAML2ApplicationClass for a SAML v2.0 application.

amster attribute: className

Dashboard Name

The application name as it will appear to the administrator for configuring the dashboard.

amster attribute: name

Dashboard Display Name

The application name that displays on the dashboard client.

amster attribute: displayName

Dashboard Icon

The icon name that will be displayed on the dashboard client identifying the application.

amster attribute: icon

Dashboard Login

The URL that takes the user to the application.

amster attribute: login

ICF Identifier

amster attribute: icfIdentifier

Device ID Service

The following settings are available in this service:

Profile Storage Attribute

The user’s attribute in which to store Device ID profiles.

The default attribute is added to the schema when you prepare a user store for use with AM. If you want to use a different attribute, you must make sure to add it to your user store schema prior to enabling the Device ID authentication module. AM must be able to write to the attribute.

amster attribute: deviceIdAttrName

Device Profile Encryption Scheme

Encryption scheme to use to secure device profiles stored on the server.

If enabled, each device profile is encrypted using a unique random secret key using the given strength of AES encryption in CBC mode with PKCS#5 padding. An HMAC-SHA of the given strength (truncated to half-size) is used to ensure integrity protection and authenticated encryption. The unique random key is encrypted with the given RSA key pair and stored with the device profile.

Note: AES-256 may require installation of the JCE Unlimited Strength policy files.

The possible values for this property are:

  • Label: AES-256/HMAC-SHA-512 with RSA Key Wrapping (Value: RSAES_AES256CBC_HS512)

  • Label: AES-128/HMAC-SHA-256 with RSA Key Wrapping (Value: RSAES_AES128CBC_HS256)

  • Label: No encryption of device settings. (Value: NONE)

amster attribute: deviceIdSettingsEncryptionScheme

Encryption Key Store

Path to the key store from which to load encryption keys.

amster attribute: deviceIdSettingsEncryptionKeystore

Key Store Type

Type of key store to load.

See the JDK 8 PKCS#11 Reference Guide for more details.

The possible values for this property are:

  • Label: Java Key Store (JKS). (Value: JKS)

  • Label: Java Cryptography Extension Key Store (JCEKS). (Value: JCEKS)

  • Label: PKCS#11 Hardware Crypto Storage. (Value: PKCS11)

  • Label: PKCS#12 Key Store. (Value: PKCS12)

amster attribute: deviceIdSettingsEncryptionKeystoreType

Key Store Password

Password to unlock the key store. This password is encrypted when it is saved in the AM configuration.

amster attribute: deviceIdSettingsEncryptionKeystorePassword

Key-Pair Alias

Alias of the certificate and private key in the key store. The private key is used to encrypt and decrypt device profiles.

amster attribute: deviceIdSettingsEncryptionKeystoreKeyPairAlias

Private Key Password

Password to unlock the private key.

amster attribute: deviceIdSettingsEncryptionKeystorePrivateKeyPassword

Device Profiles Service

The following settings are available in this service:

Profile Storage Attribute

The user’s attribute in which to store Device profiles.

amster attribute: deviceProfilesAttrName

Device Profile Encryption Scheme

Encryption scheme to use to secure device profiles stored on the server.

If enabled, each device profile is encrypted using a unique random secret key using the given strength of AES encryption in CBC mode with PKCS#5 padding. An HMAC-SHA of the given strength (truncated to half-size) is used to ensure integrity protection and authenticated encryption. The unique random key is encrypted with the given RSA key pair and stored with the device profile.

Note: AES-256 may require installation of the JCE Unlimited Strength policy files.

The possible values for this property are:

  • Label: AES-256/HMAC-SHA-512 with RSA Key Wrapping (Value: RSAES_AES256CBC_HS512)

  • Label: AES-128/HMAC-SHA-256 with RSA Key Wrapping (Value: RSAES_AES128CBC_HS256)

  • Label: No encryption of device settings. (Value: NONE)

amster attribute: deviceProfilesSettingsEncryptionScheme

Encryption Key Store

Path to the key store from which to load encryption keys.

amster attribute: deviceProfilesSettingsEncryptionKeystore

Key Store Type

Type of key store to load.

See the JDK 8 PKCS#11 Reference Guide for more details.

The possible values for this property are:

  • Label: Java Key Store (JKS). (Value: JKS)

  • Label: Java Cryptography Extension Key Store (JCEKS). (Value: JCEKS)

  • Label: PKCS#11 Hardware Crypto Storage. (Value: PKCS11)

  • Label: PKCS#12 Key Store. (Value: PKCS12)

amster attribute: deviceProfilesSettingsEncryptionKeystoreType

Key Store Password

Password to unlock the key store. This password is encrypted when it is saved in the AM configuration.

amster attribute: deviceProfilesSettingsEncryptionKeystorePassword

Key-Pair Alias

Alias of the certificate and private key in the key store. The private key is used to encrypt and decrypt device profiles.

amster attribute: deviceProfilesSettingsEncryptionKeystoreKeyPairAlias

Private Key Password

Password to unlock the private key.

amster attribute: deviceProfilesSettingsEncryptionKeystorePrivateKeyPassword

Email Service

The following settings are available in this service:

Email Message Implementation Class

Specifies the class that sends email notifications, such as those sent for user registration and forgotten passwords.

amster attribute: emailImplClassName

Mail Server Host Name

Specifies the fully qualified domain name of the SMTP mail server through which to send email notifications.

For example, you might set this property to: smtp.example.com

amster attribute: hostname

Mail Server Host Port

Specifies the port number for the SMTP mail server.

amster attribute: port

Mail Server Authentication Username

Specifies the user name for the SMTP mail server.

For example, you might set this property to: username

amster attribute: username

Mail Server Authentication Password

Specifies the password for the SMTP user name.

amster attribute: password

Mail Server Secure Connection

Specifies whether to connect to the SMTP mail server using SSL.

The possible values for this property are:

  • SSL

  • Non SSL

  • Start TLS

amster attribute: sslState

Email From Address

Specifies the address from which to send email notifications.

For example, you might set this property to: no-reply@example.com

amster attribute: from

Email Attribute Name

Specifies the profile attribute from which to retrieve the end user’s email address.

amster attribute: emailAddressAttribute

Email Subject

Specifies a subject for notification messages. If you do not set this, AM does not set the subject for notification messages.

amster attribute: subject

Email Content

Specifies content for notification messages. If you do not set this, AM includes only the confirmation URL in the mail body.

amster attribute: message

Email Rate Limit

Specifies the minimum number of seconds which must elapse between sending emails to an individual user.

amster attribute: emailRateLimitSeconds

ForgeRock Authenticator (OATH) Service

The following settings are available in this service:

Profile Storage Attribute

Attribute for storing ForgeRock Authenticator OATH profiles.

amster attribute: oathAttrName

Device Profile Encryption Scheme

Encryption scheme for securing device profiles stored on the server.

If enabled, each device profile is encrypted using a unique random secret key using the given strength of AES encryption in CBC mode with PKCS#5 padding. An HMAC-SHA of the given strength (truncated to half-size) is used to ensure integrity protection and authenticated encryption. The unique random key is encrypted with the given RSA key pair and stored with the device profile.

Note: AES-256 may require installation of the JCE Unlimited Strength policy files.

The possible values for this property are:

  • Label: AES-256/HMAC-SHA-512 with RSA Key Wrapping (Value: RSAES_AES256CBC_HS512)

  • Label: AES-128/HMAC-SHA-256 with RSA Key Wrapping (Value: RSAES_AES128CBC_HS256)

  • Label: No encryption of device settings. (Value: NONE)

amster attribute: authenticatorOATHDeviceSettingsEncryptionScheme

Encryption Key Store

Path to the key store from which to load encryption keys.

amster attribute: authenticatorOATHDeviceSettingsEncryptionKeystore

Key Store Type

Type of encryption key store.

See the JDK 8 PKCS#11 Reference Guide for more details.

The possible values for this property are:

  • Label: Java Key Store (JKS). (Value: JKS)

  • Label: Java Cryptography Extension Key Store (JCEKS). (Value: JCEKS)

  • Label: PKCS#11 Hardware Crypto Storage. (Value: PKCS11)

  • Label: PKCS#12 Key Store. (Value: PKCS12)

amster attribute: authenticatorOATHDeviceSettingsEncryptionKeystoreType

Key Store Password

Password to unlock the key store. This password will be encrypted.

amster attribute: authenticatorOATHDeviceSettingsEncryptionKeystorePassword

Key-Pair Alias

Alias of the certificate and private key in the key store. The private key is used to encrypt and decrypt device profiles.

amster attribute: authenticatorOATHDeviceSettingsEncryptionKeystoreKeyPairAlias

Private Key Password

Password to unlock the private key.

amster attribute: authenticatorOATHDeviceSettingsEncryptionKeystorePrivateKeyPassword

ForgeRock Authenticator (OATH) Device Skippable Attribute Name

The data store attribute that holds the user’s decision to enable or disable obtaining and providing a password obtained from the ForgeRock Authenticator app. This attribute must be writeable.

amster attribute: authenticatorOATHSkippableName

ForgeRock Authenticator (Push) Service

The following settings are available in this service:

Profile Storage Attribute

The user’s attribute in which to store Push Notification profiles.

amster attribute: pushAttrName

Device Profile Encryption Scheme

Encryption scheme to use to secure device profiles stored on the server.

If enabled, each device profile is encrypted using a unique random secret key using the given strength of AES encryption in CBC mode with PKCS#5 padding. An HMAC-SHA of the given strength (truncated to half-size) is used to ensure integrity protection and authenticated encryption. The unique random key is encrypted with the given RSA key pair and stored with the device profile.

Note: AES-256 may require installation of the JCE Unlimited Strength policy files.

The possible values for this property are:

  • Label: AES-256/HMAC-SHA-512 with RSA Key Wrapping (Value: RSAES_AES256CBC_HS512)

  • Label: AES-128/HMAC-SHA-256 with RSA Key Wrapping (Value: RSAES_AES128CBC_HS256)

  • Label: No encryption of device settings. (Value: NONE)

amster attribute: authenticatorPushDeviceSettingsEncryptionScheme

Encryption Key Store

Path to the key store from which to load encryption keys.

amster attribute: authenticatorPushDeviceSettingsEncryptionKeystore

Key Store Type

Type of key store to load.

See the JDK 8 PKCS#11 Reference Guide for more details.

The possible values for this property are:

  • Label: Java Key Store (JKS). (Value: JKS)

  • Label: Java Cryptography Extension Key Store (JCEKS). (Value: JCEKS)

  • Label: PKCS#11 Hardware Crypto Storage. (Value: PKCS11)

  • Label: PKCS#12 Key Store. (Value: PKCS12)

amster attribute: authenticatorPushDeviceSettingsEncryptionKeystoreType

Key Store Password

Password to unlock the key store. This password is encrypted when it is saved in the AM configuration.

amster attribute: authenticatorPushDeviceSettingsEncryptionKeystorePassword

Key-Pair Alias

Alias of the certificate and private key in the key store. The private key is used to encrypt and decrypt device profiles.

amster attribute: authenticatorPushDeviceSettingsEncryptionKeystoreKeyPairAlias

Private Key Password

Password to unlock the private key.

amster attribute: authenticatorPushDeviceSettingsEncryptionKeystorePrivateKeyPassword

ForgeRock Authenticator (Push) Device Skippable Attribute Name

Name of the attribute on a user’s profile used to store their selection of whether to skip ForgeRock Authenticator (Push) 2FA modules.

amster attribute: authenticatorPushSkippableName

Globalization Settings

The following settings are available in this service:

Auto Generated Common Name Format

Use this list to configure how AM formats names shown in the console banner.

This setting allows the name of the authenticated user shown in the AM UI banner to be customised based on the locale of the user.

amster attribute: commonNameFormats

OAuth2 Provider

Core

The following settings appear on the Core tab:

Use Client-Based Access & Refresh Tokens

When enabled, AM issues access and refresh tokens that can be inspected by resource servers.

amster attribute: statelessTokensEnabled

Use Macaroon Access and Refresh Tokens

When enabled, AM will issue access and refresh tokens as Macaroons with caveats.

amster attribute: macaroonTokensEnabled

Authorization Code Lifetime (seconds)

The time an authorization code is valid for, in seconds.

amster attribute: codeLifetime

Refresh Token Lifetime (seconds)

The time in seconds a refresh token is valid for. If this field is set to -1, the refresh token will never expire.

amster attribute: refreshTokenLifetime

Access Token Lifetime (seconds)

The time an access token is valid for, in seconds. Note that if you set the value to 0, the access token will not be valid. A maximum lifetime of 600 seconds is recommended.

amster attribute: accessTokenLifetime

Issue Refresh Tokens

Whether to issue a refresh token when returning an access token.

amster attribute: issueRefreshToken

Issue Refresh Tokens on Refreshing Access Tokens

Whether to issue a refresh token when refreshing an access token.

amster attribute: issueRefreshTokenOnRefreshedToken

Use Policy Engine for Scope decisions

With this setting enabled, the policy engine is consulted for each scope value that is requested.

If a policy returns an action of GRANT=true, the scope is consented automatically, and the user is not consulted in a user-interaction flow. If a policy returns an action of GRANT=false, the scope is not added to any resulting token, and the user will not see it in a user-interaction flow. If no policy returns a value for the GRANT action, then if the grant type is user-facing (i.e. authorization or device code flows), the user is asked for consent (or saved consent is used), and if the grant type is not user-facing (password or client credentials), the scope is not added to any resulting token.

amster attribute: usePolicyEngineForScope

OAuth2 Access Token Modification Script

The script that is executed when issuing an access token. The script can change the access token’s internal data structure to include or exclude particular fields.

The possible values for this property are:

  • d22f9a0c-426a-4466-b95e-d0f125b0d5fa. OAuth2 Access Token Modification Script

  • [Empty]. --- Select a script ---

amster attribute: accessTokenModificationScript

OAuth2 Access Token May Act Script

The script that is executed when issuing an access token explicitly to modify the may_act claim placed on the token.

The possible values for this property are:

  • c735de08-f8f2-4e69-aa4a-2d8d3d438323. OAuth2 May Act Script

  • [Empty]. --- Select a script ---

amster attribute: accessTokenMayActScript

OIDC ID Token May Act Script

The script that is executed when issuing an OIDC ID Token explicitly to modify the may_act claim placed on the token.

The possible values for this property are:

  • c735de08-f8f2-4e69-aa4a-2d8d3d438323. OAuth2 May Act Script

  • [Empty]. --- Select a script ---

amster attribute: oidcMayActScript

Advanced

The following settings appear on the Advanced tab:

Custom Login URL Template

Custom URL for handling login, to override the default AM login page.

Supports Freemarker syntax, with the following variables:

Variable

Description

gotoUrl

The URL to redirect to after login.

acrValues

The Authentication Context Class Reference (acr) values for the authorization request.

realm

The AM realm the authorization request was made on.

module

The name of the AM authentication module requested to perform resource owner authentication.

service

The name of the AM authentication chain requested to perform resource owner authentication.

locale

A space-separated list of locales, ordered by preference.

The following example template redirects users to a non-AM front end to handle login, which will then redirect back to the /oauth2/authorize endpoint with any required parameters:

http://mylogin.com/login?goto=${goto}<#if acrValues??>&acr_values=${acrValues}</#if><#if realm??>&realm=${realm}</#if><#if module??>&module=${module}</#if><#if service??>&service=${service}</#if><#if locale??>&locale=${locale}</#if>

NOTE: Default AM login page is constructed using "Base URL Source" service.

amster attribute: customLoginUrlTemplate

Scope Implementation Class

The class that contains the required scope implementation, must implement the org.forgerock.oauth2.core.ScopeValidator interface.

amster attribute: scopeImplementationClass

Response Type Plugins

List of plugins that handle the valid response_type values.

OAuth 2.0 clients pass response types as parameters to the OAuth 2.0 Authorization endpoint (/oauth2/authorize) to indicate which grant type is requested from the provider. For example, the client passes code when requesting an authorization code, and token when requesting an access token.

Values in this list take the form response-type|plugin-class-name.

amster attribute: responseTypeClasses

Additional Audience Values

The additional audience values that will be permitted when verifying Client Authentication JWTs.

These audience values will be in addition to the AS base, issuer and endpoint URIs.

amster attribute: allowedAudienceValues

Token Exchanger Plugins

List of plugins that handle the valid requested_token_type values.

When using the Token Exchange grant type, these handlers will be used to convert the provided subject_token and actor_token into the appropriate impersonation or delegation tokens for use with downstream services.

amster attribute: tokenExchangeClasses

Token Validator Plugins

List of plugins that validate subject_token and actor_token values.

When using the Token Exchange grant type, these handlers will be used to convert the validate subject_token and actor_token values to ensure they meet the required criteria to be exchanged.

amster attribute: tokenValidatorClasses

User Profile Attribute(s) the Resource Owner is Authenticated On

Names of profile attributes that resource owners use to log in. You can add others to the default, for example mail.

amster attribute: authenticationAttributes

User Display Name attribute

The profile attribute that contains the name to be displayed for the user on the consent page.

amster attribute: displayNameAttribute

Client Registration Scope Whitelist

The set of scopes allowed when registering clients dynamically, with translations.

+ Scopes may be entered as simple strings or pipe-separated strings representing the internal scope name, locale, and localized description.

+ For example: read|en|Permission to view email messages in your account

+ Locale strings are in the format: language_country_variant, for example en, en_GB, or en_US_WIN.

+ If the locale and pipe is omitted, the description is displayed to all users that have undefined locales.

+ If the description is also omitted, nothing is displayed on the consent page for the scope. For example specifying read| would allow the scope read to be used by the client, but would not display it to the user on the consent page when requested.

+ amster attribute: supportedScopes

Subject Types supported

List of subject types supported. Valid values are:

  • public - Each client receives the same subject (sub) value.

  • ` pairwise` - Each client receives a different subject (sub) value, to prevent correlation between clients.

amster attribute: supportedSubjectTypes

Default Client Scopes

List of scopes a client will be granted if they request registration without specifying which scopes they want. Default scopes are NOT auto-granted to clients created through the AM Admin UI.

amster attribute: defaultScopes

OAuth2 Token Signing Algorithm

Algorithm used to sign client-based OAuth 2.0 tokens in order to detect tampering.

AM supports signing algorithms listed in JSON Web Algorithms (JWA): "alg" (Algorithm) Header Parameter Values for JWS:

  • 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.

    The possible values for this property are:

  • HS256

  • HS384

  • HS512

  • RS256

  • RS384

  • RS512

  • ES256

  • ES384

  • ES512

  • PS256

  • PS384

  • PS512

amster attribute: tokenSigningAlgorithm

Client-Based Token Compression

Whether client-based access and refresh tokens should be compressed.

amster attribute: tokenCompressionEnabled

Encrypt Client-Based Tokens

Whether client-based access and refresh tokens should be encrypted.

Enabling token encryption will disable token signing as encryption is performed using direct symmetric encryption.

amster attribute: tokenEncryptionEnabled

Subject Identifier Hash Salt

If pairwise subject types are supported, it is STRONGLY RECOMMENDED to change this value. It is used in the salting of hashes for returning specific sub claims to individuals using the same request_uri or sector_identifier_uri.

amster attribute: hashSalt

Code Verifier Parameter Required

If enabled, requests using the authorization code grant require a code_challenge attribute.

For more information, read the specification for this feature.

The possible values for this property are:

  • true. All requests

  • public. Requests from all public clients

  • passwordless. Requests from all passwordless public clients

  • false. No requests

amster attribute: codeVerifierEnforced

Modified Timestamp Attribute Name

The identity Data Store attribute used to return modified timestamp values.

This attribute is paired together with the Created Timestamp Attribute Name attribute (createdTimestampAttribute). You can leave both attributes unset (default) or set them both. If you set only one attribute and leave the other blank, the access token fails with a 500 error.

For example, when you configure AM as an OpenID Connect Provider in a Mobile Connect application and use DS as an identity data store, the client accesses the userinfo endpoint to obtain the updated_at claim value in the ID token. The updated_at claim obtains its value from the modifiedTimestampAttribute attribute in the user profile. If the profile has never been modified the updated_at claim uses the createdTimestampAttribute attribute.

amster attribute: modifiedTimestampAttribute

Created Timestamp Attribute Name

The identity Data Store attribute used to return created timestamp values.

amster attribute: createdTimestampAttribute

Password Grant Authentication Service

The authentication service (chain or tree) that will be used to authenticate the username and password for the resource owner password credentials grant type.

The possible values for this property are:

  • [Empty]

  • ldapService

  • amsterService

  • Example

  • Agent

  • RetryLimit

  • PersistentCookie

  • HmacOneTimePassword

  • Facebook-ProvisionIDMAccount

  • Google-AnonymousUser

  • Google-DynamicAccountCreation

  • PlatformRegistration

  • PlatformProgressiveProfile

  • PlatformLogin

  • PlatformForgottenUsername

  • PlatformResetPassword

  • PlatformUpdatePassword

amster attribute: passwordGrantAuthService

Enable Auth Module Messages for Password Credentials Grant

If enabled, authentication module failure messages are used to create Resource Owner Password Credentials Grant failure messages. If disabled, a standard authentication failed message is used.

The Password Grant Type requires the grant_type=password parameter.

amster attribute: moduleMessageEnabledInPasswordGrant

Grant Types

The set of Grant Types (OAuth2 Flows) that are permitted to be used by this client.

If no Grant Types (OAuth2 Flows) are configured nothing will be permitted.

amster attribute: grantTypes

Trusted TLS Client Certificate Header

HTTP Header to receive TLS client certificates when TLS is terminated at a proxy.

Leave blank if not terminating TLS at a proxy. Ensure that the proxy is configured to strip this headerfrom incoming requests. Best practice is to use a random string.

amster attribute: tlsClientCertificateTrustedHeader

TLS Client Certificate Header Format

Format of the HTTP header used to communicate a client certificate from a reverse proxy.

The following formats are supported:

  • URLENCODED_PEM - a URL-encoded PEM format certificate. This is the format used by Nginx.

  • ` X_FORWARDED_CLIENT_CERT` - the X-Forwarded-Client-Certformat used by Envoy and Istio.

    The possible values for this property are:

  • URLENCODED_PEM

  • X_FORWARDED_CLIENT_CERT

amster attribute: tlsClientCertificateHeaderFormat

Support TLS Certificate-Bound Access Tokens

Whether to bind access tokens to the client certificate when using TLS client certificate authentication.

amster attribute: tlsCertificateBoundAccessTokensEnabled

Check TLS Certificate Revocation Status

Whether to check if TLS client certificates have been revoked.

If enabled then AM will check if TLS client certificates used for client authentication have been revoked using either OCSP (preferred) or CRL. AM implements "soft fail" semantics: if the revocation status cannot be established due to a temporary error (e.g., network error) then the certificate is assumed to still be valid.

amster attribute: tlsCertificateRevocationCheckingEnabled

OCSP Responder URI

URI of the OCSP responder service to use for checking certificate revocation status.

If specified this value overrides any OCSP or CRL mechanisms specified in individual certificates.

amster attribute: tlsOcspResponderUri

OCSP Responder Certificate

PEM-encoded certificate to use to verify OCSP responses.

If specified this certificate will be used to verify the signature on all OCSP responses. Otherwise the appropriate certificate will be determined from the trusted CA certificates.

amster attribute: tlsOcspResponderCert

Macaroon Token Format

The format to use when serializing and parsing Macaroons. V1 is bulky and should only be used when compatibility with older Macaroon libraries is required.

The possible values for this property are:

  • V1

  • V2

amster attribute: macaroonTokenFormat

Client Dynamic Registration

The following settings appear on the Client Dynamic Registration tab:

Require Software Statement for Dynamic Client Registration

When enabled, a software statement JWT containing at least the iss (issuer) claim must be provided when registering an OAuth 2.0 client dynamically.

amster attribute: dynamicClientRegistrationSoftwareStatementRequired

Required Software Statement Attested Attributes

The client attributes that are required to be present in the software statement JWT when registering an OAuth 2.0 client dynamically. Only applies if Require Software Statements for Dynamic Client Registration is enabled.

Leave blank to allow any attributes to be present.

amster attribute: requiredSoftwareStatementAttestedAttributes

Allow Open Dynamic Client Registration

Allow clients to register without an access token. If enabled, you should consider adding some form of rate limiting. For more information, see Client Registration in the OpenID Connect specification.

amster attribute: allowDynamicRegistration

Generate Registration Access Tokens

Whether to generate Registration Access Tokens for clients that register by using open dynamic client registration. Such tokens allow the client to access the Client Configuration Endpoint as per the OpenID Connect specification. This setting has no effect if Allow Open Dynamic Client Registration is disabled.

amster attribute: generateRegistrationAccessTokens

Scope to give access to dynamic client registration

Mandatory scope required when registering a new OAuth2 client.

amster attribute: dynamicClientRegistrationScope

OpenID Connect

The following settings appear on the OpenID Connect tab:

OIDC Claims Script

The script that is run when issuing an ID token or making a request to the userinfo endpoint during OpenID requests.

The script gathers the scopes and populates claims, and has access to the access token, the user’s identity and, if available, the user’s session.

The possible values for this property are:

  • OIDC Claims Script

amster attribute: oidcClaimsScript

Overrideable Id_Token Claims

List of claims in the id_token that may be overrideable in the OIDC Claims Script. These should be the subset of the core OpenID Connect Claims like aud or azp.

amster attribute: overrideableOIDCClaims

ID Token Signing Algorithms supported

Algorithms supported to sign OpenID Connect id_tokens.

AM supports signing algorithms listed in JSON Web Algorithms (JWA): "alg" (Algorithm) Header Parameter Values for JWS:

  • 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.

  • ` PS256` - RSASSA-PSS using SHA-256.

  • ` PS384` - RSASSA-PSS using SHA-384.

  • ` PS512` - RSASSA-PSS using SHA-512.

amster attribute: supportedIDTokenSigningAlgorithms

ID Token Encryption Algorithms supported

Encryption algorithms supported to encrypt OpenID Connect ID tokens in order to hide its contents.

AM supports the following ID token encryption algorithms:

  • 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.

  • ` A128KW` - AES Key Wrapping with 128-bit key derived from the client secret.

  • ` RSA1_5` - RSA with PKCS#1 v1.5 padding.

  • ` A256KW` - AES Key Wrapping with 256-bit key derived from the client secret.

  • ` dir` - Direct encryption with AES using the hashed client secret.

  • ` A192KW` - AES Key Wrapping with 192-bit key derived from the client secret.

amster attribute: supportedIDTokenEncryptionAlgorithms

ID Token Encryption Methods supported

Encryption methods supported to encrypt OpenID Connect ID tokens in order to hide its contents.

AM supports the following ID token encryption algorithms:

  • A128GCM, A192GCM, and A256GCM - AES in Galois Counter Mode (GCM) authenticated encryption mode.

  • A128CBC-HS256, A192CBC-HS384, and A256CBC-HS512 - AES encryption in CBC mode, with HMAC-SHA-2 for integrity.

amster attribute: supportedIDTokenEncryptionMethods

Supported Claims

Set of claims supported by the OpenID Connect /oauth2/userinfo endpoint, with translations.

Claims may be entered as simple strings or pipe separated strings representing the internal claim name, locale, and localized description.

For example: name|en|Your full name..

Locale strings are in the format: language + "" + country + "" + variant, for example en, en_GB, or en_US_WIN. If the locale and pipe is omitted, the description is displayed to all users that have undefined locales.

If the description is also omitted, nothing is displayed on the consent page for the claim. For example specifying family_name| would allow the claim family_name to be used by the client, but would not display it to the user on the consent page when requested.

amster attribute: supportedClaims

OpenID Connect JWT Token Lifetime (seconds)

The amount of time the JWT will be valid for, in seconds.

amster attribute: jwtTokenLifetime

OIDC Provider Discovery

Turns on and off OIDC Discovery endpoint.

amster attribute: oidcDiscoveryEndpointEnabled

Advanced OpenID Connect

The following settings appear on the Advanced OpenID Connect tab:

Remote JSON Web Key URL

The Remote URL where the providers JSON Web Key can be retrieved.

If this setting is not configured, then AM provides a local URL to access the public key of the private key used to sign ID tokens.

amster attribute: jkwsURI

Idtokeninfo Endpoint Requires Client Authentication

When enabled, the /oauth2/idtokeninfo endpoint requires client authentication if the signing algorithm is set to HS256, HS384, or HS512.

amster attribute: idTokenInfoClientAuthenticationEnabled

Enable "claims_parameter_supported"

If enabled, clients will be able to request individual claims using the claims request parameter, as per section 5.5 of the OpenID Connect specification.

amster attribute: claimsParameterSupported

OpenID Connect acr_values to Auth Chain Mapping

Maps OpenID Connect ACR values to authentication chains. For more details, see the acr_values parameter in the OpenID Connect authentication request specification.

amster attribute: loaMapping

Default ACR values

Default requested Authentication Context Class Reference values.

List of strings that specifies the default acr values that the OP is being requested to use for processing requests from this Client, with the values appearing in order of preference. The Authentication Context Class satisfied by the authentication performed is returned as the acr Claim Value in the issued ID Token. The acr Claim is requested as a Voluntary Claim by this parameter. The acr_values_supported discovery element contains a list of the acr values supported by this server. Values specified in the acr_values request parameter or an individual acr Claim request override these default values.

amster attribute: defaultACR

OpenID Connect id_token amr Values to Auth Module Mappings

Specify amr values to be returned in the OpenID Connect id_token. Once authentication has completed, the authentication modules that were used from the authentication service will be mapped to the amr values. If you do not require amr values, or are not providing OpenID Connect tokens, leave this field blank.

amster attribute: amrMappings

Always Return Claims in ID Tokens

If enabled, include scope-derived claims in the id_token, even if an access token is also returned that could provide access to get the claims from the userinfo endpoint.

If not enabled, if an access token is requested the client must use it to access the userinfo endpoint for scope-derived claims, as they will not be included in the ID token.

amster attribute: alwaysAddClaimsToToken

Enable Session Management

If this is not enabled then OpenID Connect session management related endpoints will be disabled. When enabled AM will store ops tokens corresponding to OpenID Connect sessions in the CTS store and an oidc session id in the AM session.

amster attribute: storeOpsTokens

Request Parameter Signing Algorithms Supported

Algorithms supported to verify signature of Request parameterAM supports signing algorithms listed in JSON Web Algorithms (JWA): "alg" (Algorithm) Header Parameter Values for JWS:

  • 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.

amster attribute: supportedRequestParameterSigningAlgorithms

Request Parameter Encryption Algorithms Supported

Encryption algorithms supported to decrypt Request parameter.

AM supports the following ID token encryption algorithms:

  • 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.

  • ` A128KW` - AES Key Wrapping with 128-bit key derived from the client secret.

  • ` RSA1_5` - RSA with PKCS#1 v1.5 padding.

  • ` A256KW` - AES Key Wrapping with 256-bit key derived from the client secret.

  • ` dir` - Direct encryption with AES using the hashed client secret.

  • ` A192KW` - AES Key Wrapping with 192-bit key derived from the client secret.

amster attribute: supportedRequestParameterEncryptionAlgorithms

Request Parameter Encryption Methods Supported

Encryption methods supported to decrypt Request parameter.

AM supports the following Request parameter encryption algorithms:

  • A128GCM, A192GCM, and A256GCM - AES in Galois Counter Mode (GCM) authenticated encryption mode.

  • A128CBC-HS256, A192CBC-HS384, and A256CBC-HS512 - AES encryption in CBC mode, with HMAC-SHA-2 for integrity.

amster attribute: supportedRequestParameterEncryptionEnc

Supported Token Endpoint JWS Signing Algorithms.

Supported JWS Signing Algorithms for 'private_key_jwt' JWT based authentication method.

amster attribute: supportedTokenEndpointAuthenticationSigningAlgorithms

Authorized OIDC SSO Clients

Clients authorized to use OpenID Connect ID tokens as SSO Tokens.

Allows clients to act with the full authority of the user. Grant this permission only to trusted clients.

amster attribute: authorisedOpenIdConnectSSOClients

UserInfo Signing Algorithms Supported

Algorithms supported to verify signature of the UserInfo endpoint. AM supports signing algorithms listed in JSON Web Algorithms (JWA): "alg" (Algorithm) Header Parameter Values for JWS:

  • 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.

amster attribute: supportedUserInfoSigningAlgorithms

UserInfo Encryption Algorithms Supported

Encryption algorithms supported by the UserInfo endpoint.

AM supports the following UserInfo endpoint encryption algorithms:

  • 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.

  • ` A128KW` - AES Key Wrapping with 128-bit key derived from the client secret.

  • ` RSA1_5` - RSA with PKCS#1 v1.5 padding.

  • ` A256KW` - AES Key Wrapping with 256-bit key derived from the client secret.

  • ` dir` - Direct encryption with AES using the hashed client secret.

  • ` A192KW` - AES Key Wrapping with 192-bit key derived from the client secret.

amster attribute: supportedUserInfoEncryptionAlgorithms

UserInfo Encryption Methods Supported

Encryption methods supported by the UserInfo endpoint.

AM supports the following UserInfo endpoint encryption methods:

  • A128GCM, A192GCM, and A256GCM - AES in Galois Counter Mode (GCM) authenticated encryption mode.

  • A128CBC-HS256, A192CBC-HS384, and A256CBC-HS512 - AES encryption in CBC mode, with HMAC-SHA-2 for integrity.

amster attribute: supportedUserInfoEncryptionEnc

Token Introspection Response Signing Algorithms Supported

Algorithms that are supported for signing the Token Introspection endpoint JWT response.

AM supports signing algorithms listed in JSON Web Algorithms (JWA): "alg" (Algorithm) Header Parameter Values for JWS:

  • 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.

amster attribute: supportedTokenIntrospectionResponseSigningAlgorithms

Token Introspection Response Encryption Algorithms Supported

Encryption algorithms supported by the Token Introspection endpoint JWT response.

AM supports the following UserInfo endpoint encryption algorithms:

  • 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.

  • ` A128KW` - AES Key Wrapping with 128-bit key derived from the client secret.

  • ` RSA1_5` - RSA with PKCS#1 v1.5 padding.

  • ` A256KW` - AES Key Wrapping with 256-bit key derived from the client secret.

  • ` dir` - Direct encryption with AES using the hashed client secret.

  • ` A192KW` - AES Key Wrapping with 192-bit key derived from the client secret.

amster attribute: supportedTokenIntrospectionResponseEncryptionAlgorithms

Token Introspection Response Encryption Methods Supported

Encryption methods supported by the Token Introspection endpoint JWT response.

AM supports the following encryption methods:

  • A128GCM, A192GCM, and A256GCM - AES in Galois Counter Mode (GCM) authenticated encryption mode.

  • A128CBC-HS256, A192CBC-HS384, and A256CBC-HS512 - AES encryption in CBC mode, with HMAC-SHA-2 for integrity.

amster attribute: supportedTokenIntrospectionResponseEncryptionEnc

Include all kty and alg combinations in jwks_uri

By default only distinct kid entries are returned in the jwks_uri and the alg property is not included. Enabling this flag will result in duplicate kid entries, each one specifying a different kty and alg combination. RFC7517 distinct key KIDs

amster attribute: includeAllKtyAlgCombinationsInJwksUri

Device Flow

The following settings appear on the Device Flow tab:

Verification URL

The URL that the user will be instructed to visit to complete their OAuth 2.0 login and consent when using the device code flow.

amster attribute: verificationUrl

Device Completion URL

The URL that the user will be sent to on completion of their OAuth 2.0 login and consent when using the device code flow.

amster attribute: completionUrl

Device Code Lifetime (seconds)

The lifetime of the device code, in seconds.

amster attribute: deviceCodeLifetime

Device Polling Interval

The polling frequency for devices waiting for tokens when using the device code flow.

amster attribute: devicePollInterval

The following settings appear on the Consent tab:

Saved Consent Attribute Name

Name of a multi-valued attribute on resource owner profiles where AM can save authorization consent decisions.

When the resource owner chooses to save the decision to authorize access for a client application, then AM updates the resource owner’s profile to avoid having to prompt the resource owner to grant authorization when the client issues subsequent authorization requests.

amster attribute: savedConsentAttribute

Allow Clients to Skip Consent

If enabled, clients may be configured so that the resource owner will not be asked for consent during authorization flows.

amster attribute: clientsCanSkipConsent

Enable Remote Consent

amster attribute: enableRemoteConsent

Remote Consent Service ID

The ID of an existing remote consent service agent.

The possible values for this property are:

  • [Empty]

amster attribute: remoteConsentServiceId

Remote Consent Service Request Signing Algorithms Supported

Algorithms supported to sign consent_request JWTs for Remote Consent Services.

AM supports signing algorithms listed in JSON Web Algorithms (JWA): "alg" (Algorithm) Header Parameter Values for JWS:

  • 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.

amster attribute: supportedRcsRequestSigningAlgorithms

Remote Consent Service Request Encryption Algorithms Supported

Encryption algorithms supported to encrypt Remote Consent Service requests.

AM supports the following encryption algorithms:

  • RSA1_5 - RSA with PKCS#1 v1.5 padding.

  • ` 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.

  • ` 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.

  • ` dir` - Direct encryption with AES using the hashed client secret.

amster attribute: supportedRcsRequestEncryptionAlgorithms

Remote Consent Service Request Encryption Methods Supported

Encryption methods supported to encrypt Remote Consent Service requests.

AM supports the following encryption methods:

  • A128GCM, A192GCM, and A256GCM - AES in Galois Counter Mode (GCM) authenticated encryption mode.

  • A128CBC-HS256, A192CBC-HS384, and A256CBC-HS512 - AES encryption in CBC mode, with HMAC-SHA-2 for integrity.

amster attribute: supportedRcsRequestEncryptionMethods

Remote Consent Service Response Signing Algorithms Supported

Algorithms supported to verify signed consent_response JWT from Remote Consent Services.

AM supports signing algorithms listed in JSON Web Algorithms (JWA): "alg" (Algorithm) Header Parameter Values for JWS:

  • 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.

amster attribute: supportedRcsResponseSigningAlgorithms

Remote Consent Service Response Encryption Algorithms Supported

Encryption algorithms supported to decrypt Remote Consent Service responses.

AM supports the following encryption algorithms:

  • RSA1_5 - RSA with PKCS#1 v1.5 padding.

  • ` 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.

  • ` 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.

  • ` dir` - Direct encryption with AES using the hashed client secret.

amster attribute: supportedRcsResponseEncryptionAlgorithms

Remote Consent Service Response Encryption Methods Supported

Encryption methods supported to decrypt Remote Consent Service responses.

AM supports the following encryption methods:

  • A128GCM, A192GCM, and A256GCM - AES in Galois Counter Mode (GCM) authenticated encryption mode.

  • A128CBC-HS256, A192CBC-HS384, and A256CBC-HS512 - AES encryption in CBC mode, with HMAC-SHA-2 for integrity.

amster attribute: supportedRcsResponseEncryptionMethods

CIBA

The following settings appear on the CIBA tab:

Back Channel Authentication ID Lifetime (seconds)

The time back channel authentication request id is valid for, in seconds.

amster attribute: cibaAuthReqIdLifetime

Polling Wait Interval (seconds)

The minimum amount of time in seconds that the Client should wait between polling requests to the token endpoint

amster attribute: cibaMinimumPollingInterval

Signing Algorithms Supported

Algorithms supported to sign the CIBA request parameter.

AM supports signing algorithms listed in JSON Web Algorithms (JWA): "alg" (Algorithm) Header Parameter Values for JWS:

  • ES256 - ECDSA with SHA-256 and NIST standard P-256 elliptic curve.

  • ` PS256` - RSASSA-PSS using SHA-256.

amster attribute: supportedCibaSigningAlgorithms

Push Notification Service

The following settings are available in this service:

SNS Access Key ID

Amazon Simple Notification Service Access Key ID. For more information, see https://aws.amazon.com/developers/access-keys/.

For example, you might set this property to: AKIAIOSFODNN7EXAMPLE

amster attribute: accessKey

SNS Access Key Secret

Amazon Simple Notification Service Access Key Secret. For more information, see https://aws.amazon.com/developers/access-keys/.

amster attribute: secret

SNS Endpoint for APNS

The Simple Notification Service endpoint in Amazon Resource Name format, used to send push messages to the Apple Push Notification Service (APNS).

For example, you might set this property to: arn:aws:sns:us-east-1:1234567890:app/APNS/production

amster attribute: appleEndpoint

SNS Endpoint for GCM

The Simple Notification Service endpoint in Amazon Resource Name format, used to send push messages over Google Cloud Messaging (GCM).

For example, you might set this property to: arn:aws:sns:us-east-1:1234567890:app/GCM/production

amster attribute: googleEndpoint

SNS Client Region

Region of your registered Amazon Simple Notification Service client. For more information, see https://docs.aws.amazon.com/general/latest/gr/rande.html.

The possible values for this property are:

  • us-gov-west-1

  • us-east-1

  • us-west-1

  • us-west-2

  • eu-west-1

  • eu-central-1

  • ap-southeast-1

  • ap-southeast-2

  • ap-northeast-1

  • ap-northeast-2

  • sa-east-1

  • n-north-1

amster attribute: region

Message Transport Delegate Factory

The fully qualified class name of the factory responsible for creating the PushNotificationDelegate. The class must implement org.forgerock.openam.services.push.PushNotificationDelegate.

amster attribute: delegateFactory

Response Cache Duration

The minimum lifetime to keep unanswered message records in the message dispatcher cache, in seconds. To keep unanswered message records indefinitely, set this property to 0.Should be tuned so that it is applicable to the use case of this service. For example, the ForgeRock Authenticator (Push) authentication module has a default timeout of 120 seconds.

amster attribute: mdDuration

Response Cache Concurrency

Level of concurrency to use when accessing the message dispatcher cache. Must be greater than 0. Choose a value to accommodate as many threads as will ever concurrently access the message dispatcher cache.

amster attribute: mdConcurrency

Response Cache Size

Maximum size of the message dispatcher cache, in number of records. If set to 0 the cache can grow indefinitely. If the number of records that need to be stored exceeds this maximum, then older items in the cache will be removed to make space.

amster attribute: mdCacheSize

Remote Consent Service

The following settings are available in this service:

Client Name

The name used to identify this OAuth 2.0 remote consent service when referencedin other services.

amster attribute: clientId

Authorization Server jwk_uri

The jwk_uri for retrieving the authorization server signing and encryption keys.

amster attribute: jwksUriAS

JWK Store Cache Timeout (in minutes)

The cache timeout for the JWK store of the authorization server, in minutes.

amster attribute: jwkStoreCacheTimeout

JWK Store Cache Miss Cache Time (in minutes)

The length of time a cache miss is cached, in minutes.

amster attribute: jwkStoreCacheMissCacheTime

Consent Response Time Limit (in minutes)

The time limit set on the consent response JWT before it expires, in minutes.

amster attribute: consentResponseTimeLimit

Session

Dynamic Attributes

The following settings appear on the Dynamic Attributes tab:

Maximum Session Time

Maximum time a session can remain valid before AM requires the user to authenticate again, in minutes.

amster attribute: maxSessionTime

Maximum Idle Time

Maximum time a CTS-based session can remain idle before AM requires the user to authenticate again, in minutes.

amster attribute: maxIdleTime

Maximum Caching Time

Maximum time that external clients of AM are recommended to cache the session for, in minutes.

amster attribute: maxCachingTime

Active User Sessions

Maximum number of concurrent CTS-based sessions AM allows a user to have.

amster attribute: quotaLimit

Session Property Whitelist Service

The following settings are available in this service:

Whitelisted Session Property Names

A list of properties that users may read, edit the value of, or delete from their session.

Adding properties to sessions can impact AM’s performance. Because there is no size constraint limiting the set of properties that you can add to sessions, and no limit on the number of session properties you can add, keep in mind that adding session properties can increase the load on an AM deployment in the following areas:

  • AM server memory

  • OpenDJ storage

  • OpenDJ replication

Protected attributes will NOT be allowed to be set, edited or deleted, even if they are included in this whitelist.

+ amster attribute: sessionPropertyWhitelist

Session Properties to return for session queries

A list of session properties that can be returned to admins in a REST session query response.

This setting may impact REST query performance - when session properties are added, the CTS token must be retrieved, and will be the subject of decryption and decompression, if configured.

Protected attributes will NOT be allowed to be set, edited or deleted, even if they are included in this list.

amster attribute: whitelistedQueryProperties

Social Identity Provider Service

Configuration

The following settings appear on the Configuration tab:

Enabled

amster attribute: enabled

Secondary Configurations

This service has the following Secondary Configurations.

instagramConfig

Enabled

amster attribute: enabled

Auth ID Key

Field used to identify a user by the social provider.

For example, you might set this property to: id

amster attribute: authenticationIdKey

Client ID

OAuth client_id parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientId

Client Secret

OAuth client_secret parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientSecret

Authentication Endpoint URL

OAuth authentication endpoint URL

This is the URL endpoint for OAuth authentication provided by the OAuth Identity Provider.

For example, you might set this property to: https://api.instagram.com/oauth/authorize/

amster attribute: authorizationEndpoint

Access Token Endpoint URL

OAuth access token endpoint URL This is the URL endpoint for access token retrieval provided by the OAuth Identity Provider.Refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-3.2), section 3.2.

For example, you might set this property to: https://api.instagram.com/oauth/access_token

amster attribute: tokenEndpoint

User Profile Service URL

User profile information URL

This URL endpoint provides user profile information and is provided by the OAuth Identity Provider NB This URL should return JSON objects in response.

For example, you might set this property to: https://graph.instagram.com/me?fields=id,username

amster attribute: userInfoEndpoint

Token Introspection Endpoint URL

OAuth Token Introspection endpoint URL This is the URL endpoint for access token validation using the OAuth Identity Provider.Refer to the RFC 7662 (http://tools.ietf.org/html/rfc7662).

For example, you might set this property to: https://graph.instagram.com/debug_token

amster attribute: introspectEndpoint

Redirect URL

amster attribute: redirectURI

Redirect after form post URL

Specify URL to redirect the form post parameters to.

amster attribute: redirectAfterFormPostURI

Scope Delimiter

The delimiter used by an auth server to separate scopes.

amster attribute: scopeDelimiter

OAuth Scopes

List of user profile properties

According to the OAuth 2.0 Authorization Framework that the client application requires. The list depends on the permissions that the resource owner grants to the client application. Some authorization servers use non-standard separators for scopes.

For example, you might set this property to: user_profile

amster attribute: scopes

Client Authentication Method

Field used to define how the client would be identified by the social provider.

amster attribute: clientAuthenticationMethod

PKCE Method

The PKCE transformation method to use when making requests to the authorization endpoint.

amster attribute: pkceMethod

JWKS URI Endpoint

The JWKS URL endpoint for the RP to use when encrypting or validating

amster attribute: jwksUriEndpoint

JWT Signing Algorithm

The signing algorithm to use when signing the client assertion and request object jwt sent to social provider.

amster attribute: jwtSigningAlgorithm

JWT Encryption Algorithm

The encryption algorithm to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionAlgorithm

JWT Encryption Method

The encryption method to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionMethod

Private Key JWT Expiration Time (seconds)

The expiration time on or after which the private key JWT must not be accepted for processing.

amster attribute: privateKeyJwtExpTime

Response Mode

Informs the Authorization Server of the mechanism to use for returning Authorization Response parameters.

amster attribute: responseMode

UI Config Properties

Mapping of display properties to be defined and consumed by the UI.

amster attribute: uiConfig

Transform Script

A script that takes the raw profile object as input and outputs the normalized profile object.

amster attribute: transform

googleConfig

Enabled

amster attribute: enabled

Auth ID Key

Field used to identify a user by the social provider.

For example, you might set this property to: sub

amster attribute: authenticationIdKey

Client ID

OAuth client_id parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientId

Client Secret

OAuth client_secret parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientSecret

Authentication Endpoint URL

OAuth authentication endpoint URL

This is the URL endpoint for OAuth authentication provided by the OAuth Identity Provider.

For example, you might set this property to: https://accounts.google.com/o/oauth2/v2/auth

amster attribute: authorizationEndpoint

Access Token Endpoint URL

OAuth access token endpoint URL This is the URL endpoint for access token retrieval provided by the OAuth Identity Provider.Refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-3.2), section 3.2.

For example, you might set this property to: https://www.googleapis.com/oauth2/v4/token

amster attribute: tokenEndpoint

User Profile Service URL

User profile information URL

This URL endpoint provides user profile information and is provided by the OAuth Identity Provider NB This URL should return JSON objects in response.

For example, you might set this property to: https://www.googleapis.com/oauth2/v3/userinfo

amster attribute: userInfoEndpoint

Token Introspection Endpoint URL

OAuth Token Introspection endpoint URL This is the URL endpoint for access token validation using the OAuth Identity Provider.Refer to the RFC 7662 (http://tools.ietf.org/html/rfc7662).

amster attribute: introspectEndpoint

Redirect URL

amster attribute: redirectURI

Redirect after form post URL

Specify URL to redirect the form post parameters to.

amster attribute: redirectAfterFormPostURI

Scope Delimiter

The delimiter used by an auth server to separate scopes.

amster attribute: scopeDelimiter

OAuth Scopes

List of user profile properties

According to the OAuth 2.0 Authorization Framework that the client application requires. The list depends on the permissions that the resource owner grants to the client application. Some authorization servers use non-standard separators for scopes.

For example, you might set this property to: openid, profile, email

amster attribute: scopes

Client Authentication Method

Field used to define how the client would be identified by the social provider.

amster attribute: clientAuthenticationMethod

PKCE Method

The PKCE transformation method to use when making requests to the authorization endpoint.

amster attribute: pkceMethod

Request Parameter JWT Option

Choose how Request Parameter JWTs will be sent to the OIDC Provider. Choose REFERENCE for OpenID Connect Request Parameter JWTs to be passed by reference. Choose VALUE for OpenID Connect Request Parameter JWTs to be passed as single, self-contained parameters.Choose NONE to specify that Request Parameter JWTs are not used.

amster attribute: jwtRequestParameterOption

Encrypt Request Parameter JWT

Enable the option to send an encrypted request parameter JWT.

amster attribute: encryptJwtRequestParameter

ACR Values

Space-separated string that specifies the acr values that the Authorization Server is being requested to use for processing this Authentication Request, with the values appearing in order of preference.

amster attribute: acrValues

Well Known Endpoint

The endpoint for retrieving a list of OAuth/OIDC endpoints.

For example, you might set this property to: https://accounts.google.com/.well-known/openid-configuration

amster attribute: wellKnownEndpoint

Request Object Audience

The intended audience of the request object. If unspecified, the issuer value will be used.

amster attribute: requestObjectAudience

OP Encrypts ID Tokens

Whether the OP encrypts ID Tokens. Will determine which resolver to use.

amster attribute: encryptedIdTokens

Issuer

The Issuer of OIDC ID Tokens.

For example, you might set this property to: https://accounts.google.com

amster attribute: issuer

Enable Native Nonce

When enabled, the Identity Provider Native SDK MUST include a nonce Claim in the ID Token with the Claim value being the nonce value sent in the Authentication Request.

amster attribute: enableNativeNonce

User Info Response Format

The expected format of UserInfo responses. Dictates how AM will process the response. The expected format must match the actual format.

amster attribute: userInfoResponseType

JWKS URI Endpoint

The JWKS URL endpoint for the RP to use when encrypting or validating

amster attribute: jwksUriEndpoint

JWT Signing Algorithm

The signing algorithm to use when signing the client assertion and request object jwt sent to social provider.

amster attribute: jwtSigningAlgorithm

JWT Encryption Algorithm

The encryption algorithm to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionAlgorithm

JWT Encryption Method

The encryption method to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionMethod

Private Key JWT Expiration Time (seconds)

The expiration time on or after which the private key JWT must not be accepted for processing.

amster attribute: privateKeyJwtExpTime

Response Mode

Informs the Authorization Server of the mechanism to use for returning Authorization Response parameters.

amster attribute: responseMode

UI Config Properties

Mapping of display properties to be defined and consumed by the UI.

amster attribute: uiConfig

Transform Script

A script that takes the raw profile object as input and outputs the normalized profile object.

amster attribute: transform

oauth2Config

Enabled

amster attribute: enabled

Auth ID Key

Field used to identify a user by the social provider.

For example, you might set this property to: sub

amster attribute: authenticationIdKey

Client ID

OAuth client_id parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientId

Client Secret

OAuth client_secret parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientSecret

Authentication Endpoint URL

OAuth authentication endpoint URL

This is the URL endpoint for OAuth authentication provided by the OAuth Identity Provider.

amster attribute: authorizationEndpoint

Access Token Endpoint URL

OAuth access token endpoint URL This is the URL endpoint for access token retrieval provided by the OAuth Identity Provider.Refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-3.2), section 3.2.

amster attribute: tokenEndpoint

User Profile Service URL

User profile information URL

This URL endpoint provides user profile information and is provided by the OAuth Identity Provider NB This URL should return JSON objects in response.

amster attribute: userInfoEndpoint

Token Introspection Endpoint URL

OAuth Token Introspection endpoint URL This is the URL endpoint for access token validation using the OAuth Identity Provider.Refer to the RFC 7662 (http://tools.ietf.org/html/rfc7662).

amster attribute: introspectEndpoint

Redirect URL

amster attribute: redirectURI

Redirect after form post URL

Specify URL to redirect the form post parameters to.

amster attribute: redirectAfterFormPostURI

Scope Delimiter

The delimiter used by an auth server to separate scopes.

amster attribute: scopeDelimiter

OAuth Scopes

List of user profile properties

According to the OAuth 2.0 Authorization Framework that the client application requires. The list depends on the permissions that the resource owner grants to the client application. Some authorization servers use non-standard separators for scopes.

amster attribute: scopes

Client Authentication Method

Field used to define how the client would be identified by the social provider.

amster attribute: clientAuthenticationMethod

PKCE Method

The PKCE transformation method to use when making requests to the authorization endpoint.

amster attribute: pkceMethod

JWKS URI Endpoint

The JWKS URL endpoint for the RP to use when encrypting or validating

amster attribute: jwksUriEndpoint

JWT Signing Algorithm

The signing algorithm to use when signing the client assertion and request object jwt sent to social provider.

amster attribute: jwtSigningAlgorithm

JWT Encryption Algorithm

The encryption algorithm to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionAlgorithm

JWT Encryption Method

The encryption method to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionMethod

Private Key JWT Expiration Time (seconds)

The expiration time on or after which the private key JWT must not be accepted for processing.

amster attribute: privateKeyJwtExpTime

Response Mode

Informs the Authorization Server of the mechanism to use for returning Authorization Response parameters.

amster attribute: responseMode

UI Config Properties

Mapping of display properties to be defined and consumed by the UI.

amster attribute: uiConfig

Transform Script

A script that takes the raw profile object as input and outputs the normalized profile object.

amster attribute: transform

appleConfig

Enabled

amster attribute: enabled

Auth ID Key

Field used to identify a user by the social provider.

For example, you might set this property to: sub

amster attribute: authenticationIdKey

Client ID

OAuth client_id parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientId

Client Secret

OAuth client_secret parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientSecret

Authentication Endpoint URL

OAuth authentication endpoint URL

This is the URL endpoint for OAuth authentication provided by the OAuth Identity Provider.

For example, you might set this property to: https://appleid.apple.com/auth/authorize

amster attribute: authorizationEndpoint

Access Token Endpoint URL

OAuth access token endpoint URL This is the URL endpoint for access token retrieval provided by the OAuth Identity Provider.Refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-3.2), section 3.2.

For example, you might set this property to: https://appleid.apple.com/auth/token

amster attribute: tokenEndpoint

User Profile Service URL

User profile information URL

This URL endpoint provides user profile information and is provided by the OAuth Identity Provider NB This URL should return JSON objects in response.

amster attribute: userInfoEndpoint

Token Introspection Endpoint URL

OAuth Token Introspection endpoint URL This is the URL endpoint for access token validation using the OAuth Identity Provider.Refer to the RFC 7662 (http://tools.ietf.org/html/rfc7662).

amster attribute: introspectEndpoint

Redirect URL

amster attribute: redirectURI

Redirect after form post URL

Specify URL to redirect the form post parameters to.

amster attribute: redirectAfterFormPostURI

Scope Delimiter

The delimiter used by an auth server to separate scopes.

amster attribute: scopeDelimiter

OAuth Scopes

List of user profile properties

According to the OAuth 2.0 Authorization Framework that the client application requires. The list depends on the permissions that the resource owner grants to the client application. Some authorization servers use non-standard separators for scopes.

amster attribute: scopes

Client Authentication Method

Field used to define how the client would be identified by the social provider.

amster attribute: clientAuthenticationMethod

PKCE Method

The PKCE transformation method to use when making requests to the authorization endpoint.

amster attribute: pkceMethod

Request Parameter JWT Option

Choose how Request Parameter JWTs will be sent to the OIDC Provider. Choose REFERENCE for OpenID Connect Request Parameter JWTs to be passed by reference. Choose VALUE for OpenID Connect Request Parameter JWTs to be passed as single, self-contained parameters.Choose NONE to specify that Request Parameter JWTs are not used.

amster attribute: jwtRequestParameterOption

Encrypt Request Parameter JWT

Enable the option to send an encrypted request parameter JWT.

amster attribute: encryptJwtRequestParameter

ACR Values

Space-separated string that specifies the acr values that the Authorization Server is being requested to use for processing this Authentication Request, with the values appearing in order of preference.

amster attribute: acrValues

Well Known Endpoint

The endpoint for retrieving a list of OAuth/OIDC endpoints.

amster attribute: wellKnownEndpoint

Request Object Audience

The intended audience of the request object. If unspecified, the issuer value will be used.

amster attribute: requestObjectAudience

OP Encrypts ID Tokens

Whether the OP encrypts ID Tokens. Will determine which resolver to use.

amster attribute: encryptedIdTokens

Issuer

The Issuer of OIDC ID Tokens.

amster attribute: issuer

Enable Native Nonce

When enabled, the Identity Provider Native SDK MUST include a nonce Claim in the ID Token with the Claim value being the nonce value sent in the Authentication Request.

amster attribute: enableNativeNonce

User Info Response Format

The expected format of UserInfo responses. Dictates how AM will process the response. The expected format must match the actual format.

amster attribute: userInfoResponseType

JWKS URI Endpoint

The JWKS URL endpoint for the RP to use when encrypting or validating

amster attribute: jwksUriEndpoint

JWT Signing Algorithm

The signing algorithm to use when signing the client assertion and request object jwt sent to social provider.

amster attribute: jwtSigningAlgorithm

JWT Encryption Algorithm

The encryption algorithm to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionAlgorithm

JWT Encryption Method

The encryption method to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionMethod

Private Key JWT Expiration Time (seconds)

The expiration time on or after which the private key JWT must not be accepted for processing.

amster attribute: privateKeyJwtExpTime

Response Mode

Informs the Authorization Server of the mechanism to use for returning Authorization Response parameters.

amster attribute: responseMode

UI Config Properties

Mapping of display properties to be defined and consumed by the UI.

amster attribute: uiConfig

Transform Script

A script that takes the raw profile object as input and outputs the normalized profile object.

amster attribute: transform

itsmeConfig

Enabled

amster attribute: enabled

Auth ID Key

Field used to identify a user by the social provider.

For example, you might set this property to: sub

amster attribute: authenticationIdKey

Client ID

OAuth client_id parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientId

Client Secret

OAuth client_secret parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientSecret

Authentication Endpoint URL

OAuth authentication endpoint URL

This is the URL endpoint for OAuth authentication provided by the OAuth Identity Provider.

For example, you might set this property to: https://idp.prd.itsme.services/v2/authorization

amster attribute: authorizationEndpoint

Access Token Endpoint URL

OAuth access token endpoint URL This is the URL endpoint for access token retrieval provided by the OAuth Identity Provider.Refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-3.2), section 3.2.

For example, you might set this property to: https://idp.prd.itsme.services/v2/token

amster attribute: tokenEndpoint

User Profile Service URL

User profile information URL

This URL endpoint provides user profile information and is provided by the OAuth Identity Provider NB This URL should return JSON objects in response.

For example, you might set this property to: https://idp.prd.itsme.services/v2/userinfo

amster attribute: userInfoEndpoint

Token Introspection Endpoint URL

OAuth Token Introspection endpoint URL This is the URL endpoint for access token validation using the OAuth Identity Provider.Refer to the RFC 7662 (http://tools.ietf.org/html/rfc7662).

amster attribute: introspectEndpoint

Redirect URL

amster attribute: redirectURI

Redirect after form post URL

Specify URL to redirect the form post parameters to.

amster attribute: redirectAfterFormPostURI

Scope Delimiter

The delimiter used by an auth server to separate scopes.

amster attribute: scopeDelimiter

OAuth Scopes

List of user profile properties

According to the OAuth 2.0 Authorization Framework that the client application requires. The list depends on the permissions that the resource owner grants to the client application. Some authorization servers use non-standard separators for scopes.

For example, you might set this property to: openid, profile, email

amster attribute: scopes

Client Authentication Method

Field used to define how the client would be identified by the social provider.

amster attribute: clientAuthenticationMethod

PKCE Method

The PKCE transformation method to use when making requests to the authorization endpoint.

Default value: S256

amster attribute: pkceMethod

Request Parameter JWT Option

Choose how Request Parameter JWTs will be sent to the OIDC Provider. Choose REFERENCE for OpenID Connect Request Parameter JWTs to be passed by reference. Choose VALUE for OpenID Connect Request Parameter JWTs to be passed as single, self-contained parameters.Choose NONE to specify that Request Parameter JWTs are not used.

Default value: NONE

amster attribute: jwtRequestParameterOption

Encrypt Request Parameter JWT

Enable the option to send an encrypted request parameter JWT.

Default value: true

amster attribute: encryptJwtRequestParameter

ACR Values

Space-separated string that specifies the acr values that the Authorization Server is being requested to use for processing this Authentication Request, with the values appearing in order of preference.

amster attribute: acrValues

Well Known Endpoint

The endpoint for retrieving a list of OAuth/OIDC endpoints.

For example, you might set this property to: https://idp.prd.itsme.services/v2/.well-known/openid-configuration

amster attribute: wellKnownEndpoint

Request Object Audience

The intended audience of the request object. If unspecified, the issuer value will be used.

For example, you might set this property to: https://idp.prd.itsme.services/v2/authorization

amster attribute: requestObjectAudience

OP Encrypts ID Tokens

Whether the OP encrypts ID Tokens. Will determine which resolver to use.

Default value: true

amster attribute: encryptedIdTokens

Issuer

The Issuer of OIDC ID Tokens.

For example, you might set this property to: https://idp.prd.itsme.services/v2

amster attribute: issuer

Enable Native Nonce

When enabled, the Identity Provider Native SDK MUST include a nonce Claim in the ID Token with the Claim value being the nonce value sent in the Authentication Request. Enabled by default.

Default value: true

amster attribute: enableNativeNonce

User Info Response Format

The expected format of UserInfo responses. Dictates how AM will process the response. The expected format must match the actual format.

Default value: SIGNED_THEN_ENCRYPTED_JWT

amster attribute: userInfoResponseType

JWKS URI Endpoint

The JWKS URL endpoint for the RP to use when encrypting or validating

For example, you might set this property to: https://idp.prd.itsme.services/v2/jwkSet

amster attribute: jwksUriEndpoint

JWT Signing Algorithm

The signing algorithm to use when signing the client assertion and request object jwt sent to social provider.

Default value: RS256

amster attribute: jwtSigningAlgorithm

JWT Encryption Algorithm

The encryption algorithm to use when encrypting the client assertion and request object jwt sent to social provider.

Default value: RSA-OAEP

amster attribute: jwtEncryptionAlgorithm

JWT Encryption Method

The encryption method to use when encrypting the client assertion and request object jwt sent to social provider.

Default value: AES_128_CBC_HMAC_SHA_256

amster attribute: jwtEncryptionMethod

Private Key JWT Expiration Time (seconds)

The expiration time on or after which the private key JWT must not be accepted for processing.

Default value: 600

amster attribute: privateKeyJwtExpTime

Response Mode

Informs the Authorization Server of the mechanism to use for returning Authorization Response parameters.

Default value: DEFAULT

amster attribute: responseMode

UI Config Properties

Mapping of display properties to be defined and consumed by the UI.

amster attribute: uiConfig

Transform Script

A script that takes the raw profile object as input and outputs the normalized profile object.

Default value: 3d97c436-42c0-4dd0-a571-ea6f34f752b3

amster attribute: transform

amazonConfig

Enabled

Default value: true

amster attribute: enabled

Auth ID Key

Field used to identify a user by the social provider.

For example, you might set this property to: user_id

Default value: user_id

amster attribute: authenticationIdKey

Client ID

OAuth client_id parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientId

Client Secret

OAuth client_secret parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientSecret

Authentication Endpoint URL

OAuth authentication endpoint URL

This is the URL endpoint for OAuth authentication provided by the OAuth Identity Provider.

For example, you might set this property to: https://www.amazon.com/ap/oa

amster attribute: authorizationEndpoint

Access Token Endpoint URL

OAuth access token endpoint URL This is the URL endpoint for access token retrieval provided by the OAuth Identity Provider.Refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-3.2), section 3.2.

For example, you might set this property to: https://api.amazon.com/auth/o2/token

amster attribute: tokenEndpoint

User Profile Service URL

User profile information URL

This URL endpoint provides user profile information and is provided by the OAuth Identity Provider NB This URL should return JSON objects in response.

For example, you might set this property to: https://api.amazon.com/user/profile

amster attribute: userInfoEndpoint

Token Introspection Endpoint URL

OAuth Token Introspection endpoint URL This is the URL endpoint for access token validation using the OAuth Identity Provider.Refer to the RFC 7662 (http://tools.ietf.org/html/rfc7662).

amster attribute: introspectEndpoint

Redirect URL

amster attribute: redirectURI

Redirect after form post URL

Specify URL to redirect the form post parameters to.

amster attribute: redirectAfterFormPostURI

Scope Delimiter

The delimiter used by an auth server to separate scopes.

amster attribute: scopeDelimiter

OAuth Scopes

List of user profile properties

According to the OAuth 2.0 Authorization Framework that the client application requires. The list depends on the permissions that the resource owner grants to the client application. Some authorization servers use non-standard separators for scopes.

For example, you might set this property to: profile

Default value: profile

amster attribute: scopes

Client Authentication Method

Field used to define how the client would be identified by the social provider.

Default value: CLIENT_SECRET_POST

amster attribute: clientAuthenticationMethod

PKCE Method

The PKCE transformation method to use when making requests to the authorization endpoint.

Default value: S256

amster attribute: pkceMethod

JWKS URI Endpoint

The JWKS URL endpoint for the RP to use when encrypting or validating

amster attribute: jwksUriEndpoint

JWT Signing Algorithm

The signing algorithm to use when signing the client assertion and request object jwt sent to social provider.

amster attribute: jwtSigningAlgorithm

JWT Encryption Algorithm

The encryption algorithm to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionAlgorithm

JWT Encryption Method

The encryption method to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionMethod

Private Key JWT Expiration Time (seconds)

The expiration time on or after which the private key JWT must not be accepted for processing.

Default value: 600

amster attribute: privateKeyJwtExpTime

Response Mode

Informs the Authorization Server of the mechanism to use for returning Authorization Response parameters.

Default value: DEFAULT

amster attribute: responseMode

UI Config Properties

Mapping of display properties to be defined and consumed by the UI.

amster attribute: uiConfig

Transform Script

A script that takes the raw profile object as input and outputs the normalized profile object.

Default value: 6b3cfd48-62d3-48ff-a96f-fe8f3a22ab30

amster attribute: transform

facebookConfig

Enabled

Default value: true

amster attribute: enabled

Auth ID Key

Field used to identify a user by the social provider.

For example, you might set this property to: id

Default value: id

amster attribute: authenticationIdKey

Client ID

OAuth client_id parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientId

Client Secret

OAuth client_secret parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientSecret

Authentication Endpoint URL

OAuth authentication endpoint URL

This is the URL endpoint for OAuth authentication provided by the OAuth Identity Provider.

For example, you might set this property to: https://www.facebook.com/dialog/oauth

amster attribute: authorizationEndpoint

Access Token Endpoint URL

OAuth access token endpoint URL This is the URL endpoint for access token retrieval provided by the OAuth Identity Provider.Refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-3.2), section 3.2.

For example, you might set this property to: https://graph.facebook.com/v2.7/oauth/access_token

amster attribute: tokenEndpoint

User Profile Service URL

User profile information URL

This URL endpoint provides user profile information and is provided by the OAuth Identity Provider NB This URL should return JSON objects in response.

amster attribute: userInfoEndpoint

Token Introspection Endpoint URL

OAuth Token Introspection endpoint URL This is the URL endpoint for access token validation using the OAuth Identity Provider.Refer to the RFC 7662 (http://tools.ietf.org/html/rfc7662).

For example, you might set this property to: https://graph.facebook.com/debug_token

amster attribute: introspectEndpoint

Redirect URL

amster attribute: redirectURI

Redirect after form post URL

Specify URL to redirect the form post parameters to.

amster attribute: redirectAfterFormPostURI

Scope Delimiter

The delimiter used by an auth server to separate scopes.

amster attribute: scopeDelimiter

OAuth Scopes

List of user profile properties

According to the OAuth 2.0 Authorization Framework that the client application requires. The list depends on the permissions that the resource owner grants to the client application. Some authorization servers use non-standard separators for scopes.

For example, you might set this property to: email, user_birthday

Default value:

email
user_birthday

amster attribute: scopes

Client Authentication Method

Field used to define how the client would be identified by the social provider.

Default value: CLIENT_SECRET_POST

amster attribute: clientAuthenticationMethod

PKCE Method

The PKCE transformation method to use when making requests to the authorization endpoint.

Default value: S256

amster attribute: pkceMethod

JWKS URI Endpoint

The JWKS URL endpoint for the RP to use when encrypting or validating

amster attribute: jwksUriEndpoint

JWT Signing Algorithm

The signing algorithm to use when signing the client assertion and request object jwt sent to social provider.

amster attribute: jwtSigningAlgorithm

JWT Encryption Algorithm

The encryption algorithm to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionAlgorithm

JWT Encryption Method

The encryption method to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionMethod

Private Key JWT Expiration Time (seconds)

The expiration time on or after which the private key JWT must not be accepted for processing.

Default value: 600

amster attribute: privateKeyJwtExpTime

Response Mode

Informs the Authorization Server of the mechanism to use for returning Authorization Response parameters.

Default value: DEFAULT

amster attribute: responseMode

UI Config Properties

Mapping of display properties to be defined and consumed by the UI.

amster attribute: uiConfig

Transform Script

A script that takes the raw profile object as input and outputs the normalized profile object.

Default value: bae1d54a-e97d-4997-aa5d-c027f21af82c

amster attribute: transform

weChatConfig

Enabled

Default value: true

amster attribute: enabled

Auth ID Key

Field used to identify a user by the social provider.

For example, you might set this property to: openid

Default value: openid

amster attribute: authenticationIdKey

Client ID

OAuth client_id parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientId

Client Secret

OAuth client_secret parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientSecret

Authentication Endpoint URL

OAuth authentication endpoint URL

This is the URL endpoint for OAuth authentication provided by the OAuth Identity Provider.

For example, you might set this property to: https://open.weixin.qq.com/connect/qrconnect

amster attribute: authorizationEndpoint

Access Token Endpoint URL

OAuth access token endpoint URL This is the URL endpoint for access token retrieval provided by the OAuth Identity Provider.Refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-3.2), section 3.2.

For example, you might set this property to: https://api.wechat.com/sns/oauth2/access_token

amster attribute: tokenEndpoint

User Profile Service URL

User profile information URL

This URL endpoint provides user profile information and is provided by the OAuth Identity Provider NB This URL should return JSON objects in response.

For example, you might set this property to: https://api.wechat.com/sns/userinfo

amster attribute: userInfoEndpoint

Token Introspection Endpoint URL

OAuth Token Introspection endpoint URL This is the URL endpoint for access token validation using the OAuth Identity Provider.Refer to the RFC 7662 (http://tools.ietf.org/html/rfc7662).

amster attribute: introspectEndpoint

Redirect URL

amster attribute: redirectURI

Redirect after form post URL

Specify URL to redirect the form post parameters to.

amster attribute: redirectAfterFormPostURI

Scope Delimiter

The delimiter used by an auth server to separate scopes.

amster attribute: scopeDelimiter

OAuth Scopes

List of user profile properties

According to the OAuth 2.0 Authorization Framework that the client application requires. The list depends on the permissions that the resource owner grants to the client application. Some authorization servers use non-standard separators for scopes.

For example, you might set this property to: snsapi_login

Default value: snsapi_login

amster attribute: scopes

Client Authentication Method

Field used to define how the client would be identified by the social provider.

Default value: CLIENT_SECRET_POST

amster attribute: clientAuthenticationMethod

PKCE Method

The PKCE transformation method to use when making requests to the authorization endpoint.

Default value: S256

amster attribute: pkceMethod

Refresh Token Endpoint

The endpoint for obtaining a refresh token.

amster attribute: refreshTokenEndpoint

JWKS URI Endpoint

The JWKS URL endpoint for the RP to use when encrypting or validating

amster attribute: jwksUriEndpoint

JWT Signing Algorithm

The signing algorithm to use when signing the client assertion and request object jwt sent to social provider.

amster attribute: jwtSigningAlgorithm

JWT Encryption Algorithm

The encryption algorithm to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionAlgorithm

JWT Encryption Method

The encryption method to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionMethod

Private Key JWT Expiration Time (seconds)

The expiration time on or after which the private key JWT must not be accepted for processing.

Default value: 600

amster attribute: privateKeyJwtExpTime

Response Mode

Informs the Authorization Server of the mechanism to use for returning Authorization Response parameters.

Default value: DEFAULT

amster attribute: responseMode

UI Config Properties

Mapping of display properties to be defined and consumed by the UI.

amster attribute: uiConfig

Transform Script

A script that takes the raw profile object as input and outputs the normalized profile object.

Default value: 472534ec-a25f-468d-a606-3fb1935190df

amster attribute: transform

yahooConfig

Enabled

Default value: true

amster attribute: enabled

Auth ID Key

Field used to identify a user by the social provider.

For example, you might set this property to: sub

Default value: sub

amster attribute: authenticationIdKey

Client ID

OAuth client_id parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientId

Client Secret

OAuth client_secret parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientSecret

Authentication Endpoint URL

OAuth authentication endpoint URL

This is the URL endpoint for OAuth authentication provided by the OAuth Identity Provider.

For example, you might set this property to: https://api.login.yahoo.com/oauth2/request_auth

amster attribute: authorizationEndpoint

Access Token Endpoint URL

OAuth access token endpoint URL This is the URL endpoint for access token retrieval provided by the OAuth Identity Provider.Refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-3.2), section 3.2.

For example, you might set this property to: https://api.login.yahoo.com/oauth2/get_token

amster attribute: tokenEndpoint

User Profile Service URL

User profile information URL

This URL endpoint provides user profile information and is provided by the OAuth Identity Provider NB This URL should return JSON objects in response.

amster attribute: userInfoEndpoint

Token Introspection Endpoint URL

OAuth Token Introspection endpoint URL This is the URL endpoint for access token validation using the OAuth Identity Provider.Refer to the RFC 7662 (http://tools.ietf.org/html/rfc7662).

amster attribute: introspectEndpoint

Redirect URL

amster attribute: redirectURI

Redirect after form post URL

Specify URL to redirect the form post parameters to.

amster attribute: redirectAfterFormPostURI

Scope Delimiter

The delimiter used by an auth server to separate scopes.

amster attribute: scopeDelimiter

OAuth Scopes

List of user profile properties

According to the OAuth 2.0 Authorization Framework that the client application requires. The list depends on the permissions that the resource owner grants to the client application. Some authorization servers use non-standard separators for scopes.

For example, you might set this property to: openid, sdpp-w

Default value:

openid
sdpp-w

amster attribute: scopes

Client Authentication Method

Field used to define how the client would be identified by the social provider.

Default value: CLIENT_SECRET_POST

amster attribute: clientAuthenticationMethod

PKCE Method

The PKCE transformation method to use when making requests to the authorization endpoint.

Default value: S256

amster attribute: pkceMethod

Request Parameter JWT Option

Choose how Request Parameter JWTs will be sent to the OIDC Provider. Choose REFERENCE for OpenID Connect Request Parameter JWTs to be passed by reference. Choose VALUE for OpenID Connect Request Parameter JWTs to be passed as single, self-contained parameters.Choose NONE to specify that Request Parameter JWTs are not used.

Default value: NONE

amster attribute: jwtRequestParameterOption

Encrypt Request Parameter JWT

Enable the option to send an encrypted request parameter JWT.

Default value: false

amster attribute: encryptJwtRequestParameter

ACR Values

Space-separated string that specifies the acr values that the Authorization Server is being requested to use for processing this Authentication Request, with the values appearing in order of preference.

amster attribute: acrValues

Well Known Endpoint

The endpoint for retrieving a list of OAuth/OIDC endpoints.

For example, you might set this property to: https://api.login.yahoo.com/.well-known/openid-configuration

amster attribute: wellKnownEndpoint

Request Object Audience

The intended audience of the request object. If unspecified, the issuer value will be used.

amster attribute: requestObjectAudience

OP Encrypts ID Tokens

Whether the OP encrypts ID Tokens. Will determine which resolver to use.

Default value: false

amster attribute: encryptedIdTokens

Issuer

The Issuer of OIDC ID Tokens.

For example, you might set this property to: https://api.login.yahoo.com

amster attribute: issuer

Enable Native Nonce

When enabled, the Identity Provider Native SDK MUST include a nonce Claim in the ID Token with the Claim value being the nonce value sent in the Authentication Request. Enabled by default.

Default value: true

amster attribute: enableNativeNonce

User Info Response Format

The expected format of UserInfo responses. Dictates how AM will process the response. The expected format must match the actual format.

Default value: JSON

amster attribute: userInfoResponseType

JWKS URI Endpoint

The JWKS URL endpoint for the RP to use when encrypting or validating

amster attribute: jwksUriEndpoint

JWT Signing Algorithm

The signing algorithm to use when signing the client assertion and request object jwt sent to social provider.

amster attribute: jwtSigningAlgorithm

JWT Encryption Algorithm

The encryption algorithm to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionAlgorithm

JWT Encryption Method

The encryption method to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionMethod

Private Key JWT Expiration Time (seconds)

The expiration time on or after which the private key JWT must not be accepted for processing.

Default value: 600

amster attribute: privateKeyJwtExpTime

Response Mode

Informs the Authorization Server of the mechanism to use for returning Authorization Response parameters.

Default value: DEFAULT

amster attribute: responseMode

UI Config Properties

Mapping of display properties to be defined and consumed by the UI.

amster attribute: uiConfig

Transform Script

A script that takes the raw profile object as input and outputs the normalized profile object.

Default value: 424da748-82cc-4b54-be6f-82bd64d82a74

amster attribute: transform

oidcConfig

Enabled

Default value: true

amster attribute: enabled

Auth ID Key

Field used to identify a user by the social provider.

For example, you might set this property to: sub

amster attribute: authenticationIdKey

Client ID

OAuth client_id parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientId

Client Secret

OAuth client_secret parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientSecret

Authentication Endpoint URL

OAuth authentication endpoint URL

This is the URL endpoint for OAuth authentication provided by the OAuth Identity Provider.

amster attribute: authorizationEndpoint

Access Token Endpoint URL

OAuth access token endpoint URL This is the URL endpoint for access token retrieval provided by the OAuth Identity Provider.Refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-3.2), section 3.2.

amster attribute: tokenEndpoint

User Profile Service URL

User profile information URL

This URL endpoint provides user profile information and is provided by the OAuth Identity Provider NB This URL should return JSON objects in response.

amster attribute: userInfoEndpoint

Token Introspection Endpoint URL

OAuth Token Introspection endpoint URL This is the URL endpoint for access token validation using the OAuth Identity Provider.Refer to the RFC 7662 (http://tools.ietf.org/html/rfc7662).

amster attribute: introspectEndpoint

Redirect URL

amster attribute: redirectURI

Redirect after form post URL

Specify URL to redirect the form post parameters to.

amster attribute: redirectAfterFormPostURI

Scope Delimiter

The delimiter used by an auth server to separate scopes.

amster attribute: scopeDelimiter

OAuth Scopes

List of user profile properties

According to the OAuth 2.0 Authorization Framework that the client application requires. The list depends on the permissions that the resource owner grants to the client application. Some authorization servers use non-standard separators for scopes.

amster attribute: scopes

Client Authentication Method

Field used to define how the client would be identified by the social provider.

Default value: CLIENT_SECRET_POST

amster attribute: clientAuthenticationMethod

PKCE Method

The PKCE transformation method to use when making requests to the authorization endpoint.

Default value: S256

amster attribute: pkceMethod

Request Parameter JWT Option

Choose how Request Parameter JWTs will be sent to the OIDC Provider. Choose REFERENCE for OpenID Connect Request Parameter JWTs to be passed by reference. Choose VALUE for OpenID Connect Request Parameter JWTs to be passed as single, self-contained parameters.Choose NONE to specify that Request Parameter JWTs are not used.

Default value: NONE

amster attribute: jwtRequestParameterOption

Encrypt Request Parameter JWT

Enable the option to send an encrypted request parameter JWT.

Default value: false

amster attribute: encryptJwtRequestParameter

ACR Values

Space-separated string that specifies the acr values that the Authorization Server is being requested to use for processing this Authentication Request, with the values appearing in order of preference.

amster attribute: acrValues

Well Known Endpoint

The endpoint for retrieving a list of OAuth/OIDC endpoints.

amster attribute: wellKnownEndpoint

Request Object Audience

The intended audience of the request object. If unspecified, the issuer value will be used.

amster attribute: requestObjectAudience

OP Encrypts ID Tokens

Whether the OP encrypts ID Tokens. Will determine which resolver to use.

amster attribute: encryptedIdTokens

Issuer

The Issuer of OIDC ID Tokens.

amster attribute: issuer

Enable Native Nonce

When enabled, the Identity Provider Native SDK MUST include a nonce Claim in the ID Token with the Claim value being the nonce value sent in the Authentication Request. Enabled by default.

Default value: true

amster attribute: enableNativeNonce

User Info Response Format

The expected format of UserInfo responses. Dictates how AM will process the response. The expected format must match the actual format.

Default value: JSON

amster attribute: userInfoResponseType

JWKS URI Endpoint

The JWKS URL endpoint for the RP to use when encrypting or validating

amster attribute: jwksUriEndpoint

JWT Signing Algorithm

The signing algorithm to use when signing the client assertion and request object jwt sent to social provider.

amster attribute: jwtSigningAlgorithm

JWT Encryption Algorithm

The encryption algorithm to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionAlgorithm

JWT Encryption Method

The encryption method to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionMethod

Private Key JWT Expiration Time (seconds)

The expiration time on or after which the private key JWT must not be accepted for processing.

Default value: 600

amster attribute: privateKeyJwtExpTime

Response Mode

Informs the Authorization Server of the mechanism to use for returning Authorization Response parameters.

Default value: DEFAULT

amster attribute: responseMode

UI Config Properties

Mapping of display properties to be defined and consumed by the UI.

amster attribute: uiConfig

Transform Script

A script that takes the raw profile object as input and outputs the normalized profile object.

amster attribute: transform

linkedInConfig

Enabled

Default value: true

amster attribute: enabled

Auth ID Key

Field used to identify a user by the social provider.

For example, you might set this property to: id

Default value: id

amster attribute: authenticationIdKey

Client ID

OAuth client_id parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientId

Client Secret

OAuth client_secret parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientSecret

Authentication Endpoint URL

OAuth authentication endpoint URL

This is the URL endpoint for OAuth authentication provided by the OAuth Identity Provider.

For example, you might set this property to: https://www.linkedin.com/oauth/v2/authorization

amster attribute: authorizationEndpoint

Access Token Endpoint URL

OAuth access token endpoint URL This is the URL endpoint for access token retrieval provided by the OAuth Identity Provider.Refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-3.2), section 3.2.

For example, you might set this property to: https://www.linkedin.com/oauth/v2/accessToken

amster attribute: tokenEndpoint

User Profile Service URL

User profile information URL

This URL endpoint provides user profile information and is provided by the OAuth Identity Provider NB This URL should return JSON objects in response.

amster attribute: userInfoEndpoint

Token Introspection Endpoint URL

OAuth Token Introspection endpoint URL This is the URL endpoint for access token validation using the OAuth Identity Provider.Refer to the RFC 7662 (http://tools.ietf.org/html/rfc7662).

For example, you might set this property to: https://www.linkedin.com/oauth/v2/introspectToken

amster attribute: introspectEndpoint

Redirect URL

amster attribute: redirectURI

Redirect after form post URL

Specify URL to redirect the form post parameters to.

amster attribute: redirectAfterFormPostURI

Scope Delimiter

The delimiter used by an auth server to separate scopes.

amster attribute: scopeDelimiter

OAuth Scopes

List of user profile properties

According to the OAuth 2.0 Authorization Framework that the client application requires. The list depends on the permissions that the resource owner grants to the client application. Some authorization servers use non-standard separators for scopes.

For example, you might set this property to: r_liteprofile, r_emailaddress

Default value:

r_liteprofile
r_emailaddress

amster attribute: scopes

Client Authentication Method

Field used to define how the client would be identified by the social provider.

Default value: CLIENT_SECRET_POST

amster attribute: clientAuthenticationMethod

PKCE Method

The PKCE transformation method to use when making requests to the authorization endpoint.

Default value: S256

amster attribute: pkceMethod

Email Address Endpoint

The endpoint for retrieving the email address.

amster attribute: emailAddressEndpoint

JWKS URI Endpoint

The JWKS URL endpoint for the RP to use when encrypting or validating

amster attribute: jwksUriEndpoint

JWT Signing Algorithm

The signing algorithm to use when signing the client assertion and request object jwt sent to social provider.

amster attribute: jwtSigningAlgorithm

JWT Encryption Algorithm

The encryption algorithm to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionAlgorithm

JWT Encryption Method

The encryption method to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionMethod

Private Key JWT Expiration Time (seconds)

The expiration time on or after which the private key JWT must not be accepted for processing.

Default value: 600

amster attribute: privateKeyJwtExpTime

Response Mode

Informs the Authorization Server of the mechanism to use for returning Authorization Response parameters.

Default value: DEFAULT

amster attribute: responseMode

UI Config Properties

Mapping of display properties to be defined and consumed by the UI.

amster attribute: uiConfig

Transform Script

A script that takes the raw profile object as input and outputs the normalized profile object.

Default value: 8862ca8f-7770-4af5-a888-ac0df0947f36

amster attribute: transform

salesforceConfig

Enabled

Default value: true

amster attribute: enabled

Auth ID Key

Field used to identify a user by the social provider.

For example, you might set this property to: user_id

Default value: user_id

amster attribute: authenticationIdKey

Client ID

OAuth client_id parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientId

Client Secret

OAuth client_secret parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientSecret

Authentication Endpoint URL

OAuth authentication endpoint URL

This is the URL endpoint for OAuth authentication provided by the OAuth Identity Provider.

For example, you might set this property to: https://login.salesforce.com/services/oauth2/authorize

amster attribute: authorizationEndpoint

Access Token Endpoint URL

OAuth access token endpoint URL This is the URL endpoint for access token retrieval provided by the OAuth Identity Provider.Refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-3.2), section 3.2.

For example, you might set this property to: https://login.salesforce.com/services/oauth2/token

amster attribute: tokenEndpoint

User Profile Service URL

User profile information URL

This URL endpoint provides user profile information and is provided by the OAuth Identity Provider NB This URL should return JSON objects in response.

For example, you might set this property to: https://login.salesforce.com/services/oauth2/userinfo

amster attribute: userInfoEndpoint

Token Introspection Endpoint URL

OAuth Token Introspection endpoint URL This is the URL endpoint for access token validation using the OAuth Identity Provider.Refer to the RFC 7662 (http://tools.ietf.org/html/rfc7662).

For example, you might set this property to: https://login.salesforce.com/services/oauth2/introspect

amster attribute: introspectEndpoint

Redirect URL

amster attribute: redirectURI

Redirect after form post URL

Specify URL to redirect the form post parameters to.

amster attribute: redirectAfterFormPostURI

Scope Delimiter

The delimiter used by an auth server to separate scopes.

amster attribute: scopeDelimiter

OAuth Scopes

List of user profile properties

According to the OAuth 2.0 Authorization Framework that the client application requires. The list depends on the permissions that the resource owner grants to the client application. Some authorization servers use non-standard separators for scopes.

For example, you might set this property to: id, api, web

Default value:

id
api
web

amster attribute: scopes

Client Authentication Method

Field used to define how the client would be identified by the social provider.

Default value: CLIENT_SECRET_POST

amster attribute: clientAuthenticationMethod

PKCE Method

The PKCE transformation method to use when making requests to the authorization endpoint.

Default value: S256

amster attribute: pkceMethod

JWKS URI Endpoint

The JWKS URL endpoint for the RP to use when encrypting or validating

amster attribute: jwksUriEndpoint

JWT Signing Algorithm

The signing algorithm to use when signing the client assertion and request object jwt sent to social provider.

amster attribute: jwtSigningAlgorithm

JWT Encryption Algorithm

The encryption algorithm to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionAlgorithm

JWT Encryption Method

The encryption method to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionMethod

Private Key JWT Expiration Time (seconds)

The expiration time on or after which the private key JWT must not be accepted for processing.

Default value: 600

amster attribute: privateKeyJwtExpTime

Response Mode

Informs the Authorization Server of the mechanism to use for returning Authorization Response parameters.

Default value: DEFAULT

amster attribute: responseMode

UI Config Properties

Mapping of display properties to be defined and consumed by the UI.

amster attribute: uiConfig

Transform Script

A script that takes the raw profile object as input and outputs the normalized profile object.

Default value: 312e951f-70c5-49d2-a9ae-93aef909d5df

amster attribute: transform

wordpressConfig

Enabled

Default value: true

amster attribute: enabled

Auth ID Key

Field used to identify a user by the social provider.

For example, you might set this property to: username

Default value: username

amster attribute: authenticationIdKey

Client ID

OAuth client_id parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientId

Client Secret

OAuth client_secret parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientSecret

Authentication Endpoint URL

OAuth authentication endpoint URL

This is the URL endpoint for OAuth authentication provided by the OAuth Identity Provider.

For example, you might set this property to: https://public-api.wordpress.com/oauth2/authorize

amster attribute: authorizationEndpoint

Access Token Endpoint URL

OAuth access token endpoint URL This is the URL endpoint for access token retrieval provided by the OAuth Identity Provider.Refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-3.2), section 3.2.

For example, you might set this property to: https://public-api.wordpress.com/oauth2/token

amster attribute: tokenEndpoint

User Profile Service URL

User profile information URL

This URL endpoint provides user profile information and is provided by the OAuth Identity Provider NB This URL should return JSON objects in response.

For example, you might set this property to: https://public-api.wordpress.com/rest/v1.1/me/

amster attribute: userInfoEndpoint

Token Introspection Endpoint URL

OAuth Token Introspection endpoint URL This is the URL endpoint for access token validation using the OAuth Identity Provider.Refer to the RFC 7662 (http://tools.ietf.org/html/rfc7662).

amster attribute: introspectEndpoint

Redirect URL

amster attribute: redirectURI

Redirect after form post URL

Specify URL to redirect the form post parameters to.

amster attribute: redirectAfterFormPostURI

Scope Delimiter

The delimiter used by an auth server to separate scopes.

amster attribute: scopeDelimiter

OAuth Scopes

List of user profile properties

According to the OAuth 2.0 Authorization Framework that the client application requires. The list depends on the permissions that the resource owner grants to the client application. Some authorization servers use non-standard separators for scopes.

For example, you might set this property to: auth

Default value: auth

amster attribute: scopes

Client Authentication Method

Field used to define how the client would be identified by the social provider.

Default value: CLIENT_SECRET_POST

amster attribute: clientAuthenticationMethod

PKCE Method

The PKCE transformation method to use when making requests to the authorization endpoint.

Default value: S256

amster attribute: pkceMethod

JWKS URI Endpoint

The JWKS URL endpoint for the RP to use when encrypting or validating

amster attribute: jwksUriEndpoint

JWT Signing Algorithm

The signing algorithm to use when signing the client assertion and request object jwt sent to social provider.

amster attribute: jwtSigningAlgorithm

JWT Encryption Algorithm

The encryption algorithm to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionAlgorithm

JWT Encryption Method

The encryption method to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionMethod

Private Key JWT Expiration Time (seconds)

The expiration time on or after which the private key JWT must not be accepted for processing.

Default value: 600

amster attribute: privateKeyJwtExpTime

Response Mode

Informs the Authorization Server of the mechanism to use for returning Authorization Response parameters.

Default value: DEFAULT

amster attribute: responseMode

UI Config Properties

Mapping of display properties to be defined and consumed by the UI.

amster attribute: uiConfig

Transform Script

A script that takes the raw profile object as input and outputs the normalized profile object.

Default value: 91d197de-5916-4dca-83b5-9a4df26e7159

amster attribute: transform

microsoftConfig

Enabled

Default value: true

amster attribute: enabled

Auth ID Key

Field used to identify a user by the social provider.

For example, you might set this property to: id

Default value: id

amster attribute: authenticationIdKey

Client ID

OAuth client_id parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientId

Client Secret

OAuth client_secret parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientSecret

Authentication Endpoint URL

OAuth authentication endpoint URL

This is the URL endpoint for OAuth authentication provided by the OAuth Identity Provider.

For example, you might set this property to: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

amster attribute: authorizationEndpoint

Access Token Endpoint URL

OAuth access token endpoint URL This is the URL endpoint for access token retrieval provided by the OAuth Identity Provider.Refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-3.2), section 3.2.

For example, you might set this property to: https://login.microsoftonline.com/common/oauth2/v2.0/token

amster attribute: tokenEndpoint

User Profile Service URL

User profile information URL

This URL endpoint provides user profile information and is provided by the OAuth Identity Provider NB This URL should return JSON objects in response.

For example, you might set this property to: https://graph.microsoft.com/v1.0/me

amster attribute: userInfoEndpoint

Token Introspection Endpoint URL

OAuth Token Introspection endpoint URL This is the URL endpoint for access token validation using the OAuth Identity Provider.Refer to the RFC 7662 (http://tools.ietf.org/html/rfc7662).

amster attribute: introspectEndpoint

Redirect URL

amster attribute: redirectURI

Redirect after form post URL

Specify URL to redirect the form post parameters to.

amster attribute: redirectAfterFormPostURI

Scope Delimiter

The delimiter used by an auth server to separate scopes.

amster attribute: scopeDelimiter

OAuth Scopes

List of user profile properties

According to the OAuth 2.0 Authorization Framework that the client application requires. The list depends on the permissions that the resource owner grants to the client application. Some authorization servers use non-standard separators for scopes.

For example, you might set this property to: User.Read

Default value: User.Read

amster attribute: scopes

Client Authentication Method

Field used to define how the client would be identified by the social provider.

Default value: CLIENT_SECRET_POST

amster attribute: clientAuthenticationMethod

PKCE Method

The PKCE transformation method to use when making requests to the authorization endpoint.

Default value: S256

amster attribute: pkceMethod

JWKS URI Endpoint

The JWKS URL endpoint for the RP to use when encrypting or validating

amster attribute: jwksUriEndpoint

JWT Signing Algorithm

The signing algorithm to use when signing the client assertion and request object jwt sent to social provider.

amster attribute: jwtSigningAlgorithm

JWT Encryption Algorithm

The encryption algorithm to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionAlgorithm

JWT Encryption Method

The encryption method to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionMethod

Private Key JWT Expiration Time (seconds)

The expiration time on or after which the private key JWT must not be accepted for processing.

Default value: 600

amster attribute: privateKeyJwtExpTime

Response Mode

Informs the Authorization Server of the mechanism to use for returning Authorization Response parameters.

Default value: DEFAULT

amster attribute: responseMode

UI Config Properties

Mapping of display properties to be defined and consumed by the UI.

amster attribute: uiConfig

Transform Script

A script that takes the raw profile object as input and outputs the normalized profile object.

Default value: 73cecbfc-dad0-4395-be6a-6858ee3a80e5

amster attribute: transform

vkConfig

Enabled

Default value: true

amster attribute: enabled

Auth ID Key

Field used to identify a user by the social provider.

For example, you might set this property to: sub

Default value: id

amster attribute: authenticationIdKey

Client ID

OAuth client_id parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientId

Client Secret

OAuth client_secret parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientSecret

Authentication Endpoint URL

OAuth authentication endpoint URL

This is the URL endpoint for OAuth authentication provided by the OAuth Identity Provider.

For example, you might set this property to: https://oauth.vk.com/authorize

amster attribute: authorizationEndpoint

Access Token Endpoint URL

OAuth access token endpoint URL This is the URL endpoint for access token retrieval provided by the OAuth Identity Provider.Refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-3.2), section 3.2.

For example, you might set this property to: https://oauth.vk.com/access_token

amster attribute: tokenEndpoint

User Profile Service URL

User profile information URL

This URL endpoint provides user profile information and is provided by the OAuth Identity Provider NB This URL should return JSON objects in response.

For example, you might set this property to: https://api.vk.com/method/users.get?fields=photo_50

amster attribute: userInfoEndpoint

Token Introspection Endpoint URL

OAuth Token Introspection endpoint URL This is the URL endpoint for access token validation using the OAuth Identity Provider.Refer to the RFC 7662 (http://tools.ietf.org/html/rfc7662).

amster attribute: introspectEndpoint

Redirect URL

amster attribute: redirectURI

Redirect after form post URL

Specify URL to redirect the form post parameters to.

amster attribute: redirectAfterFormPostURI

Scope Delimiter

The delimiter used by an auth server to separate scopes.

amster attribute: scopeDelimiter

OAuth Scopes

List of user profile properties

According to the OAuth 2.0 Authorization Framework that the client application requires. The list depends on the permissions that the resource owner grants to the client application. Some authorization servers use non-standard separators for scopes.

For example, you might set this property to: email

Default value: email

amster attribute: scopes

Client Authentication Method

Field used to define how the client would be identified by the social provider.

Default value: CLIENT_SECRET_POST

amster attribute: clientAuthenticationMethod

PKCE Method

The PKCE transformation method to use when making requests to the authorization endpoint.

Default value: S256

amster attribute: pkceMethod

API Version

Version of the applicable VKontakte API.

Default value: 5.73

amster attribute: apiVersion

JWKS URI Endpoint

The JWKS URL endpoint for the RP to use when encrypting or validating

amster attribute: jwksUriEndpoint

JWT Signing Algorithm

The signing algorithm to use when signing the client assertion and request object jwt sent to social provider.

amster attribute: jwtSigningAlgorithm

JWT Encryption Algorithm

The encryption algorithm to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionAlgorithm

JWT Encryption Method

The encryption method to use when encrypting the client assertion and request object jwt sent to social provider.

amster attribute: jwtEncryptionMethod

Private Key JWT Expiration Time (seconds)

The expiration time on or after which the private key JWT must not be accepted for processing.

Default value: 600

amster attribute: privateKeyJwtExpTime

Response Mode

Informs the Authorization Server of the mechanism to use for returning Authorization Response parameters.

Default value: DEFAULT

amster attribute: responseMode

UI Config Properties

Mapping of display properties to be defined and consumed by the UI.

amster attribute: uiConfig

Transform Script

A script that takes the raw profile object as input and outputs the normalized profile object.

Default value: 403cf226-6051-4368-8b72-9ba14f9a5140

amster attribute: transform

twitterConfig

Enabled

Default value: true

amster attribute: enabled

Auth ID Key

Field used to identify a user by the social provider.

For example, you might set this property to: id_str

Default value: id_str

amster attribute: authenticationIdKey

Client ID

OAuth client_id parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientId

Client Secret

OAuth client_secret parameter

For more information on the OAuth client_id parameter refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-2.3.1), section 2.3.1.

amster attribute: clientSecret

Authentication Endpoint URL

OAuth authentication endpoint URL

This is the URL endpoint for OAuth authentication provided by the OAuth Identity Provider.

amster attribute: authorizationEndpoint

Access Token Endpoint URL

OAuth access token endpoint URL This is the URL endpoint for access token retrieval provided by the OAuth Identity Provider.Refer to the RFC 6749 (http://tools.ietf.org/html/rfc6749#section-3.2), section 3.2.

amster attribute: tokenEndpoint

User Profile Service URL

User profile information URL

This URL endpoint provides user profile information and is provided by the OAuth Identity Provider NB This URL should return JSON objects in response.

amster attribute: userInfoEndpoint

Redirect URL

amster attribute: redirectURI

Request Token Endpoint

The endpoint for obtaining an access token.

amster attribute: requestTokenEndpoint

UI Config Properties

Mapping of display properties to be defined and consumed by the UI.

amster attribute: uiConfig

Transform Script

A script that takes the raw profile object as input and outputs the normalized profile object.

Default value: 8e298710-b55e-4085-a464-88a375a4004b

amster attribute: transform

Transaction Authentication Service

The following settings are available in this service:

Time to Live

The number of seconds within which the transaction must be completed.

amster attribute: timeToLive

User

Dynamic Attributes

The following settings appear on the Dynamic Attributes tab:

User Preferred Timezone

Time zone for accessing AM UI .

amster attribute: preferredTimezone

Administrator DN Starting View

Specifies the DN for the initial screen when the AM administrator successfully logs in to the AM Admin UI.

amster attribute: adminDNStartingView

Default User Status

Inactive users cannot authenticate, though AM stores their profiles.

The possible values for this property are:

  • Active

  • Inactive

amster attribute: defaultUserStatus

Self Service Trees

Realm Attributes

The following settings appear on the Realm Attributes tab:

Enabled

amster attribute: enabled

Tree Mapping

The following settings appear on the Tree Mapping tab:

Validation Service

The following settings are available in this service:

Valid goto URL Resources

List of valid goto URL resources.

Specifies a list of valid URLs for the goto and gotoOnFail query string parameters. AM only redirects a user after log in or log out to a URL in this list. If the URL is not in the list, AM redirects to either the user profile page, or the administration console. If this property is not set, AM will only allow URLs that match its domain; for example, domain-of-am-instance.com. Use the * wildcard to match all characters except ?.

Examples:

amster attribute: validGotoDestinations

WebAuthn Profile Encryption Service

The following settings are available in this service:

Profile Storage Attribute

The user’s attribute in which to store WebAuthn profiles.

amster attribute: webauthnAttrName

Device Profile Encryption Scheme

Encryption scheme to use to secure device profiles stored on the server.

If enabled, each device profile is encrypted using a unique random secret key using the given strength of AES encryption in CBC mode with PKCS#5 padding. An HMAC-SHA of the given strength (truncated to half-size) is used to ensure integrity protection and authenticated encryption. The unique random key is encrypted with the given RSA key pair and stored with the device profile.

Note: AES-256 may require installation of the JCE Unlimited Strength policy files.

The possible values for this property are:

  • Label: AES-256/HMAC-SHA-512 with RSA Key Wrapping (Value: RSAES_AES256CBC_HS512)

  • Label: AES-128/HMAC-SHA-256 with RSA Key Wrapping (Value: RSAES_AES128CBC_HS256)

  • Label: No encryption of device settings. (Value: NONE)

amster attribute: authenticatorWebAuthnDeviceSettingsEncryptionScheme

Encryption Key Store

Path to the key store from which to load encryption keys.

amster attribute: authenticatorWebAuthnDeviceSettingsEncryptionKeystore

Key Store Type

Type of key store to load.

See the JDK 8 PKCS#11 Reference Guide for more details.

The possible values for this property are:

  • Label: Java Key Store (JKS). (Value: JKS)

  • Label: Java Cryptography Extension Key Store (JCEKS). (Value: JCEKS)

  • Label: PKCS#11 Hardware Crypto Storage. (Value: PKCS11)

  • Label: PKCS#12 Key Store. (Value: PKCS12)

amster attribute: authenticatorWebAuthnDeviceSettingsEncryptionKeystoreType

Key Store Password

Password to unlock the key store. This password is encrypted when it is saved in the AM configuration.

amster attribute: authenticatorWebAuthnDeviceSettingsEncryptionKeystorePassword

Key-Pair Alias

Alias of the certificate and private key in the key store. The private key is used to encrypt and decrypt device profiles.

amster attribute: authenticatorWebAuthnDeviceSettingsEncryptionKeystoreKeyPairAlias

Private Key Password

Password to unlock the private key.

amster attribute: authenticatorWebAuthnDeviceSettingsEncryptionKeystorePrivateKeyPassword