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.
- application/json
- application/grpc
- application/grpc-web+proto
Request Body required
- sequence uint64
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.
- limit int64
Maximum amount of events returned.
- asc boolean
default is descending sorting order
- editorUserId string
- eventTypes string[]
The types are filtered by 'or' and must match the type exactly.
- aggregateId string
- aggregateTypes string[]
- resourceOwner string
- creationDate date-time
If asc is false creation_date is used as less than filter If asc is true creation_date is used as greater than filter. If creation_date is not set the field is ignored.
Request Body required
- sequence uint64
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.
- limit int64
Maximum amount of events returned.
- asc boolean
default is descending sorting order
- editorUserId string
- eventTypes string[]
The types are filtered by 'or' and must match the type exactly.
- aggregateId string
- aggregateTypes string[]
- resourceOwner string
- creationDate date-time
If asc is false creation_date is used as less than filter If asc is true creation_date is used as greater than filter. If creation_date is not set the field is ignored.
Request Body required
- sequence uint64
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.
- limit int64
Maximum amount of events returned.
- asc boolean
default is descending sorting order
- editorUserId string
- eventTypes string[]
The types are filtered by 'or' and must match the type exactly.
- aggregateId string
- aggregateTypes string[]
- resourceOwner string
- creationDate date-time
If asc is false creation_date is used as less than filter If asc is true creation_date is used as greater than filter. If creation_date is not set the field is ignored.
- 200
- 403
- 404
- default
A successful response.
- application/json
- application/grpc
- application/grpc-web+proto
- Schema
- Example (from schema)
Schema
events object[]
Array [editor object
userId stringdisplayName stringservice stringaggregate object
id stringtype object
type stringlocalized object
key stringlocalizedMessage stringresourceOwner stringsequence uint64creationDate date-timeThe timestamp the event occurred
payload objectPayload contains the data of the event.
type object
type stringlocalized object
key stringlocalizedMessage string]
{
"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
- Example (from schema)
Schema
events object[]
Array [editor object
userId stringdisplayName stringservice stringaggregate object
id stringtype object
type stringlocalized object
key stringlocalizedMessage stringresourceOwner stringsequence uint64creationDate date-timeThe timestamp the event occurred
payload objectPayload contains the data of the event.
type object
type stringlocalized object
key stringlocalizedMessage string]
{
"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
- Example (from schema)
Schema
events object[]
Array [editor object
userId stringdisplayName stringservice stringaggregate object
id stringtype object
type stringlocalized object
key stringlocalizedMessage stringresourceOwner stringsequence uint64creationDate date-timeThe timestamp the event occurred
payload objectPayload contains the data of the event.
type object
type stringlocalized object
key stringlocalizedMessage string]
{
"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.
- 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"
}
]
}
Returned when the resource does not exist.
- 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"
}
]
}
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"
}
]
}