AuthnMethodOAuth

OAuth authentication method configuration.

Description

Description of the configuration object

Assurance level

A numeric weight to be assigned to this authentication method. You can create authorization conditions based on these assurance level weights.

Communication URLs holder

The holder for common URL configurations of an authentication method.

Prefix for URL definitions

The prefix for URL definitions. The base URL, specified as an absolute or relative path, to which users will be directed when events occur during the authentication workflow when using this authentication method. DirX Access redirects the authenticating user to the pages specified in the following fields.

Pre-login

The URL of the page to load before the login page, relative to 'Prefix for URL definitions'.

Login

The URL of the login page where users provide credentials for form-based authentication methods, relative to 'Prefix for URL definitions'.

Login success

The URL of the page to load when authentication succeeds, relative to 'Prefix for URL definitions'.

Login failed

The URL of the page to load when authentication fails, relative to 'Prefix for URL definitions'.

Error

The URL of the page to load when an error is encountered, relative to 'Prefix for URL definitions'.

Account expired

The URL of the page to load when the user’s account has expired, relative to the 'Prefix for URL definitions'.

Account locked

The URL of the page to load when the user’s account has been locked, relative to 'Prefix for URL definitions'.

Account disabled

The URL of the page to load when the user’s account has been disabled, relative to 'Prefix for URL definitions'.

Do correlate user accounts

Whether or not the authentication service correlates user accounts in the 'User Repository' upon successful validation of provided credentials. SAML assertion based authentication at SPs should consider unchecking depending on the underlying scenario.

  • For traditional initial authentication, the correlation is made based on the login name and the LDAP attribute 'Login name attribute' that can be configured in the SubjectTemplate configuration.

  • For X.509 certificate-based authentication, the correlation details can be configured on the basis of dedicated configuration fields in AuthnMethodX509 configuration.

  • For Kerberos or NTLM-based Windows authentication, the correlation is made based on the RFC 822 login name and the 'Mail attribute' that can be configured in the SubjectTemplate configuration.

  • For federated authentication based on SAML assertions, the correlation details can be configured in specific SAML assertion interpretation templates.

Do honor validity metadata

Whether or not the authentication service considers validity metadata for example, account lifetime or locking state.

Do use attribute finder

Whether or not the authentication service invokes the server-global subject attribute finder plug-in for this authentication method. This plug-in allows you to look up supplementary information about an authenticated user that is not part of the user account against which authentication was performed and is used when information about a single user is distributed across various repositories.

SAML authentication context class reference

A value to be imprinted as SAML authentication context class reference when issuing SAML assertions for subjects that have been authenticated with this method. If the value is undefined, a default mapping to SAML-defined values is used.

Do autogenerate domain identifier and format

Whether or not to generate the authentication-method-specific domain name in the format: authentication_id@authentication_method_id.

Domain identifier

The domain identifier used for the names retrieved by this authentication method during the domain name resolution.

Domain name format

The domain name format used for the names retrieved by this authentication method during domain name resolution. The format may contain placeholders: #1 (replaced by the authentication identifier), and #2 (replaced by the domain identifier).

Do hash authentication id

Whether or not the authentication identifier is hashed before it is included into the domain name.

User Correlation Policy

To what extent is the user correlation with an existing user record in user repository for this authentication method forced. This element has priority over the Do correlate user accounts element.

  • MANDATORY: The authentication method will fail if the user correlation cannot be made.

  • OPTIONAL: The server will try to correlate the user with a user record, but if the correlation fails the method will still pass if possible.

  • NONE: No user correlation will be done.

  • Allowed Values:

    • MANDATORY

    • OPTIONAL

    • NONE

Shared credentials authentication method identifier

Reference to authentication method of the same type to share the credentials and credential-specific configuration with. If null, this method works with its own configuration and set of credentials for each user. For every authentication method the domain name configuration is being resolved which is then used during unique name resolution. Specifics for some methods are:

  • AuthnMethodPassword - number of login failures, password from the user record with its respective configuration and max number of consecutive login failures from the authentication method configuration.

  • AuthnMethodOtpRfc4226 - number of login failures, shared secret and counter from the user record and number of digits, throttling value, shared secret encoding and look ahead from the authentication method configuration.

  • AuthnMethodOtpRfc6238 - number of login failures, shared secret and time drift from the user record and number of digits, throttling value, shared secret encoding, time step seconds and time drift limit from the authentication method configuration.

Just-in-time provisioning of user record to AppRepo

Indicates whether Just-in-Time (JIT) provisioning of user records to the application repository is enabled. If enabled, a user record is automatically created in the application repository after successful authentication if it does not already exist. If disabled, authentication will not trigger the creation of a new user record if one does not exist.

Protected resource URI (required)

A unique URI describing corresponding protected resource. The parameter is compared during the access_token validation against the audience element of the OAuth access_token (using a strict string equivalence). From this reason, the URI MUST be unique within the scope of trusted OAuth Authorization Servers.

OAuth Authorization Servers metadata identifiers (required)

References to the metadata of trusted OAuth 2.0 Authorization Servers. The metadata are used during the JWT validation process claims comparison and signature verification.

User profile correlation

The name of the User Profile attribute that should be used for correlation between the User Profile objects and user accounts from the DirX Access User Repository.

User account correlation

The name of the LDAP attribute that should be used for correlation between objects from the User Profile Release Endpoint (OAuth Resource Server) and user accounts from the DirX Access User Repository.

Do sessionless SSO

Whether or not this authentication method enforces the internal subject to be part of an SSO session or not. If true, any request bound to this authentication method (typically via the PEP) takes the data about the requestor from the JWT and does not perform the traditional SSO in the sense that:

  • SSO session is not taken into account even though existing and part of the request (e.g., in the form of session cookie),

  • no new SSO session is created. The requestor data can be enriched from other sources (e.g., with persisted user account data) no matter the value of this parameter.

Do imprint roles

Whether or not to imprint roles from the OAuth token into the roles assigned to internal subject.

Do imprint groups

Whether or not to imprint groups from the OAuth token into the groups assigned to internal subject.

Crypto containers identifiers

References to cryptographic material containers. The containers serve as truststore for signature verification certificates and keystore for encryption keys.

Do require signing

Whether or not to require the JWTs to be signed.

Do require encryption

Whether or not to require the JWTs to be encrypted.

Match OAuth groups with AppRepo groups

Whether or not to match the groups in OAuth token with the Groups saved in the application repository. If true, the groups passed in the JWT claims set will be matched against groups in application repository and roles from these groups willbe imprinted into the server subject. If false, the roles will be only resolved from the JWT. In order for the groups to be resolved successfully, only the name of the groups should be sent in the token. If recursive group membership resolution is enabled in Subject Template, the parent groups and their roles will also be resolved and added to the Server Subject.

Role format

The format of the roles in the JWT. It is used to format the roles with the Domain Name to different the roles from the token from those saved in the user record in user or application repository.

Group domain name

Domain name assigned to any group resolved from the OAuth token consumed by this authentication method. This parameter enables to ensure uniqueness of groups from different sources (e.g., user repository and third-party IdPs).

Group domain format

Domain-specific format assigned to any group resolved from the OAuth token consumed by this authentication method. The format may contain placeholders: #1 (replaced by the authentication identifier), and #2 (replaced by the domain identifier). This parameter enables to ensure uniqueness of groups from different sources (e.g., user repository and third-party IdPs).