Skip to main content

Set Organization Metadata​

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

Path Parameters
  • key string required
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.

Request Body required
  • value byte

    Possible values: non-empty and <= 500000 characters

    The value has to be base64 encoded.

Responses

A successful response.

Schema
  • 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
POST /metadata/:key

Authorization

type: oauth2flow: authorizationCodescopes: openid,urn:zitadel:iam:org:project:id:zitadel:aud

Request

Base URL
https://$ZITADEL_DOMAIN/management/v1
Bearer Token
key — path required
x-zitadel-orgid — header
Content-Type
Body required
{

  "value": "VGhpcyBpcyBteSB0ZXN0IHZhbHVl"

}
Accept
curl -L -X POST 'https://$ZITADEL_DOMAIN/management/v1/metadata/:key' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "value": "VGhpcyBpcyBteSB0ZXN0IHZhbHVl"
}'