Skip to main content

Lists all the snapshots for the identity

GET 

/historical-identities/:id/snapshots

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 the snapshots for the identity Requires authorization scope of 'idn:identity-history:read'

Request

Path Parameters

    id stringrequired

    The identity id

    Example: 8c190e6787aa4ed9a90bd9d5344523fb

Query Parameters

    start string

    The specified start date

    Example: 2007-03-01T13:00:00Z
    interval string

    Possible values: [day, month]

    The interval indicating the range in day or month for the specified interval-name

    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

A list of identity summary for each snapshot.

Schema

  • Array [

  • snapshot string

    the date when the identity record was created

  • ]

Loading...