5.13.5 Configuring OAuth and OpenID Connect

NOTE:Technical Support Team supports the Access Manager setup and any app issues where the API request is sent to the correct Access Manager endpoint. Any other code changes that are needed to integrate with Access Manager are outside the scope of traditional support and need to go through the namsdk@microfocus.com channel.

The following is the sequence of the OAuth and OpenID Connect configuration:

NOTE:Use Internet Explorer 10 or later, Firefox, or Chrome for configuring OAuth 2.0.

Enabling OAuth and OpenID Connect

To use OAuth, you must enable it in Identity Server. Otherwise, the configuration will not work.

  1. Click Devices > Identity Servers > Edit.

  2. In the Enabled Protocols section, select OAuth & OpenID Connect.

  3. Click OK and update Identity Server.

NOTE:For OAuth authorization, Identity Server, and ESP must be enabled with SSL.

Extending a User Store for OAuth 2.0 Authorization Grant Information

Access Manager OAuth 2.0 implementation stores the client application information, which a user authorizes to access attributes and resources. This information is unique per user. Store it as part of a user object in the user store. If you already have an attribute, use it in Authorization Grant LDAP Attribute while defining Global Settings.

If a free attribute is unavailable, then extend the User Object schema to add a new single-valued binary (LDAP) or stream (eDirectory) attribute with a name. Access Manager stores an XML object in this attribute for each user authorization.

NOTE:The LDAP super administrator must have write access to this user attribute to allow saving the token information. Access Manager uses this attribute to revoke refresh tokens.

An example for extending the schema of a User Object in eDirectory

  1. Click to Roles and Tasks > Schema > Create Attribute.

  2. Specify Attribute Name as nidsOAuthGrant.

  3. Click Next.

  4. Select Stream under Syntax.

  5. Click Next.

  6. Select Single Valued.

  7. Click Next > Finish.

  8. Go to Roles and Tasks > Schema > Add Attribute.

  9. Select Person under Available Classes.

  10. Click OK.

  11. Move nidsOAuthGrant from Available optional attributes to Optional attributes.

  12. Click OK.

An example for extending the schema of a user object in Active Directory

  1. In Windows, Start > Run > mmc.

  2. Click File > Add/Remove Snap-in.

  3. Select Active Directory Schema and click Add.

  4. Expand Active Directory schema, then right click Attributes > Create Attribute.

  5. In Create New Attribute, specify the following:

    • Common Name: nidsOAuthGrant

    • LDAP Name: nidsOAuthGrant

    • Unique X500 Object ID: 1.3.6.1.4.1.1466.115.121.1.5

  6. Select Syntax as Octet string. Ensure that Multi-Valued is deselected.

  7. Click OK.

  8. Expand Active Directory schema, then click Classes > person.

  9. Right click person, then click Properties.

  10. Click the Attribute tab, then click Add.

  11. Select the attribute that you created (nidsOAuthGrant), then click OK.

  12. Click OK to close all property windows, then add the attribute to person class.

Sample: Extending the schema of a user object in Active Directory Lightweight Directory Services

  1. Go to Active Directory Lightweight Directory Services (AD LDS) schema.

  2. Right-click the schema name, then click New > Object.

  3. Select attributeSchema and click Next.

  4. Specify a common-name and click Next.

  5. Specify 4 for the oMSyntax attribute and click Next.

  6. Specify a LDAP-Display-Name and click Next. This value must be same as the common-name.

  7. Specify True for the isSingleValued attribute and click Next.

  8. Specify 2.5.5.10 for the attributeSyntax attribute and click Next.

  9. Specify 1.2.840.113556.1.9000.50.1 for the attributeID attribute and click Next.

  10. Click Finish.

  11. Navigate to cn=Person class, double-click to edit an attribute.

  12. Select mayContain attribute and click Edit.

  13. Specify the attribute name (common-name) and click Add > OK > Apply > OK.

  14. Right-click the Schema > Update Schema Now.

    NOTE:While creating a new user, the msDS-UserAccountDisabled attribute is set to true by default. Change the value to false.

Defining Global Settings

