Get Organization Metadata By Key
Get a metadata object from an organization by a specific key.
Path Parameters
- key string required
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.
- 200
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
metadata object
details object
sequence uint64on 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-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs tokey stringmetadata key
value bytemetadata value is base64 encoded, make sure to decode to get the value
{
"metadata": {
"details": {
"sequence": "2",
"creationDate": "2023-05-02",
"changeDate": "2023-05-02",
"resourceOwner": "69629023906488334"
},
"key": "key1",
"value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
}
}
- Schema
- Example (from schema)
Schema
metadata object
details object
sequence uint64on 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-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs tokey stringmetadata key
value bytemetadata value is base64 encoded, make sure to decode to get the value
{
"metadata": {
"details": {
"sequence": "2",
"creationDate": "2023-05-02",
"changeDate": "2023-05-02",
"resourceOwner": "69629023906488334"
},
"key": "key1",
"value": "VGhpcyBpcyBteSBmaXJzdCB2YWx1ZQ=="
}
}
- Schema
- Example (from schema)
Schema
metadata object
details object
sequence uint64on 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-timeon read: the timestamp of the first event of the object
on create: the timestamp of the event(s) added by the manipulation
changeDate date-timeon read: the timestamp of the last event reduced by the projection
on manipulation: the
resourceOwner resource_owner is the organization an object belongs tokey stringmetadata key
value bytemetadata value is base64 encoded, make sure to decode to get the value
{
"metadata": {
"details": {
"sequence": "2",
"creationDate": "2023-05-02",
"changeDate": "2023-05-02",
"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"
}
]
}