Skip to main content

Lists all events for the given identity

GET 
/historical-identities/:id/events
experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

This method retrieves all access events for the identity Requires authorization scope of 'idn:identity-history:read'

Request​

Path Parameters

    id stringrequired

    The identity id

    Example: 8c190e6787aa4ed9a90bd9d5344523fb

Query Parameters

    from string

    The optional instant until which access events are returned

    Example: 2024-03-01T13:00:00Z
    eventTypes string[]

    An optional list of event types to return. If null or empty, all events are returned

    Example: [AccessAddedEvent, AccessRemovedEvent]
    accessItemTypes string[]

    An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned

    Example: [entitlement, account]
    limit int32

    Possible values: <= 250

    Default value: 250

    Max number of results to return. See V3 API Standard Collection Parameters for more information.

    Example: 250
    offset int32

    Default value: 0

    Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.

    Example: 0
    count boolean

    If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

    Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

    See V3 API Standard Collection Parameters for more information.

    Example: true

Header Parameters

    X-SailPoint-Experimental stringrequired

    Default value: true

    Use this header to enable this experimental API.

    Example: true

Responses​

The list of events for the identity

Schema

  • Array [

    • anyOf

    accessItem

    object

    oneOf

    accessType string

    the access item type. accessProfile in this case

    id string

    the access item id

    name string

    the access profile name

    sourceName string

    the name of the source

    sourceId string

    the id of the source

    description string

    the description for the access profile

    displayName string

    the display name of the identity

    entitlementCount string

    the number of entitlements the access profile will create

    appDisplayName string

    the name of

    removeDate string

    the date the access profile is no longer assigned to the specified identity

    standalone booleanrequired

    indicates whether the access profile is standalone

    revocable booleanrequired

    indicates whether the access profile is

    identityId string

    the identity id

    eventType string

    the event type

    dt string

    the date of event

    governanceEvent

    object

    name string

    The name of the governance event, such as the certification name or access request ID.

    dt string

    The date that the certification or access request was completed.

    type string

    Possible values: [certification, accessRequest]

    The type of governance event.

    governanceId string

    The ID of the instance that caused the event - either the certification ID or access request ID.

    owners

    object[]

    The owners of the governance event (the certifiers or approvers)

  • Array [

    • id string

    the id of the certifier

    displayName string

    the name of the certifier

  • ]

    • reviewers

    object[]

    The owners of the governance event (the certifiers or approvers), this field should be preferred over owners

  • Array [

    • id string

    the id of the certifier

    displayName string

    the name of the certifier

  • ]

    • decisionMaker

    object

    The decision maker

    id string

    the id of the certifier

    displayName string

    the name of the certifier

  • ]

Loading...