The Global Settings enable you to specify the default OAuth and OpenID Connect settings for the authorization server, such as issuer URL, token types, and grants.

  1. Click Devices > Identity Server > Edit > OAuth & OpenID Connect > Global Settings.

  2. The following options are available:

    Field

    Description

    Issuer

    Specify the name of the authorization server. This name is part of the ID token.

    Authorization Grant LDAP Attribute

    Specify a binary or a stream (for eDirectory) attribute that exists in the user store. For example, nidsOAuthGrant.

    The super administrator must have the write access to the specified Authorization Grant LDAP Attribute. This attribute stores user consent and the refresh token information. This attribute gets updated when Identity Server performs the following actions:

    • Issues a refresh token

    • Revokes the issued refresh token

    • Include user consent information

    For information about creating the attribute in the user store, see Extending a User Store for OAuth 2.0 Authorization Grant Information.

    NOTE:This is a mandatory field. This attribute stores the refresh token information. This information can be used later for a JWT token to check for revocation. Ensure that no other application uses this attribute.

    CORS Domains

    Select any one of the following options based on the requirement:

    • None: To deny access for requests from all domains other than the domain of the resource. The resource referred here are resources such as Javascript on the client application.

    • Allow All: To allow access for requests from any domains.

    • Limit to: To allow access for requests from only selected domains. Specify the domain with the port number. Do not specify the port if you are using port 80 or 443.

    Examples: beem://www.test.com:port, fb://app.local.url:port, https://namapp.com:port

    NOTE:Access Manager provides an access token even when the request does not include the listed domain. But, the token is validated on the following endpoints:

    • UserInfo

    • TokenInfo

    • Revocation

    • Token Introspect

    This invalidates the access token if the request comes from a different domain.

    Access-Control-Allow-Credentials Header

    Select this option to allow the Access Manager CORS filter to send the Access-Control-Allow-Credentials header with the response.

    Grant Type(s)

    Select the types of grants that the authorization server will support. Based on the grant type you select, the system selects corresponding token type by default.

    For more information about grant types, see OAuth Authorization Grant.

    Token Type(s)

    Select the types of tokens that the authorization server will support.

    • ID Token: A security token that contains claims about the authentication of an end user by an authorization server to the relying party.

    • Access Token: Includes the specific scopes and durations of granted access.

    • Refresh Token: Obtains a new access token when an Access token becomes invalid or expires.

    Require Logout Consent

    Use this option when you have configured OIDC front-channel logout for client applications. Enabling this option displays a consent message to users seeking their permission to log out from all logged-in applications. For more information, see OIDC Front-Channel Logout.

    By default, this option is enabled.

    Enable Token Revocation

    Enable this option to revoke the refresh token.

    If you do not require to revoke the refresh token, you can disable this option. When you disable this option the token information does not get saved in the authorization grant LDAP attribute.

    To revoke a refresh token, the super administrator must have the write access to the specified Authorization Grant LDAP Attribute. If you do not want to use this attribute or do not have the write access to this attribute, you must not select this option.

    NOTE:Revocation of binary tokens is not supported.

    Perform Revocation Check After

    Specify the duration in seconds. After this duration, Access Manager verifies whether the token is revoked.

    Use this option if you have configured a user store as an LDAP load balancer, which has a read-only and write-only replica. The Authorization Server reads the user attributes in LDAP for token verification. However, the token verification fails if any delay occurs in data synchronization across the user store LDAP replicas.

    Using this option, you can delay the token verification for a specific time. During this delay period, the Authorization Server will not read the user attribute in LDAP for token verification. However, it will verify other required checks.

    Logout to revoke tokens

    Select this option to revoke the refresh tokens during logout. By default, this option is disabled.

    Authorization Code Timeout

    Specify the duration in minutes after that the authorization code becomes invalid.

    Access Token and ID Token Timeout

    Specify the duration in minute after how long the Access token and ID token become invalid.

    Refresh Token Timeout

    Specify the duration in minute after how long the Refresh token becomes invalid.

    Signing Certificate

    Select a signing certificate to sign the tokens. By default test-signing certificate is assigned with hashing algorithm details. The signing keys can be retrieved from JSON Web Key Set endpoint.

    To add the external OAuth signing certificates in the certificate list, ensure that you have added the certificate in the Signing keystore of the Identity Server.

    Contracts for Resource Owner Credentials Authentication

    Select the contracts in Available contracts and move them to Contracts.

    This option allows the administrator to configure the Resource Owner flow to execute specific authentication contract.

    The order of authentication contract execution must be as follows:

    1. The acr_values in request parameter

    2. OAuth Global Setting option

    3. Default contract

    For example, if no acr_values and no global RO authentication contracts are specified, then only the default authentication contract of Identity Server is executed.

    To select a custom contract for authentication, the custom authentication class must override the cbAuthenticate method. For more information, see the Access Manager 5.0 SDK Guide.

    To configure the contract as a second-factor authentication contract, see Configuring Multi-Factor Authentication for Resource Owner Credentials Grant.

  3. Click OK.

