Claim Management
A claim is a piece of information about a particular subject. The Claim Management component of the WSO2 Carbon enables to map a set of attributes from the underlying user store to a set of defined claims
The underlying user store can be either the external user store or the internal user store.
A set of claims are identified as a dialect. Different dialects represents the same piece of information with different claim URIs.
With the help of Claim Management component, these different claims can be mapped with the attributes of the user which are associated with his profile.
Figure 1: Claim Management
Following dialects are defined by-default with WSO2 Claim Management Component.
- http://wso2.org/claims : Default dialect for WSO2 Carbon
- http://schemas.xmlsoap.org/ws/2005/05/identity : Default dialect for Information Cards
- http://axschema.org : Default dialect for OpenID Attribute EXchange
- http://schema.openid.net/2007/05/claims : Default dialect for OpenID Simple Registration
You can define a new Claim Dialect by clicking on the link 'Add New Claim Dialect'
Figure 2: Adding a new dialect
- Dialect Uri : URI which uniquely identifies the Dialect. Eg :- http://schema.openid.net/2007/05/claims
- Display Name : Name of the dialect.
- Description : Describe the Dialect, what it is designed for, etc.
- Claim Uri : Each dialect should have at least one claim when defining it.
- Mapped Attribute : Corresponding attribute name from the underlying user store for this claim.
- Regular Expression : Regular expression to validate inputs for this claim.
- Display Order : Display order of the above claim among all the other claims defined under the same dialect
- Supported by Default : If unchecked, this claim won't be prompted at the time of user registration
- Required : Whether this claim is mandatory for user registration or not.
From the Claim Dialect view [once you click on any available dialect links] you can views the claims defined for that particular dialect.
Figure 3: Viewing Dialect Information
It is possible to edit the claim mappings of a given dialect by clicking the 'Edit' link appearing for each claim mapping.
Figure 4: Editing a Claim Mapping
You can extend a defined dialect by adding new claim mappings. Click 'Add New Claim Mapping' link to add a new claim mapping.
Figure 5: Adding a new claim mapping
- Display Name : Name of the claim displayed on the UI
- Description : Describe the functionality of the claim
- Claim Uri : URI defined under the dialect, specific to the claim
- Mapped Attribute : Corresponding attribute name from the underlying user store
- Regular Expression : Regular expression to validate inputs
- Display Order : Display order of the claim among all the other claims defined under the same dialect
- Supported by Default : If unchecked wont be prompted at the time of user registration
- Required : Required for user registration