---
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

---

[API](https://skmtc.net/kong/apis/konnect-api.md) · [All operations](https://skmtc.net/kong/apis/konnect-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/kong/konnect-api/versions/06734a9c491f/schema)