Capturing Claims
Last updated
Last updated
There are 5 ways in which claims can be captured:
Manually provided by the user during the signup or login process.
Manually provided by the user in the Account UI.
Automatically sourced through one of the signup or login factors used.
Manually provided by an admin in the Admin UI.
Automatically provided by an admin client via the Management API.
The user can manually provide claims during signup or login using the Authentication API. Important is the score of the attributes you want to store as the user needs to have a session with a (security) score at least equal to or larger as the score of the attribute.
The API call to store claims using the Authentication API looks as below (Postman documentation ):
Alternatively the user can also manually provide claims in the Account UI or via the Management API. In the Account UI users can go to Attributes and then click Create in the upper right corner.
The system can automatically source claims from factors used during signup or login via sources. Using sources allows you to capture claims from following factors:
Username - You can capture the username during signup.
One-Time Password (OTP) - You can capture the channel (email, phone number, etc.) during signup.
OAuth 2.0 / OpenID Connect (OIDC) - You can capture the claims in the identity token returned from the identity provider during signup and login.
An admin can manually provide claims in the Admin UI or via the Management API. In the Admin UI admins can go to Users, select the desired user, go to the Attributes tab and then click Create in the upper right corner.
The API call to store claims using the Management API looks as below (Postman documentation ):
Please go to for more details.
The API call to store claims using the Management API looks as below (Postman documentation ):