Search Events​
Returns a list of the possible event types in ZITADEL. This is used to filter the event types in the list events request.
Request Body required
Sequence represents the order of events. It's always counting. If asc is false, the sequence is used as lesser than filter. If asc is true sequence is used as greater than filter. If the sequence is 0 the field is ignored.
Maximum amount of events returned.
default is descending sorting order
The types are filtered by 'or' and must match the type exactly.
Use from instead.
range object
The events returned are younger than the UTC since date
The events returned are older than the UTC until date.
If asc is false, the events returned are older than the UTC from date. If asc is true, the events returned are younger than from.
Request Body required
Sequence represents the order of events. It's always counting. If asc is false, the sequence is used as lesser than filter. If asc is true sequence is used as greater than filter. If the sequence is 0 the field is ignored.
Maximum amount of events returned.
default is descending sorting order
The types are filtered by 'or' and must match the type exactly.
Use from instead.
range object
The events returned are younger than the UTC since date
The events returned are older than the UTC until date.
If asc is false, the events returned are older than the UTC from date. If asc is true, the events returned are younger than from.
Request Body required
Sequence represents the order of events. It's always counting. If asc is false, the sequence is used as lesser than filter. If asc is true sequence is used as greater than filter. If the sequence is 0 the field is ignored.
Maximum amount of events returned.
default is descending sorting order
The types are filtered by 'or' and must match the type exactly.
Use from instead.
range object
The events returned are younger than the UTC since date
The events returned are older than the UTC until date.
If asc is false, the events returned are older than the UTC from date. If asc is true, the events returned are younger than from.
- 200
- 403
- 404
- default
A successful response.
Schema
- Array [
- ]
events object[]
editor object
aggregate object
type object
localized object
The timestamp the event occurred
Payload contains the data of the event.
type object
localized object
{
"events": [
{
"editor": {
"userId": "165617389845094785",
"displayName": "Minnie Mouse",
"service": "Management-API"
},
"aggregate": {
"id": "165617850743094785",
"type": {
"type": "user",
"localized": {
"key": "string",
"localizedMessage": "string"
}
},
"resourceOwner": "165617850930497249"
},
"sequence": "string",
"creationDate": "2019-04-01T08:45:00.000000Z",
"payload": {
"firstName": "Gigi",
"lastName": "Giraffe",
"userName": "gigi@zitadel.com",
"displayName": "Gigi"
},
"type": {
"type": "user.human.added",
"localized": {
"key": "string",
"localizedMessage": "string"
}
}
}
]
}
Schema
- Array [
- ]
events object[]
editor object
aggregate object
type object
localized object
The timestamp the event occurred
Payload contains the data of the event.
type object
localized object
{
"events": [
{
"editor": {
"userId": "165617389845094785",
"displayName": "Minnie Mouse",
"service": "Management-API"
},
"aggregate": {
"id": "165617850743094785",
"type": {
"type": "user",
"localized": {
"key": "string",
"localizedMessage": "string"
}
},
"resourceOwner": "165617850930497249"
},
"sequence": "string",
"creationDate": "2019-04-01T08:45:00.000000Z",
"payload": {
"firstName": "Gigi",
"lastName": "Giraffe",
"userName": "gigi@zitadel.com",
"displayName": "Gigi"
},
"type": {
"type": "user.human.added",
"localized": {
"key": "string",
"localizedMessage": "string"
}
}
}
]
}
Schema
- Array [
- ]
events object[]
editor object
aggregate object
type object
localized object
The timestamp the event occurred
Payload contains the data of the event.
type object
localized object
{
"events": [
{
"editor": {
"userId": "165617389845094785",
"displayName": "Minnie Mouse",
"service": "Management-API"
},
"aggregate": {
"id": "165617850743094785",
"type": {
"type": "user",
"localized": {
"key": "string",
"localizedMessage": "string"
}
},
"resourceOwner": "165617850930497249"
},
"sequence": "string",
"creationDate": "2019-04-01T08:45:00.000000Z",
"payload": {
"firstName": "Gigi",
"lastName": "Giraffe",
"userName": "gigi@zitadel.com",
"displayName": "Gigi"
},
"type": {
"type": "user.human.added",
"localized": {
"key": "string",
"localizedMessage": "string"
}
}
}
]
}
Returned when the user does not have permission to access the resource.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Returned when the resource does not exist.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
An unexpected error response.
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}
Schema
- Array [
- ]
details object[]
{
"code": 0,
"message": "string",
"details": [
{
"@type": "string"
}
]
}