---
title: "Update an auth server claim"
method: PATCH
path: "/v1/auth-servers/{authServerId}/claims/{claimId}"
tags: ["Auth Server Claims"]
---

# Update an auth server claim

`PATCH /v1/auth-servers/{authServerId}/claims/{claimId}`

Update a claim for a given auth server.

## Request body

- object
  - `name` string — The name of the claim
  - `value` string — 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_token` boolean — 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_scopes` boolean — 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_scopes` string[] — Specifies the scopes IDs in which the claim is included
  - `enabled` boolean — 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 `200`

A claim

- Claim
  - `id` string, uuid, required — The ID of the claim
  - `name` string, required — The name of the claim
  - `value` string, 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_token` boolean, 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_scopes` boolean, 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_scopes` string[], required — Specifies the scopes IDs in which the claim is included
  - `enabled` boolean, 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_at` string, date-time, required — An ISO-8601 timestamp representation of entity creation date.
  - `updated_at` string, date-time, required — An ISO-8601 timestamp representation of entity update date.

## Other responses

- `400` — Bad Request
- `404` — Not Found

## Changes

- **2025-11-06** `5d2b35832e3f` — 1 warning
  - added the new `type` enum value to the `allOf[subschema #2]/invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterStandard]/rule` response property for the response status `400`
- **2025-10-02** `ecce2daf9de6` — 5 breaking
  - the response property `allOf[subschema #2]/invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterChoiceItem]/source` became nullable for the status `400`
  - the response property `allOf[subschema #2]/invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterDependentItem]/source` became nullable for the status `400`
  - the response property `allOf[subschema #2]/invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterMaximumLength]/source` became nullable for the status `400`
  - the response property `allOf[subschema #2]/invalid_parameters/items/oneOf[#/components/schemas/InvalidParameterMinimumLength]/source` became nullable for the status `400`
  - …1 more
- **2025-08-12** `b2800570b3e2` — 2 info
  - api tag `Auth Server Claims` added
  - api tag `authserver` removed
- **2025-06-25** `2608e8fec4d7` — 3 info
  - the `enabled` request property default value `true` was removed
  - the `include_in_all_scopes` request property default value `false` was removed
  - the `include_in_token` request property default value `false` was removed
- **2025-06-05** `a0a9c5c8afa2` — 1 info
  - endpoint added

[Change history](https://skmtc.dev/kong/apis/konnect-api-beta/changes/v1/auth-servers/:authServerId/claims/:claimId/patch.md)

---

[API](https://skmtc.dev/kong/apis/konnect-api-beta.md) · [All operations](https://skmtc.dev/kong/apis/konnect-api-beta/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/kong/konnect-api-beta/revisions/658ffb748f95/schema)