Configuring a Resource Server

You can define settings for encrypting access tokens by adding a resource server in Identity Server. You can add a resource server based on the encryption requirement of each OAuth resource server. A resource server validates and accepts tokens sent by client applications and grant access to resources.

You can select any resource server as the default resource server. Then the tokens are issued and encrypted using the default resource server keys. If you do not select any resource server as the default resource server, then Identity Server is considered as the default resource server.

You can also modify and delete configured resource servers. Configuring a resource server consists of the following actions:

Adding a Resource Server

Adding a resource server in Access Manager (Identity Server) is required only for specifying any of the following access token encryption mechanism for a specific OAuth resource server:

  • Encrypt using Access Manager key (default)

  • Encrypt using resource server key

  • No encryption

Access and ID tokens contains scopes (user’s claims) in the form of user attributes or permissions for the clients to use the protected resource. You can configure scopes for each resource server.

When a client application requests for a token with specific scopes and the user provides the consent, Identity Server (authorization server) checks if the scope is available in any of the added resource servers. If available, the scope is added to the access token irrespective of the name of the resource server specified in the request.

Scenario 1

An administrator adds resource servers RS1 and RS2 based on the access token encryption requirement of the corresponding OAuth resource servers.

The administrator configures RS1 to use Access Manager key for encrypting access token and configures RS2 to use the resource server's key. In addition, the administrator defines the scope, Scope1 for resource server RS1 and the scope, Scope2 for resource server RS2.

Resource Server

Encryption mechanism

Scopes

RS1

Encrypt using Access Manager key

Scope1

RS2

Encrypt using resource server key

Scope2

When the client application sends a token request with scope parameter as Scope1 and resourceServer parameter as RS2, Identity Server adds Scope1 to the token with the encryption mechanism specified in RS2.

Request

Response

Parameter

Value

Scope added to token

Token encryption mechanism

resourceServer

RS2

Scope1

Encrypted using resource server, RS2 key

scope

Scope1

Scenario 2

The administrator selects RS1 as the default resource server, and configures both RS1 and RS2 to use the resource server's key to encrypt access token. The resourceServer parameter is not defined.

Resource Server

Encryption mechanism

Scopes

RS1 (default)

Encrypt using resource server key

Scope1

RS2

Encrypt using resource server key

Scope2

When the client application sends a token request, Identity Server adds Scope1 to the token with the encryption mechanism specified in RS1.

Request

Response

Parameter

Value

Scope added to token

Token encryption mechanism

scope

Scope1

Scope1

Encrypted using resource server, RS1 key

IMPORTANT:Be careful if you change the default resource sever because certain requests can fail.

For example, if you change the default resource server from RS1 to RS2, the token will be issued and encrypted using RS2 keys. Then, if a client application sends a token encrypted by RS1 keys, the token request will fail because RS1 is not the default resource server.

If you delete the default resource server, and Identity Provider is available, it becomes the default resource server. If Identity Provider is not available, the tokens are encrypted using the Access Manager keys.

When Identity Provider is the default resource server, you cannot delete it or modify the name. You can set only one resource server as the default one at a time.

Scenario 3

The administrator selects RS2 as the default resource server, and configures both RS1 and RS2 to use the resource server's key to encrypt access token.

Resource Server

Encryption mechanism

Scopes

RS1

Encrypt using resource server key

Scope1

RS2 (default)

Encrypt using resource server key

Scope2

Now, when the client application sends a token request with scope parameter as Scope1 and resourceServer parameter as RS1, Identity Server adds Scope1 to the token with the encryption mechanism specified in RS1. When defined, the resourceServer parameter is given priority over the default resource server setting.

Request

Response

Parameter

Value

Scope added to token

Token encryption mechanism

resourceServer

RS1

Scope1

Encrypted using resource server, RS1 key

scope

Scope1

