Skip to main content

Get User History​

Returns a list of changes/events that have happened on the user. It's the history of the user. Make sure to send a limit.

Path Parameters
    userId 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.

Request Body required
    query object

    Filter possibility for the changes/history of an Object.

    sequence uint64

    sequence represents the order of events. It's always counting

    limit int64

    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 no limit is set or the limit exceeds the maximum configured ZITADEL will throw an error. If no limit is present the default is taken.

    asc boolean

    default is descending

Responses

A successful response.

Schema
    result object[]
  • Array [
    • changeDate date-time

    the creation date of an event

    eventType object
    key string
    localizedMessage string
    sequence uint64
    editorId string

    the id of the user who created the event

    editorDisplayName string

    the display name of the editor

    resourceOwnerId string

    the organization the event belongs to

    editorPreferredLoginName string

    the preferred login name of the editor

    editorAvatarUrl string

    avatar URL of the editor

  • ]
POST /users/:userId/changes/_search

Authorization

name: OAuth2type: oauth2scopes: openid,urn:zitadel:iam:org:project:id:zitadel:audflows: {
  "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"
    }
  }
}

Request

Base URL
https://$CUSTOM-DOMAIN/management/v1
Bearer Token
userId — path required
x-zitadel-orgid — header
Content-Type
Body required
{

  "query": {

    "sequence": "2",

    "limit": 20,

    "asc": true

  }

}
Accept
curl / cURL
curl -L -X POST 'https://$CUSTOM-DOMAIN/management/v1/users/:userId/changes/_search' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
--data-raw '{
  "query": {
    "sequence": "2",
    "limit": 20,
    "asc": true
  }
}'