PUT /api/v1/authorizationServers/{authServerId}/claims/{claimId}

Replaces a custom token Claim specified by the claimId

Servers

Path parameters

Name Type Required Description
claimId String Yes

id of Claim

authServerId String Yes

id of the Authorization Server

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 valueType is GROUPS

If valueType is GROUPS, then the groups returned are filtered according to the value of group_filter_type.

If you have complex filters for Groups, you can create a Groups allowlist to put them all in a Claim.

Possible values:

  • "REGEX"
  • "CONTAINS"
  • "EQUALS"
  • "STARTS_WITH"
system Boolean No

When true, indicates that Okta created the Claim

conditions Object No

Specifies the scopes for the Claim

conditions.scopes[] Array No
status String No

Possible values:

  • "ACTIVE"
  • "INACTIVE"
value String No

Specifies the value of the Claim. This value must be a string literal if valueType is GROUPS, and the string literal is matched with the selected group_filter_type. The value must be an Okta EL expression if valueType is EXPRESSION.

claimType String No

Specifies whether the Claim is for an access token (RESOURCE) or an ID token (IDENTITY)

Possible values:

  • "RESOURCE"
  • "IDENTITY"
valueType String No

Specifies whether the Claim is an Okta Expression Language (EL) expression (EXPRESSION), a set of groups (GROUPS), or a system claim (SYSTEM)

Possible values:

  • "SYSTEM"
  • "EXPRESSION"
  • "GROUPS"
alwaysIncludeInToken Boolean No

Specifies whether to include Claims in the token. The value is always TRUE for access token Claims. If the value is set to FALSE for an ID token claim, the Claim isn't included in the ID token when the token is requested with the access token or with the authorization_code. The client instead uses the access token to get Claims from the /userinfo endpoint.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.