Get My User Metadata

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

application/json

application/grpc

application/grpc-web+proto

Request Body required

query object

Object unspecific list filters like offset, limit and asc/desc.

offset uint64

limit int64

Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

asc boolean

default is descending

queries object[]
Array [
keyQuery object
key string
method string
Possible values: [TEXT_QUERY_METHOD_EQUALS, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE, TEXT_QUERY_METHOD_STARTS_WITH, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE, TEXT_QUERY_METHOD_CONTAINS, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE, TEXT_QUERY_METHOD_ENDS_WITH, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE]
Default value: TEXT_QUERY_METHOD_EQUALS
defines which text equality method is used
]

Request Body required

query object

Object unspecific list filters like offset, limit and asc/desc.

offset uint64

limit int64

Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

asc boolean

default is descending

queries object[]
Array [
keyQuery object
key string
method string
Possible values: [TEXT_QUERY_METHOD_EQUALS, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE, TEXT_QUERY_METHOD_STARTS_WITH, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE, TEXT_QUERY_METHOD_CONTAINS, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE, TEXT_QUERY_METHOD_ENDS_WITH, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE]
Default value: TEXT_QUERY_METHOD_EQUALS
defines which text equality method is used
]

Request Body required

query object

Object unspecific list filters like offset, limit and asc/desc.

offset uint64

limit int64

Maximum amount of events returned. The default is set to 1000 in https://github.com/zitadel/zitadel/blob/new-eventstore/cmd/zitadel/startup.yaml. If the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

asc boolean

default is descending

queries object[]
Array [
keyQuery object
key string
method string
Possible values: [TEXT_QUERY_METHOD_EQUALS, TEXT_QUERY_METHOD_EQUALS_IGNORE_CASE, TEXT_QUERY_METHOD_STARTS_WITH, TEXT_QUERY_METHOD_STARTS_WITH_IGNORE_CASE, TEXT_QUERY_METHOD_CONTAINS, TEXT_QUERY_METHOD_CONTAINS_IGNORE_CASE, TEXT_QUERY_METHOD_ENDS_WITH, TEXT_QUERY_METHOD_ENDS_WITH_IGNORE_CASE]
Default value: TEXT_QUERY_METHOD_EQUALS
defines which text equality method is used
]

Responses

• 200
• default

---

A successful response.

application/json

application/grpc

application/grpc-web+proto

Schema

Example (from schema)

---

Schema

details object

totalResult uint64

processedSequence uint64

viewTimestamp date-time

the last time the view got updated

result object[]
Array [
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
]

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-06-11T10:37:13.482Z"
  },
  "result": [
    {
      "details": {
        "sequence": "2",
        "creationDate": "2024-06-11T10:37:13.482Z",
        "changeDate": "2024-06-11T10:37:13.482Z",
        "resourceOwner": "69629023906488334"
      },
      "key": "key1",
      "value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
    }
  ]
}

Schema

Example (from schema)

---

Schema

details object

totalResult uint64

processedSequence uint64

viewTimestamp date-time

the last time the view got updated

result object[]
Array [
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
]

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-06-11T10:37:13.482Z"
  },
  "result": [
    {
      "details": {
        "sequence": "2",
        "creationDate": "2024-06-11T10:37:13.482Z",
        "changeDate": "2024-06-11T10:37:13.482Z",
        "resourceOwner": "69629023906488334"
      },
      "key": "key1",
      "value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
    }
  ]
}

Schema

Example (from schema)

---

Schema

details object

totalResult uint64

processedSequence uint64

viewTimestamp date-time

the last time the view got updated

result object[]
Array [
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
]

{
  "details": {
    "totalResult": "2",
    "processedSequence": "267831",
    "viewTimestamp": "2024-06-11T10:37:13.483Z"
  },
  "result": [
    {
      "details": {
        "sequence": "2",
        "creationDate": "2024-06-11T10:37:13.483Z",
        "changeDate": "2024-06-11T10:37:13.483Z",
        "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"
    }
  ]
}

POST /users/me/metadata/_search

Authorization

name: OAuth2type: oauth2scopes: openidflows: {
  "authorizationCode": {
    "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize",
    "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token",
    "scopes": {
      "openid": "openid"
    }
  }
}

Request

Base URL

https://$CUSTOM-DOMAIN/auth/v1

Bearer Token

Content-Type

application/jsonapplication/grpcapplication/grpc-web+proto

Body required

{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "queries": [
    {
      "keyQuery": {
        "key": "key",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      }
    }
  ]
}

Accept

application/jsonapplication/grpcapplication/grpc-web+proto

curl / cURL

curl -L -X POST 'https://$CUSTOM-DOMAIN/auth/v1/users/me/metadata/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "queries": [
    {
      "keyQuery": {
        "key": "key",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      }
    }
  ]
}'

python / requests

curl -L -X POST 'https://$CUSTOM-DOMAIN/auth/v1/users/me/metadata/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "queries": [
    {
      "keyQuery": {
        "key": "key",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      }
    }
  ]
}'

go / native

curl -L -X POST 'https://$CUSTOM-DOMAIN/auth/v1/users/me/metadata/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "queries": [
    {
      "keyQuery": {
        "key": "key",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      }
    }
  ]
}'

nodejs / axios

curl -L -X POST 'https://$CUSTOM-DOMAIN/auth/v1/users/me/metadata/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "queries": [
    {
      "keyQuery": {
        "key": "key",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      }
    }
  ]
}'

ruby / Net::HTTP

curl -L -X POST 'https://$CUSTOM-DOMAIN/auth/v1/users/me/metadata/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "queries": [
    {
      "keyQuery": {
        "key": "key",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      }
    }
  ]
}'

csharp / RestSharp

curl -L -X POST 'https://$CUSTOM-DOMAIN/auth/v1/users/me/metadata/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "queries": [
    {
      "keyQuery": {
        "key": "key",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      }
    }
  ]
}'

php / cURL

curl -L -X POST 'https://$CUSTOM-DOMAIN/auth/v1/users/me/metadata/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "queries": [
    {
      "keyQuery": {
        "key": "key",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      }
    }
  ]
}'

java / OkHttp

curl -L -X POST 'https://$CUSTOM-DOMAIN/auth/v1/users/me/metadata/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "queries": [
    {
      "keyQuery": {
        "key": "key",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      }
    }
  ]
}'

powershell / RestMethod

curl -L -X POST 'https://$CUSTOM-DOMAIN/auth/v1/users/me/metadata/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "query": {
    "offset": "0",
    "limit": 100,
    "asc": true
  },
  "queries": [
    {
      "keyQuery": {
        "key": "key",
        "method": "TEXT_QUERY_METHOD_EQUALS"
      }
    }
  ]
}'