Skip to main content

Get Organization Metadata By Key​

Get a metadata object from an organization by a specific key.

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.

Responses

A successful response.

Schema
  • metadata object
  • 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
  • key string

    metadata key

  • value byte

    metadata value is base64 encoded, make sure to decode to get the value

GET /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
Accept
curl -L -X GET 'https://$ZITADEL_DOMAIN/management/v1/metadata/:key' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'