Configure your Cloudentity Workspace
Select Auth Settings from the sidebar in the admin portal.
Proceed to configuring the server. The configuration is divided into the following parts:
- Auth Settings where you configure the server grant types, allowed authentication methods, and client registration.
- Tokens where you configure all things token-related, such as token type, lifetime, signature and encryption, as well as claims exposed in the token.
- Consent where you configure the consent page for the end users.
- Authorization where you can assign the policies authorizing the server to issue a token in specific cases.
Configure Auth Settings
- Go to Auth Settings > OAuth.
Configure Grant Types
Go to the General tab.
There are a few sections in the General view that need to be configured to optimize protection and security exercised within your workspace. They are
- Allowed grant types
- Pushed Authorization Request (PAR) enforcement
Under the Allowed grant types section, enable specific grant types by selecting the corresponding checkboxes.
There are a few grant types that you can allow in your workspace for an application to acquire an access token. They are
- Authorization code
- Client credentials
- Refresh token
- Resource owner password
- JWT Bearer
- Token Exchange
- Device Authorization (formerly known as Device Flow)
For the Authorization code grant type, you can enable two additional options:
- Enforce PKCE for all clients
- Enforce PKCE for public clients.
Select Enforce PAR to enforce pushed authorization requests in this server. For more information, see Pushed Authorization Requests.
Configure Client Authentication
Go to Client Authentication > Allowed token endpoint authentication methods section and enable specific methods by selecting the corresponding checkboxes.
Token Endpoint Authentication Methods
There are a few token endpoint authentication methods that you can allow in your workspace. They are
- Client secret with three flavors to choose from: Client Secret Basic, Client Secret JWT, and Client Secret Post.
- JSON web token (Private Key JWT)
- TLS client authentication with two options to choose from: TLS Client Auth and Self Signed TLS Client Auth.
Select None to allow for creating applications without authorization. This option does not prevent you from enabling the other methods.
In the Client Authentication view, navigate to the TLS Client Authentication section and enable the TLS Client Auth and/or the Self Signed TLS Client Auth methods by selecting the corresponding checkboxes.
You can add your trusted client certificates. Privacy-enhanced mail (PEM) encoded root CA certificates are used for client mTLS token endpoint authentication. If you do not add any trusted client certificates, system root Certificate Authority (CA) certificates are used instead.
Configure Dynamic Client Registration
Go to Client registration and select Enable dynamic client registration.
Select a dynamic client registration policy from the dropdown menu or create a new DCR policy.
This step is optional: You can leave out dynamic client registration policy if you do not need any access restrictions for DCR.
Optionally, enable Protect by access token and/or Protect by software statement and/or Signed Request Body by selecting the corresponding toggle switches.
For enabled features, choose how to specify your JSON WEB KEY SETS and provide either a code value for your JWKS or a link to it.
For more information on configuring DCR, see Configuring Dynamic Client Registration with authorization servers.
You have successfully configured your Dynamic Client Registration.
Configure Token Settings
Select Token under Auth Settings.
In the Type view, select the access token type:
JSON WEB TOKEN (a signed token that contains entity-specific data and can be validated in place)
OPAQUE (a random string that requires introspection to be validated / get entity-specific data)
Go to TTL and set Time to Live (TTL) for tokens, authorization code, and cookie max age. Save your changes.
Go to Signing and encryption.
Enable the token encryption if necessary (this is required by the FAPI standard).
Set up the signing key rotation settings. For more information, read Key rotation.
Go to Claims.
Choose between the legacy and hash subject format.
For the legacy format, the
subvalue is populated with an identifier provided by the IDP and stored as a plaintext. If you have multiple IDPs configured in your workspace, identifier collision may happen.
For the hash format, the identifier from the IDP is prefixed with the identifier of the Identity Source and one-way hashed to avoid sub collision and make it impossible to read (for improved security of Personally Identifiable Information (PII)).
Getting the Original Subject Value
If you set the subject format to hash and you need to retrieve the original value (plain text) of the
subclaim, inject a custom claim to the access token or call the Cloudentity OAuth 2.0 Introspection endpoint. By default, Cloudentity tenants' authentication context contain the
idp_subattribute that can be used to provide the source (original
sub) for the custom claim. To retrieve the subject, add a custom claim to access tokens with a name of your choice, source type set to AuthN Context, and Source Path set to IDP subject attribute. See example below.
idp_subattribute is not present in the authentication context defined in the tenanant configuration, add it manually.
Set up Allowed Subject Identifier Types.
Subject identifier types
Cloudentity supports the Public and Pairwise subject identifier types.
The Pairwise subject identifier represents one user with unique identifiers to different clients. Each Pairwise subject identifier is assigned to a specific user-client pair for enhancing the user privacy.
Configure claims exposed with tokens issued to the client. For detailed information on claim configuration, read Configuring claims for ID tokens and access tokens.
Configure Consent Screen
The consent screen is a prompt displayed to the end user when an application requests access to the user’s private data.
Go to Auth Settings > Consent.
In the Consent screen view, select the type of the consent page that you’d like to use:
OAUTH CONSENT based on default scopes or
OPEN BANKING CONSENT for specialized use cases, such as Open Banking.
Select Save changes to apply your choice.
The Open Banking consent page requires configuration. For instructions on how to integrate the custom consent page with Cloudentity, see Configuring the custom consent page.
Open Banking Consent
If you choose OPEN BANKING CONSENT for your workspace, enter the consent URL in the field provided and select Save changes to proceed. For detailed instructions on how to enable OPEN BANKING CONSENT in the workspace, see Enabling the custom consent page.
Configure Authorization Settings
Go to Auth Settings > Authorization
Configure the Workspace Authorization Policy settings.
Select Client registration policy from the dropdown menu to define the policy that validates developer attributes before they can register applications.
Select Token issue policy from the dropdown menu to define the policy that validates user attributes before they can be provided with a token.
Select Machine token policy from the dropdown menu to define the policy that validates machine-to-machine application attributes before they can be provided with a token.
For each policy type, you can either select an existing policy or create a new one. For information on creating policies, see Creating policies.