Search User Metadata
POST/users/:id/metadata/_search
Get the metadata of a user filtered by your query.
Request​
Path Parameters
Header Parameters
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.
- application/json
- application/grpc
- application/grpc-web+proto
Body
required
Array [
]
query
object
Object unspecific list filters like offset, limit and asc/desc.
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.
default is descending
queries
object[]
Metadata object-specific queries.
keyQuery
object
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
Body
required
Array [
]
query
object
Object unspecific list filters like offset, limit and asc/desc.
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.
default is descending
queries
object[]
Metadata object-specific queries.
keyQuery
object
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
Body
required
Array [
]
query
object
Object unspecific list filters like offset, limit and asc/desc.
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.
default is descending
queries
object[]
Metadata object-specific queries.
keyQuery
object
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
Array [
]
details
object
the last time the view got updated
result
object[]
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
metadata key
metadata value is base64 encoded, make sure to decode to get the value
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-12-06T11:34:47.245Z"
},
"result": [
{
"details": {
"sequence": "2",
"creationDate": "2024-12-06T11:34:47.245Z",
"changeDate": "2024-12-06T11:34:47.245Z",
"resourceOwner": "69629023906488334"
},
"key": "key1",
"value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object
the last time the view got updated
result
object[]
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
metadata key
metadata value is base64 encoded, make sure to decode to get the value
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-12-06T11:34:47.246Z"
},
"result": [
{
"details": {
"sequence": "2",
"creationDate": "2024-12-06T11:34:47.246Z",
"changeDate": "2024-12-06T11:34:47.246Z",
"resourceOwner": "69629023906488334"
},
"key": "key1",
"value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object
the last time the view got updated
result
object[]
details
object
on read: the sequence of the last event reduced by the projection
on manipulation: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
on read: the timestamp of the last event reduced by the projection
on manipulation: the
metadata key
metadata value is base64 encoded, make sure to decode to get the value
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-12-06T11:34:47.246Z"
},
"result": [
{
"details": {
"sequence": "2",
"creationDate": "2024-12-06T11:34:47.246Z",
"changeDate": "2024-12-06T11:34:47.246Z",
"resourceOwner": "69629023906488334"
},
"key": "key1",
"value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
}
]
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (from schema)
Schema
Array [
]
details
object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}