Skip to main content

Consents and Consent Groups

Overview​

According to the General Data Protection Regulation (GDPR), organizations that store and process user data must capture user consent during OAuth 2.0 or OpenID Connect authentication flows, including registration, login, or specific events on their application.

Read more on GDPR & Consents.

User consent represents explicit permission from a user allowing an application to access resources protected by scopes. Administrators can create consents using the Consent Management settings and organize related consents into consent groups.

A Consent Version must be created to configure scopes, required fields for mandatory user input, consent language, and the content presented to users.

Note
Consents remain valid until manually revoked by an administrator, or until the associated application or scope is deleted.

Administrator Guide​

A consent group is a collection of multiple consents. To create a consent group:

  1. Navigate to Settings > Consent Management from the dashboard menu.

    consent-management-menu.png

  2. Click Consent Management.

    consent-management-click.png

  3. In the Consent Group window, enter the Group Name and an optional description, then click Save.

    consent-groupwindow.png

  4. A success confirmation message appears once the consent group is created.

    consent-group-success.png

  5. The new consent group is added to the Consent Groups list.

    consent-group-added.png

To edit an existing consent group:

  1. Click the Edit icon for the consent group you want to modify.

    edit-consent-new-2.png

    Note
    The Consent Group name cannot be edited. Only the description can be modified.

  2. Update the description and click Save.

    cg-edit.png

  3. A success confirmation message appears.

    cg-update-success.png

Important
When a consent group is deleted, all consents mapped to that group become disabled and will no longer apply to configured applications.

To delete a consent group:

  1. Click the Delete icon for the consent group.

    delete-cg-new.png

  2. Click Okay in the confirmation dialog.

    deletecg-confirm.png

  3. A delete confirmation message appears.

    cg-deleteconfirm.png

The consent group is removed from the Consent Groups list.

To add a new consent to a consent group:

  1. Under Consent Groups, click Edit Consent.

    edit-consent-latest.png

  2. On the Consent page, click Create Consent.

    create-consent-1.png

  3. Enter the Consent Name and click Save.

    consent-name-add.png

  4. A success confirmation message appears.

    consent-created-success.png

To delete an existing consent:

  1. Under the Consent list, click the Delete icon for the consent you want to remove.

    delete-consent.png

  2. Click Okay in the confirmation dialog.

    consent-delete-confirm.png

  3. A success confirmation message appears.

    consent-deleted.png

The deleted consent is removed from the Consents list.

removed-consent.png

You can create multiple versions of a consent to map to applications based on either scopes or URL.

  • Scopes define the purpose and scenario when a consent applies to an application.
  • URL redirects users to a specific landing page associated with the consent version.

To create a scope-based consent version:

  1. In the Consent Versions window, select SCOPES for Select Option.

    select-scope-consent.png

  2. Select the scope(s) to which the consent will apply.

    select-scope-consent-1.png

  3. Select Required Fields from the list. These fields become mandatory user inputs on registration, login, or other pages where this consent version applies. Users must provide input for these fields and accept the consent checkbox to proceed.

    required-fields-consent.png

  4. Select the language in which the consent will appear.

    consent-locale.png

    Note
    Only one language can be selected per consent version. To support multiple languages, create a separate consent version for each locale.

  5. Add the Content text.

    content-consentversion.png

  6. Click Save.

    consentver-save.png

You can redirect users to a specific landing page when consent is provided, such as a Terms & Conditions page.

Suggestion
Combine scope-based and URL-based consents to customize the consent flow for your application.

To create a URL-based consent version:

  1. In the Consent Versions window, select URL for Select Option.

    consent-url.png

  2. Select the language in which the consent will appear.

    consent-locale.png

    Note
    Only one language can be selected per consent version. To support multiple languages, create a separate consent version for each locale.

  3. Enter a valid URL, type the consent text that will appear to users, and click Save.

    click-save-consent-new.png

    A success confirmation message appears once the consent version is created.

    c-version-success.png

    The new consent version is added to the list.

    added-consentversion.png

Administrators can view which users have acknowledged consents or accepted Terms & Conditions. This is useful for consent analytics and compliance tracking.

To view consent acceptance:

  1. Navigate to Settings > Consent Management and click the Edit Consent icon for the consent group.

    edit-consent-acceptuser.png

  2. Click the Accepted Users icon for the consent.

    accepted-users-1.png

  3. The Consent Accepted Users window displays user names, client IDs (sub), and the consent version they accepted.

    consent-acceptedusers.png

    You can view user acceptance for each consent version by clicking the Accepted Users icon for the relevant consent version on the Consent Versions page.

    accepted-users-cv.png

Configure Consent for Registration Page​

To add user consent on the registration page:

  1. Navigate to Settings > Registration Page Fields.

  2. Click the + button to create a consent registration field.

  3. On the Create Field page:

    • Enter the Field Key value.
    • Select CONSENT for Field Type.
    • Select the required Scopes.
    • Enable the Enable permission to make the consent visible and Required to make it mandatory.

Locale Settings​

To configure the registration consent text in a specific language:

  1. Select the language from the Select Locale list.
  2. Enter text for Consent Label or link an existing consent page URL by clicking Click to add consent.
  3. Enter text for Required Message.
  4. Click Save.

To configure the consent field for your application:

  1. Navigate to Apps > App Settings and click the Edit icon for your application.

    edit-abcapp-new-1.png

  2. Under App Settings, select the Register and Consent scopes, then click Save.

    add-consent-scope-new.png

  3. Click Advanced Settings, then click Registration Fields.

    advanced-settings-new.png

    reg-fields-click.png

  4. Select your registration consent from the Allowed Fields list to display the consent on the registration page.

    allowed-fields-reg.png

  5. To make this consent mandatory, select it for Required Fields.

    required-fields-add.png

  6. Click Save.

    click-save-consent-reg.png

Example Output

reg-consent-example.png

Configure Consent for Login Page​

To add user consent on the login page:

  1. Navigate to Apps > App Settings and click the Edit icon for your application.

    edit-abcapp-new-1.png

  2. Under App Settings, select the Register and Consent scopes, then click Save.

    add-consent-scope-new.png

  3. Click Advanced Settings, then click Consent Management.

    adv-settings-consentmgmt.png

  4. Select the consent you want to apply from the list and click Save.

    select-terms.png

    save-consent.png

    A success confirmation message appears.

    remember_me_successwindow.png

Support

Need Help?​

For any further assistance, feel free to visit our Support Portal.