Perform the following steps to add a resource server in Identity Server:

  1. Click Devices > Identity Server > Edit > OAuth & OpenID Connect > Resource Servers > New.

  2. Specify a name for the resource server.

  3. (Optional) Select Set it as the default Resource Server. When you enable this option, tokens are issued and encrypted using the default resource server keys

  4. Select the appropriate encryption method for encrypting access token. For more information about encrypting an access token, see Encrypting Access Token.

    • Do not encrypt: Select this option if you do not require encryption of Access token.

    • Encrypt using Access Manager Key: This is the default option. If you select this option, the token is encrypted and validated by using Access Manager Keys.

    • Encrypt using Resource Server Key: This option is used for encrypting a token by using encryption algorithm and keys that the resource server can use for decrypting the token.

  5. (Conditional) If you select Encrypt using Resource Server Key, specify the following details:

    For information about fields, see Encrypting the Token with the Resource server Key.

    • Resource Server Encryption Keys: Specify the resource server’s JWKS. You can also specify the URL where the resource server keys are defined.

    • Token Encryption Algorithm: Specify an algorithm available in the resource server’s JWKS for generating random symmetric key to encrypt the access token.

    • Key Encryption Algorithm: Specify the algorithm that should be used for encrypting the key of the encrypted token by using the resource server’s public key.

      Ensure that this algorithm can be used by one of the public keys in the resource server’s JWKS or the URL.

      NOTE:If the specified key encryption algorithm does not match with the value of the algorithm in Resource Server Encryption Keys, Access Manager fails to send the token.

      NOTE:You cannot configure resource server with JWKS containing kid value between 0-10 as it is used by Access Manager keys.

  6. Click Next.

    Continue with Defining Scopes for a Resource Server.

IMPORTANT:Before deleting a resource server, ensure that it is not used in any OAuth token inject policy.

Restricting the Number of Requests

You can restrict the number of users accessing a service by updating the tomcat.conf file.

Open Identity Server’s tomcat.conf and add the following parameter:

JAVA_OPTS="${JAVA_OPTS} -Dcom.novell.oauth.threshold.maxrequestsallowed=<number of requests>"

For example, JAVA_OPTS="${JAVA_OPTS} -Dcom.novell.oauth.threshold.maxrequestsallowed=10". It will not allow more than 10 requests per second.

For information about how to open and modify a file, see Modifying Configurations.

Defining Scopes for a Resource Server

A scope is a set of permissible actions that a client application can perform on the accessed resources. You can define scopes by providing user claims, such as user attributes and permissions. The client application developer can request for required scopes, which an administrator uses for configuring the resource server in Identity Server (authorization server). However, there is no restriction for any client application to use any of the scopes configured in any resource server. For more information, see Adding a Resource Server. It is recommended to select Require user permission to get consent from the user whenever the scope contains user attributes.

When a user grants client applications access to protected resources, they can perform actions based on permissions defined in the scope.

For example, if you have defined a scope named email and defined permissions associated with this scope, such as read only. A client application that will access the email can only read the content.

NOTE:

  • You can get LDAP-based attributes in a scope.

  • You can configure roles as an OAuth scope and use them to inject with the Identity Injection policy. The role attribute is calculated when a token is sent to UserInfo Endpoint.

  • If you have registered a client application to use binary token, you cannot add user attributes and claims to the token.

Perform the following steps to define scopes and permissions:

  1. Click Devices > Identity Server > Edit > OAuth & OpenID Connect > Resource Server.

  2. Select the resource server name for which you want to define a new scope.

  3. Click New and specify the following details:

    Field

    Description

    Name

    Specify a name for the scope.

    Description

    Specify a description for the scope. The consent page shows this description.

    Include claims of type

    Select the type of user’s claim to be used in the scope. You can select any of the following types:

    • User Attributes: Select this option if you require using any of the user’s LDAP attributes in the scope. You can also use virtual attributes in the scope.

      NOTE:

      • You can use virtual attributes for LDAP-based attributes and constant values.

      • This option does not work in a client credentials flow.

    • Custom Claims/Permissions: Select this option if you want to restrict specific permissions for this scope. This option is useful when a client application requires specific permission, such as read, write and so on to access a resource.

      For example, when you configure a read permission for the scope, the client application can request for this scope and get the token.

    Require user permission

    Select this option if this scope requires user’s consent before providing access to the protected resources. It is recommended to keep this option selected when user attribute is used in the scope.

    In a client credentials flow, the token does not include scopes that require user permissions. Therefore, deselect this option. When the option is deselected, the claims can be fetched from the UserInfo Endpoint.

    • When this option is enabled and the prompt=consent parameter is sent in the authorization endpoint, the user consent screen is displayed.

    • When this option is enabled, and the prompt=none parameter is passed in the authorization endpoint, the user consent screen is not displayed.

    • When this option is disabled, and the prompt=none parameter is passed in the authorization endpoint, the user consent screen is not displayed.

    • When this option is disabled, and the prompt=consent parameter is passed in the authorization endpoint, the user consent screen is not displayed.

    NOTE:If you deselect this option, the scope is not listed in the scopes_supported field of the metadata endpoint. The claims_supported field of the metadata endpoint does not display the claims for this scope even if the user attribute or the custom claims/permissions are configured.

    Allow modification in consent

    Select this option to allow modification in consent. When selected, the resource owner can choose not to share the scope with the client application.

    The consent page will display a check box against each scope to choose the scopes that can be shared with the client applications.

  4. Click Next and continue with Configuring User Claims or Permission in Scope.

