POST /api/v1/authorizationServers/{authServerId}/claims
Creates a custom token Claim for a custom authorization server
Servers
- https://{yourOktaDomain}
Path parameters
Name | Type | Required | Description |
---|---|---|---|
authServerId |
String | Yes |
|
Request headers
Name | Type | Required | Description |
---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
Name | Type | Required | Description |
---|---|---|---|
id |
String | No |
ID of the Claim |
_links |
Object | No |
Specifies link relations (see Web Linking) available using the JSON Hypertext Application Language specification. This object is used for dynamic discovery of related resources and lifecycle operations. |
name |
String | No |
Name of the Claim |
group_filter_type |
String | No |
Specifies the type of group filter if If If you have complex filters for Groups, you can create a Groups allowlist to put them all in a Claim. Possible values:
|
system |
Boolean | No |
When |
conditions |
Object | No |
Specifies the scopes for the Claim |
conditions.scopes[] |
Array | No | |
status |
String | No |
Possible values:
|
value |
String | No |
Specifies the value of the Claim. This value must be a string literal if |
claimType |
String | No |
Specifies whether the Claim is for an access token ( Possible values:
|
valueType |
String | No |
Specifies whether the Claim is an Okta Expression Language (EL) expression ( Possible values:
|
alwaysIncludeInToken |
Boolean | No |
Specifies whether to include Claims in the token. The value is always |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.