Search User Metadata
POSThttps://$CUSTOM-DOMAIN/management/v1/users/:id/metadata/_search
deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
Deprecated: use ListUserMetadata instead.
Get the metadata of a user filtered by your query.
Request​
Path Parameters
id 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.
- application/json
- application/grpc
- application/grpc-web+proto
Bodyrequired
query object
queries object[]
Bodyrequired
query object
queries object[]
Bodyrequired
query object
queries object[]
Responses​
- 200
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (auto)
Schema
details object
result object[]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-07-29T15:51:28.071Z"
},
"result": [
{
"details": {
"sequence": "2",
"creationDate": "2024-07-29T15:51:28.071Z",
"changeDate": "2024-07-29T15:51:28.071Z",
"resourceOwner": "69629023906488334"
},
"key": "key1",
"value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
}
]
}
- Schema
- Example (auto)
Schema
details object
result object[]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-07-29T15:51:28.071Z"
},
"result": [
{
"details": {
"sequence": "2",
"creationDate": "2024-07-29T15:51:28.071Z",
"changeDate": "2024-07-29T15:51:28.071Z",
"resourceOwner": "69629023906488334"
},
"key": "key1",
"value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
}
]
}
- Schema
- Example (auto)
Schema
details object
result object[]
{
"details": {
"totalResult": "2",
"processedSequence": "267831",
"viewTimestamp": "2024-07-29T15:51:28.071Z"
},
"result": [
{
"details": {
"sequence": "2",
"creationDate": "2024-07-29T15:51:28.071Z",
"changeDate": "2024-07-29T15:51:28.071Z",
"resourceOwner": "69629023906488334"
},
"key": "key1",
"value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
}
]
}
An unexpected error response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (auto)
Schema
codeint32
messagestring
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (auto)
Schema
codeint32
messagestring
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
- Schema
- Example (auto)
Schema
codeint32
messagestring
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Authorization: oauth2
name: OAuth2type: oauth2scopes:openid,urn:zitadel:iam:org:project:id:zitadel:aud
flows: { "authorizationCode": { "authorizationUrl": "$CUSTOM-DOMAIN/oauth/v2/authorize", "tokenUrl": "$CUSTOM-DOMAIN/oauth/v2/token", "scopes": { "openid": "openid", "urn:zitadel:iam:org:project:id:zitadel:aud": "urn:zitadel:iam:org:project:id:zitadel:aud" } } }
- csharp
- curl
- dart
- go
- http
- java
- javascript
- kotlin
- c
- nodejs
- objective-c
- ocaml
- php
- powershell
- python
- r
- ruby
- rust
- shell
- swift
- HTTPCLIENT
- RESTSHARP
ResponseClear