Configuring User Claims or Permission in Scope

You can include user’s attributes or a client application’s claim in the scope.

  1. (Conditional) If you chose User attributes to create scope, perform the following steps:

    1. Select the required attribute set from the LDAP profile or create a new attribute set.

      This lists the user attributes in the attribute set.

      NOTE:You can add any configured LDAP based virtual attribute to the scope of the access token. You can add a virtual attribute by creating an attribute set that includes the virtual attributes. For information about creating an attribute set, see Configuring Attribute Sets.

    2. To add the user attribute scope to the access token, select the required attributes that should be added to the access token, then click Add > Add to Access Token.

      If you want to remove a specific attribute from the access token, click Remove > Remove from Access Token. When you remove the attribute from the access token, the attributes will not be removed from the already issued token.

    3. To add the user attribute scope to the ID token, select the required attributes that should be added to the ID token, then select Add > Add to ID Token.

      NOTE:The token size varies based on the attribute value that is included in the token. Hence, it is recommended to include only the required attribute to the token.

      If you require to remove a specific attribute from the ID token, select the attribute then click Remove > Remove from ID Token.

      NOTE:The attributes are not added to or removed from an issued ID token.

    4. (Conditional) If you require the selected attributes to be available in both ID token and access token, then after selecting the attributes click Add > Add to Both.

      If you require to remove specific attributes from both access token and ID token, then after selecting those attributes click Remove > Remove from Both.

  2. (Conditional) If you have used Custom Claims/Permissions, perform the following:

    1. Click New to create a new custom claim.

    2. In Add claim/permission, specify the permission that the client is allowed after consuming the access token.

    3. Select the required claim that to be added to the access token, then select Add > Add to Access Token.

      To remove a specific claim from an access token, click Remove > Remove from Access Token.

      NOTE:The claims are not added to or removed from an already issued access token. You can view the new Claims/Permissions in the claims set. The key name is claims and the value is a list of strings.

    4. Select the required claim to be added to the ID token, then select Add > Add to ID Token.

      To remove a specific claim from the ID token, click Remove > Remove from ID Token.

      NOTE:Claims are not added to or removed from an issued ID token. You can view the new Claims/Permissions in the claims set. The key name is claims and the value is a list of strings.

    5. (Conditional) If you require to select the claims that must be available for both access token and ID token, then after selecting the claims click Add > Add to Both.

      To remove claims from both tokens, select claims, and click Remove > Remove from Both.

      NOTE:The claims are not added to or removed from the already issued tokens. These claims are displayed as list of strings under the claims attribute in access and ID tokens.

Managing Scopes of a Resource Server

  1. Click Devices > Identity Server > Edit > OAuth & OpenID Connect > Resource Server.

  2. Click the resource server > scope you want to modify.

  3. On the Edit Scope page, modify the details as required. For information, see Defining Scopes for a Resource Server.

  4. Click OK.

Modifying Claims and Attributes

You can modify or delete a defined claim. You can also update the attributes associated with a scope. If you have selected Require user permission while creating the scope, Identity Server fetches the required information from the userinfo endpoint. You can change the associated LDAP attributes.

To delete a custom claim or permission, you can select the required permission and click Delete.

For information about user attributes and claims, see Defining Scopes for a Resource Server.

Managing OAuth Client Applications

A client application that sends API requests to Access Manager must be registered with Access Manager Identity Server. You can register a client application by using the API calls, Administration Console, or the Identity Server user portal page.

