ZITADEL Docs
APIsCore ResourcesV2User

SetUserMetadata

Set User Metadata

Sets a list of key value pairs. Existing metadata entries with matching keys are overwritten. Existing metadata entries without matching keys are untouched. To remove metadata entries, use DeleteUserMetadata. For HTTP requests, make sure the bytes array value is base64 encoded.

Required permission:

  • user.write
POST
/v2/users/{user_id}/metadata

Path Parameters

user_id*string

ID of the user under which the metadata gets set.

Request Body

application/json

metadata?

Metadata to bet set. The values have to be base64 encoded.

[key: string]?never

Response Body

application/json

application/json

curl -X POST "https://loading/v2/users/string/metadata" \  -H "Content-Type: application/json" \  -d '{}'
{
  "setDate": "1s"
}
{
  "code": "not_found",
  "message": "string",
  "detail": {
    "type": "string",
    "value": "string",
    "debug": {}
  }
}

Was this page helpful?