Get My User Metadata By Key

Returns a metadata value by a specific key of the authenticated user. Metadata is a key value list with additional information needed on the user.

Path Parameters

key string required

Responses

200
default

A successful response.

application/json
application/grpc
application/grpc-web+proto

Schema
Example (from schema)

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

{
  "metadata": {
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-10",
      "changeDate": "2023-05-10",
      "resourceOwner": "69629023906488334"
    },
    "key": "key1",
    "value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
  }
}

Schema
Example (from schema)

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

{
  "metadata": {
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-10",
      "changeDate": "2023-05-10",
      "resourceOwner": "69629023906488334"
    },
    "key": "key1",
    "value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
  }
}

Schema
Example (from schema)

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

{
  "metadata": {
    "details": {
      "sequence": "2",
      "creationDate": "2023-05-10",
      "changeDate": "2023-05-10",
      "resourceOwner": "69629023906488334"
    },
    "key": "key1",
    "value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
  }
}

An unexpected error response.

application/json
application/grpc
application/grpc-web+proto

Schema
Example (from schema)

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema
Example (from schema)

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

Schema
Example (from schema)

Schema

code int32
message string
details object[]
Array [
@type string
]

{
  "code": 0,
  "message": "string",
  "details": [
    {
      "@type": "string"
    }
  ]
}

GET /users/me/metadata/:key

Authorization

type: oauth2flow: authorizationCodescopes: openid

Request

Base URL

https://$ZITADEL_DOMAIN/auth/v1

Bearer Token

key — path required

Accept

curl -L -X GET 'https://$ZITADEL_DOMAIN/auth/v1/users/me/metadata/:key' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/auth/v1/users/me/metadata/:key' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/auth/v1/users/me/metadata/:key' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/auth/v1/users/me/metadata/:key' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/auth/v1/users/me/metadata/:key' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/auth/v1/users/me/metadata/:key' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://$ZITADEL_DOMAIN/auth/v1/users/me/metadata/:key' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Get My User Metadata By Key​

Authorization

Request

Get My User Metadata By Key