Prerequisites for managing client applications include:

  • User Portal: Define any of the following roles in the OAuth policy for the user:

    • NAM_OAUTH2_DEVELOPER: Allows the user to view and modify the client registration details of the applications that the user has registered on the portal.

    • NAM_OAUTH2_ADMIN: Allows the user to view and modify the client registration details of all the client applications that are registered with Access Manager.

    The user (an application developer) must log in to Identity Server for registering a client application. The My Applications tab lists all applications that the user has added. The user can view details, modify, and delete applications.

  • API calls: Define the NAM_OAUTH2_ADMIN role in the OAuth policy for the user.

  • Administration Console: The user must request the Access Manager administrator to register a client application using Administration Console.

Registering OAuth Client Applications

  1. Click Devices > Identity Server > Edit > OAuth & OpenID Connect > Client Applications > Register New Client.

  2. In Client Configuration, select Enable Client and specify the following details:

    Field

    Description

    Client Name

    Specify the name of the client application.

    Client Type

    Select whether this is a web-based or a desktop client application.

    If you select Native/Desktop, Use Persistent Cookie gets displayed.

    You can select Use Persistent Cookie to allow single sign-on for a user who uses client applications on a desktop or a mobile.

    For example, a user accesses client A using the credentials and gets authenticated. Client A receives a refresh token and an access token. Now, user accesses client B immediately or after few days. If Use Persistent Cookie is enabled for client B, then the client uses the persistent cookie to retrieve the token and authenticate the user. Hence, client B will get authenticated automatically.

    If Use Persistent Cookie is not selected for client B configuration, user has to provide credentials to retrieve refresh token and access token.

    NOTE:When a client application uses the Authorization Code flow, the request must contain the revocation_id parameter along with the clientID parameter. The revocation_id value can be the device ID.

    If revocation_id is not included in the request, the user cannot use the persistent cookie to authenticate from client B.

    Login Redirect URIs

    Specify the URI based on the Client type.

    Specify the URIs that Identity Server uses to send the authorization code and implicit requests.

    For web-based applications, specify the client type in this format: https://client.example.org/callback

    For native/desktop applications, specify the client type in any one of the following formats:

    https://www.namnetiq.in/

    x-com.netiq.sample://www.namnetiq.in/

    urn:ietf:wg:oauth:2.0:oob (supported only for the authorization code flow).

    Grants Required

    Select the grant types required for this client application. Available grant types include:

    • Authorization Code (default)

    • Implicit

    • Resource Owner Credentials

    • Client Credentials

    • SAML 2.0 Assertion

    Token Types

    Select the type of tokens that the authorization server will send to this client application:

    • Code

    • ID Token

    • Refresh Token

    • Access Token

    Refresh Token

    Select Always Issue New Token to issue a new refresh token for each refresh token request.

  3. (Conditional) If you selected ID Token in Client Configuration > Token Types, click OpenID Connect Configuration, and configure the following settings:

    Field

    Description

    JSON Web Key Set URI

    To encrypt an ID token using the public key of a client application, specify the client’s JSON Web Key Set URI. This is required to retrieve the encryption key that are defined in the JSON Web Key Set URI.

    ID Token Signed Response Algorithm

    This is a mandatory field for issuing an ID token to a client application. If you require Identity Server to sign the ID token using a JWS algorithm, select the appropriate signing algorithm. The signing algorithm depends on the certificate that is specified under Certificate Settings in the Global Settings page.

    For example, if Signing Algorithm is RS256 on the Global Settings page, select RS256.

    NOTE:If you select None, the ID token is sent as an unsigned token. Ensure to select this option only if you trust the integrity of an unsigned ID token.

    ID Token Encrypted Response Algorithm

    Specify the JWE algorithm to encrypt the key of the encrypted content in the ID token.

    NOTE:Ensure to specify the algorithm that is defined in the specified JSON Web Key Set URI so that the client application can use the private key to decrypt the token.

    ID Token Encrypted Response Enc

    This field gets auto-populated based on the algorithm specified in ID Token Encrypted Response Algorithm. JWE enc algorithm is required to encrypt the content of the ID token.

  4. Click Token Configuration. The timeout settings here overrides the global settings.

    Field

    Description

    Authorization Code Timeout

    Specify the duration after which the authorization code will expire.

    Access Token and ID Token Timeout

    Specify the duration after which access and ID tokens will expire.

    Refresh Token Timeout

    Specify the duration after which the refresh token will expire.

    Access Token and Refresh Token Format

    It is recommended to select the JWT token. However, you can select any of the following options:

      • Default: The format is set to binary or JWT based on the value you set in the OAUTH TOKENS IN BINARY FORMAT property of Identity Server.

        If OAUTH TOKENS IN BINARY FORMAT is

        • set to true, the format is binary.

        • set to false, the format is JWT.

        • unspecified, the format is JWT.

        When you update the value or add OAUTH TOKENS IN BINARY FORMAT, any client application with the Default option receives the tokens (access and refresh) in the modified format.

      • Binary: The token format is always binary irrespective of the value set in the OAUTH TOKENS IN BINARY FORMAT property of Identity Server.

        Binary tokens are always encrypted using Access Manager keys. To validate a token, the resource server uses Access Manager UserInfo and TokenInfo endpoints.

        If tokens are in the binary format, the following features are unavailable:

        • Encrypting an access token using the resource server key

        • Revoking a refresh token

        The Binary option is recommended only if you have an existing client application that cannot use JWT because some browsers restrict the length of the parameter values.

      • JWT: Recommended option. The token format is always JWT irrespective of the value set in the OAUTH TOKENS IN BINARY FORMAT property of Identity Server.

  5. Click Logout Configuration and specify the following details:

    Field

    Description

    Front-Channel Logout URI

    Specify the client application logout URL that Identity Server will use to trigger logout at the client application

    Enable Session Token

    When you enable this option, Identity Server includes session ID and issuer query parameters in the client application’s logout URL.

    This session ID is a co-relation ID that the client application uses to identify the unique user sessions established at Identity Server. It is not the Identity Server user session ID.

    Logout Redirect URIs

    (Applicable only for the Relying Party initiated logout request)

    Specify the URL to which the user will be redirected after logout. For example, https://client.example.org/logout.

    NOTE:The logout request (end_session) must include id_token_hint and post_logout_redirect_uri request parameters. Else, Identity Server does not redirect the user to the post-logout page.

    For information about the OIDC front-channel logout support, see OIDC Front-Channel Logout.

  6. Click Consent Screen Configuration and specify the following details:

    Field

    Description

    Client Logo URL

    Specify the URL of the logo that you want to include on the consent page.

    Privacy Policy URL

    Specify the URL of the privacy policy you want to include on the consent page. You can define your own privacy policy.

    Terms of Service URL

    Specify the URL of the terms of service.

    Contacts

    Specify the email addresses of people related to this client application.

  7. Click Authorized JavaScript origins (CORS) and add Domains. Domains configured here can access restricted resources available on the client application. Do not specify the port if you are using port 80 or 443.

    For example, beem://www.test.com:port, fb://app.local.url:port, https://namapp.com:port

  8. Click Authentication Contract to configure authentication contracts for the client application. This configuration is available in Access Manager 5.0 Service Pack 1 and later.

    When you configure authentication contracts for a client application using here, this server-side configuration takes precedence. After this configuration, the ACR value in the request is ignored, and contracts are used for authentication.

    In Available Contract, select contracts that you want to be used for authentication and move these to Satisfy Contract. By default, the first contract in the list is used. For the Resource Owner Credentials flow, if the identity provider does not support that contract, then the next contract in the list is used for authentication.

  9. Click Scope Configuration and select the required scopes for the client application.

    Field

    Description

    Scopes

    Select scopes that the client application can use.The client application can use only the scopes specified here. If the client application sends a non-configured scope, it will not be considered.

  10. Click Register Client.

    Identity Server assigns a client ID and a client secret. To see this ID and secret, go to the Client Application page and click the view icon for this client application.

Modifying Registered Client Applications

  1. Click Devices > Identity Server > Edit > OAuth & OpenID Connect > Client Applications.

    The page lists all registered client applications along with the following details:

    Field

    Description

    Client Application

    Name of the registered application

    Application Type

    Type of the application: Web or Native/Desktop

    Created By

    User name of the person who has registered the client application.

    Actions

    List of icons associated with actions that you can perform on an application. You can perform the following actions:

    • View details of a registered client application

    • Modify details of a registered client application

    • Delete a registered client application

    • Disable a client application.

      Disabling a client application does not delete it, and it will not revoke any token issued earlier. When you enable the client application again, the token issued earlier does not expire and will continue to work.

  2. Click the edit icon under Actions. Modify the details as required. For information about fields, see Registering OAuth Client Applications.

  3. Click Modify Client.