Skip to main content

Set User Metadata

POST 
https://$CUSTOM-DOMAIN/management/v1/users/:id/metadata/:key

This endpoint either adds or updates a metadata value for the requested key. Make sure the value is base64 encoded.

Request​

Path Parameters

    id stringrequired
    key stringrequired

Header Parameters

    x-zitadel-orgid string

    The default is always the organization of the requesting user. If you like to get users of another organization include the header. Make sure the user has permission to access the requested data.

Body

required

    value byte

    Possible values: non-empty and <= 500000 characters

    The value has to be base64 encoded.

Responses​

A successful response.

Schema

    id string

    details

    object

    sequence uint64

    on read: the sequence of the last event reduced by the projection

    on manipulation: the timestamp of the event(s) added by the manipulation

    creationDate date-time

    on read: the timestamp of the first event of the object

    on create: the timestamp of the event(s) added by the manipulation

    changeDate date-time

    on read: the timestamp of the last event reduced by the projection

    on manipulation: the

    resourceOwner resource_owner is the organization an object belongs to (string)
curl -L 'https://$CUSTOM-DOMAIN/management/v1/users/:id/metadata/:key' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "value": "VGhpcyBpcyBteSB0ZXN0IHZhbHVl"
}'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/management/v1
Auth
Parameters
— pathrequired
— pathrequired
— header
Body required
{
  "value": "VGhpcyBpcyBteSB0ZXN0IHZhbHVl"
}
ResponseClear

Click the Send API Request button above and see the response here!