Skip to main content

Get User Metadata By Key

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

Get a metadata object from a user by a specific key.

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.

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 (string)
    key string

    metadata key

    value byte

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

curl -L 'https://$CUSTOM-DOMAIN/management/v1/users/:id/metadata/:key' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'
Request Collapse all
Base URL
https://$CUSTOM-DOMAIN/management/v1
Auth
Parameters
— pathrequired
— pathrequired
— header
ResponseClear

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