Sign in
Auth Server Claims

Update an auth server claim

Update a claim for a given auth server.

patch/v1/auth-servers/{authServerId}/claims/{claimId}

Request body

namestring

The name of the claim

valuestring

Specifies the value of the claim. It may contain a static value or a dynamic (templated) value. Static values which are valid JSON will result in a JSON object in the token claims.

include_in_tokenboolean

Specifies whether to include claim in the token. If the value is set to 'false' for a claim, the client instead uses the access token to get claims from the '/userinfo' endpoint.

include_in_all_scopesboolean

Specifies whether to include the claim in all scopes. If the value is set to 'false' for a claim, the claim is only included in the scopes that explicitly list it.

include_in_scopesstring[]

Specifies the scopes IDs in which the claim is included

enabledboolean

Specifies whether the claim is enabled. If the claim is not enabled, it will not be included in the token or the '/userinfo' endpoint.

Response

A claim

idstring uuid required

The ID of the claim

namestring required

The name of the claim

valuestring required

Specifies the value of the claim. It may contain a static value or a dynamic (templated) value. Static values which are valid JSON will result in a JSON object in the token claims.

include_in_tokenboolean required

Specifies whether to include claim in the token. If the value is set to 'false' for a claim, the client instead uses the access token to get claims from the '/userinfo' endpoint.

include_in_all_scopesboolean required

Specifies whether to include the claim in all scopes. If the value is set to 'false' for a claim, the claim is only included in the scopes that explicitly list it.

include_in_scopesstring[] required

Specifies the scopes IDs in which the claim is included

enabledboolean required

Specifies whether the claim is enabled. If the claim is not enabled, it will not be included in the token or the '/userinfo' endpoint.

created_atstring date-time required

An ISO-8601 timestamp representation of entity creation date.

updated_atstring date-time required

An ISO-8601 timestamp representation of entity update date.

Example response

{
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z"
}

Changes

Changed in 5 of the 29 revisions of this API.516

  • 5d2b35832e3f1See the full diff
    • ●

      added the new type enum value to the allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/rule response property for the response status 400

      response-property-enum-value-added

    This revision also has 57 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ecce2daf9de65See the full diff
    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterChoiceItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterDependentItem]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMaximumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterMinimumLength]/source became nullable for the status 400

      response-property-became-nullable

    • ▲

      the response property allOf[subschema #2]/invalid_parameters/items/oneOf[InvalidParameterStandard]/source became nullable for the status 400

      response-property-became-nullable

  • b2800570b3e22See the full diff
    • ○

      api tag Auth Server Claims added

      api-tag-added

    • ○

      api tag authserver removed

      api-tag-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2608e8fec4d73See the full diff
    • ○

      the enabled request property default value true was removed

      request-property-default-value-removed

    • ○

      the include_in_all_scopes request property default value false was removed

      request-property-default-value-removed

    • ○

      the include_in_token request property default value false was removed

      request-property-default-value-removed

  • a0a9c5c8afa21See the full diff
    • ○

      endpoint added

      endpoint-added