Supported claim types are typically defined in a Smart API’s service description document and populated during API registration. Therefore, it is uncommon to define new claim types for a Smart API. However, if a scenario arises requiring a new claim type for a Smart API, follow these steps.
Add the claim type
-
On the left panel, click Smart APIs
.
-
Click the Smart API in the grid to see its details.
-
In the Supported Claim Types section, click
and click Add claim type.
-
In the Add a Supported Claim Type dialog box, click Name and type the name for the claim.
This is the claim name as presented in an access token returned from Smart API Manager.
-
Click Description and type a description (optional) for the claim.
-
Click Type, and select the type of values that can be assigned to the claim.
-
Click Required if an access token must include this claim when requesting access to the Smart API.
-
Click Unique if an access token must include only one instance of this claim when requesting access to the Smart API.
-
Click NEXT to enter values for enumeration claim types, or click FINISH for string claim types.
For enumeration claim types, define claim values
If the claim type is enumeration, define the claim values:
-
Click Name, and type the name of the claim value.
-
Click ADD.
-
Click Provide a value, and type the claim value.
-
To define additional claim values, repeat these steps.
-
Click NEXT and then FINISH.