LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 04:19:37 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
c18583ede42a304c32efd868e2da9a4113314b1f
developer.sailpoint.com/docs/tools/sdk/python/Reference/Beta/Methods/IdentityHistoryApi.md
darrell-thobe-sp c18583ede4 starting point for adding python sdk docs
2025-02-20 12:59:19 -05:00

58 KiB
Raw Blame History

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags
id title pagination_label sidebar_label sidebar_class_name keywords slug tags
beta-identity-history Identity_History Identity_History Identity_History pythonsdk
python
Python
sdk
Identity_History
BetaIdentity_History
/tools/sdk/python/beta/methods/identity-history
SDK
Software Development Kit
Identity_History
BetaIdentity_History

sailpoint.beta.IdentityHistoryApi

All URIs are relative to https://sailpoint.api.identitynow.com/beta

Method HTTP request Description
compare_identity_snapshots GET /historical-identities/{id}/compare Gets a difference of count for each access item types for the given identity between 2 snapshots
compare_identity_snapshots_access_type GET /historical-identities/{id}/compare/{accessType} Gets a list of differences of specific accessType for the given identity between 2 snapshots
get_historical_identity GET /historical-identities/{id} Get latest snapshot of identity
get_historical_identity_events GET /historical-identities/{id}/events Lists all events for the given identity
get_identity_snapshot GET /historical-identities/{id}/snapshots/{date} Gets an identity snapshot at a given date
get_identity_snapshot_summary GET /historical-identities/{id}/snapshot-summary Gets the summary for the event count for a specific identity
get_identity_start_date GET /historical-identities/{id}/start-date Gets the start date of the identity
list_historical_identities GET /historical-identities Lists all the identities
list_identity_access_items GET /historical-identities/{id}/access-items List Access Items by Identity
list_identity_snapshot_access_items GET /historical-identities/{id}/snapshots/{date}/access-items Get Identity Access Items Snapshot
list_identity_snapshots GET /historical-identities/{id}/snapshots Lists all the snapshots for the identity

compare-identity-snapshots

Gets a difference of count for each access item types for the given identity between 2 snapshots This method gets a difference of count for each access item types for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read'

API Spec

Parameters

Param Type Name Data Type Required Description
Path id str True The identity id
Query snapshot1 str (optional) The snapshot 1 of identity
Query snapshot2 str (optional) The snapshot 2 of identity
Query access_item_types []str (optional) An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned
Query limit int (optional) (default to 250) Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query offset int (optional) (default to 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.
Query count bool (optional) (default to False) 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.

Return type

List[IdentityCompareResponse]

Responses

Code Description Data Type Response headers
200 A IdentityCompare object with difference details for each access item type List[IdentityCompareResponse] -
400 Client Error - Returned if the request body is invalid. ErrorResponseDto -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response -
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto -
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import sailpoint.beta
from sailpoint.beta.models.identity_compare_response import IdentityCompareResponse
from sailpoint.beta.rest import ApiException
from pprint import pprint

    id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
    snapshot1 = '2007-03-01T13:00:00Z' # str | The snapshot 1 of identity (optional) # str | The snapshot 1 of identity (optional)
    snapshot2 = '2008-03-01T13:00:00Z' # str | The snapshot 2 of identity (optional) # str | The snapshot 2 of identity (optional)
    access_item_types = ['access_item_types_example'] # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return.   If null or empty, all access items types are returned  (optional)
    
    access_item_types = ['access_item_types_example'] # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return.   If null or empty, all access items types are returned  (optional)
    limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
    offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
    count = False # bool | 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False)

    try:
        # Gets a difference of count for each access item types for the given identity between 2 snapshots
        
        api_response = api_instance.compare_identity_snapshots(id, )
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.compare_identity_snapshots(id, snapshot1, snapshot2, access_item_types, limit, offset, count)
        print("The response of IdentityHistoryApi->compare_identity_snapshots:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentityHistoryApi->compare_identity_snapshots: %s\n" % e)

[Back to top]

compare-identity-snapshots-access-type

Gets a list of differences of specific accessType for the given identity between 2 snapshots This method gets a list of differences of specific accessType for the given identity between 2 snapshots Requires authorization scope of 'idn:identity-history:read'

API Spec

Parameters

Param Type Name Data Type Required Description
Path id str True The identity id
Path access_type str True The specific type which needs to be compared
Query access_associated bool (optional) Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed
Query snapshot1 str (optional) The snapshot 1 of identity
Query snapshot2 str (optional) The snapshot 2 of identity
Query limit int (optional) (default to 250) Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query offset int (optional) (default to 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.
Query count bool (optional) (default to False) 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.

Return type

List[AccessItemDiff]

Responses

Code Description Data Type Response headers
200 A list of events for the identity List[AccessItemDiff] -
400 Client Error - Returned if the request body is invalid. ErrorResponseDto -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response -
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto -
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import sailpoint.beta
from sailpoint.beta.models.access_item_diff import AccessItemDiff
from sailpoint.beta.rest import ApiException
from pprint import pprint

    id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
    access_type = 'role' # str | The specific type which needs to be compared # str | The specific type which needs to be compared
    access_associated = 2007-03-01T13:00:00Z # bool | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional) # bool | Indicates if added or removed access needs to be returned. true - added, false - removed, null - both added & removed (optional)
    snapshot1 = '2008-03-01T13:00:00Z' # str | The snapshot 1 of identity (optional) # str | The snapshot 1 of identity (optional)
    snapshot2 = '2009-03-01T13:00:00Z' # str | The snapshot 2 of identity (optional) # str | The snapshot 2 of identity (optional)
    limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
    offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
    count = False # bool | 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False)

    try:
        # Gets a list of differences of specific accessType for the given identity between 2 snapshots
        
        api_response = api_instance.compare_identity_snapshots_access_type(id, access_type, )
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.compare_identity_snapshots_access_type(id, access_type, access_associated, snapshot1, snapshot2, limit, offset, count)
        print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentityHistoryApi->compare_identity_snapshots_access_type: %s\n" % e)

[Back to top]

get-historical-identity

Get latest snapshot of identity This method retrieves a specified identity Requires authorization scope of 'idn:identity-history:read'

API Spec

Parameters

Param Type Name Data Type Required Description
Path id str True The identity id

Return type

IdentityHistoryResponse

Responses

Code Description Data Type Response headers
200 The identity object. IdentityHistoryResponse -
400 Client Error - Returned if the request body is invalid. ErrorResponseDto -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response -
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto -
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessModelMetadataAttribute429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import sailpoint.beta
from sailpoint.beta.models.identity_history_response import IdentityHistoryResponse
from sailpoint.beta.rest import ApiException
from pprint import pprint

    id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id

    try:
        # Get latest snapshot of identity
        
        api_response = api_instance.get_historical_identity(id)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.get_historical_identity(id)
        print("The response of IdentityHistoryApi->get_historical_identity:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentityHistoryApi->get_historical_identity: %s\n" % e)

[Back to top]

get-historical-identity-events

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

API Spec

Parameters

Param Type Name Data Type Required Description
Path id str True The identity id
Query var_from str (optional) The optional instant until which access events are returned
Query event_types []str (optional) An optional list of event types to return. If null or empty, all events are returned
Query access_item_types []str (optional) An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned
Query limit int (optional) (default to 250) Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query offset int (optional) (default to 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.
Query count bool (optional) (default to False) 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.

Return type

List[GetHistoricalIdentityEvents200ResponseInner]

Responses

Code Description Data Type Response headers
200 The list of events for the identity List[GetHistoricalIdentityEvents200ResponseInner] -
400 Client Error - Returned if the request body is invalid. ErrorResponseDto -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response -
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto -
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto -
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessModelMetadataAttribute429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import sailpoint.beta
from sailpoint.beta.models.get_historical_identity_events200_response_inner import GetHistoricalIdentityEvents200ResponseInner
from sailpoint.beta.rest import ApiException
from pprint import pprint

    id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
    var_from = '2024-03-01T13:00:00Z' # str | The optional instant until which access events are returned (optional) # str | The optional instant until which access events are returned (optional)
    event_types = ['[AccessAddedEvent, AccessRemovedEvent]'] # List[str] | An optional list of event types to return.  If null or empty, all events are returned (optional)
    
    event_types = ['[AccessAddedEvent, AccessRemovedEvent]'] # List[str] | An optional list of event types to return.  If null or empty, all events are returned (optional)
    access_item_types = ['[entitlement, account]'] # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return.   If null or empty, all access items types are returned (optional)
    
    access_item_types = ['[entitlement, account]'] # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return.   If null or empty, all access items types are returned (optional)
    limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
    offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
    count = False # bool | 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False)

    try:
        # Lists all events for the given identity
        
        api_response = api_instance.get_historical_identity_events(id, )
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.get_historical_identity_events(id, var_from, event_types, access_item_types, limit, offset, count)
        print("The response of IdentityHistoryApi->get_historical_identity_events:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentityHistoryApi->get_historical_identity_events: %s\n" % e)

[Back to top]

get-identity-snapshot

Gets an identity snapshot at a given date This method retrieves a specified identity snapshot at a given date Requires authorization scope of 'idn:identity-history:read'

API Spec

Parameters

Param Type Name Data Type Required Description
Path id str True The identity id
Path var_date str True The specified date

Return type

IdentityHistoryResponse

Responses

Code Description Data Type Response headers
200 The identity object. IdentityHistoryResponse -
400 Client Error - Returned if the request body is invalid. ErrorResponseDto -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response -
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto -
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import sailpoint.beta
from sailpoint.beta.models.identity_history_response import IdentityHistoryResponse
from sailpoint.beta.rest import ApiException
from pprint import pprint

    id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
    var_date = '2007-03-01T13:00:00Z' # str | The specified date # str | The specified date

    try:
        # Gets an identity snapshot at a given date
        
        api_response = api_instance.get_identity_snapshot(id, var_date)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.get_identity_snapshot(id, var_date)
        print("The response of IdentityHistoryApi->get_identity_snapshot:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentityHistoryApi->get_identity_snapshot: %s\n" % e)

[Back to top]

get-identity-snapshot-summary

Gets the summary for the event count for a specific identity This method gets the summary for the event count for a specific identity by month/day Requires authorization scope of 'idn:identity-history:read'

API Spec

Parameters

Param Type Name Data Type Required Description
Path id str True The identity id
Query before str (optional) The date before which snapshot summary is required
Query interval str (optional) The interval indicating day or month. Defaults to month if not specified
Query time_zone str (optional) The time zone. Defaults to UTC if not provided
Query limit int (optional) (default to 250) Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query offset int (optional) (default to 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.
Query count bool (optional) (default to False) 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.

Return type

List[MetricResponse]

Responses

Code Description Data Type Response headers
200 A summary list of identity changes in date histogram format. List[MetricResponse] -
400 Client Error - Returned if the request body is invalid. ErrorResponseDto -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response -
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto -
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import sailpoint.beta
from sailpoint.beta.models.metric_response import MetricResponse
from sailpoint.beta.rest import ApiException
from pprint import pprint

    id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
    before = '2007-03-01T13:00:00Z' # str | The date before which snapshot summary is required (optional) # str | The date before which snapshot summary is required (optional)
    interval = 'interval_example' # str | The interval indicating day or month. Defaults to month if not specified (optional) # str | The interval indicating day or month. Defaults to month if not specified (optional)
    time_zone = 'UTC' # str | The time zone. Defaults to UTC if not provided (optional) # str | The time zone. Defaults to UTC if not provided (optional)
    limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
    offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
    count = False # bool | 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False)

    try:
        # Gets the summary for the event count for a specific identity
        
        api_response = api_instance.get_identity_snapshot_summary(id, )
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.get_identity_snapshot_summary(id, before, interval, time_zone, limit, offset, count)
        print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentityHistoryApi->get_identity_snapshot_summary: %s\n" % e)

[Back to top]

get-identity-start-date

Gets the start date of the identity This method retrieves start date of the identity Requires authorization scope of 'idn:identity-history:read'

API Spec

Parameters

Param Type Name Data Type Required Description
Path id str True The identity id

Return type

str

Responses

Code Description Data Type Response headers
200 The start date of the identity str -
400 Client Error - Returned if the request body is invalid. ErrorResponseDto -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response -
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto -
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import sailpoint.beta
from sailpoint.beta.rest import ApiException
from pprint import pprint

    id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id

    try:
        # Gets the start date of the identity
        
        api_response = api_instance.get_identity_start_date(id)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.get_identity_start_date(id)
        print("The response of IdentityHistoryApi->get_identity_start_date:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentityHistoryApi->get_identity_start_date: %s\n" % e)

[Back to top]

list-historical-identities

Lists all the identities This gets the list of identities for the customer. This list end point does not support count=true request param. The total count of identities would never be returned even if the count param is specified in the request Requires authorization scope of 'idn:identity-history:read'

API Spec

Parameters

Param Type Name Data Type Required Description
Query starts_with_query str (optional) This param is used for starts-with search for first, last and display name of the identity
Query is_deleted bool (optional) Indicates if we want to only list down deleted identities or not.
Query is_active bool (optional) Indicates if we want to only list active or inactive identities.
Query limit int (optional) (default to 250) Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query offset int (optional) (default to 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.

Return type

List[IdentityListItem]

Responses

Code Description Data Type Response headers
200 List of identities for the customer. List[IdentityListItem] -
400 Client Error - Returned if the request body is invalid. ErrorResponseDto -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response -
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto -
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessModelMetadataAttribute429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import sailpoint.beta
from sailpoint.beta.models.identity_list_item import IdentityListItem
from sailpoint.beta.rest import ApiException
from pprint import pprint

    starts_with_query = 'Ada' # str | This param is used for starts-with search for first, last and display name of the identity (optional) # str | This param is used for starts-with search for first, last and display name of the identity (optional)
    is_deleted = true # bool | Indicates if we want to only list down deleted identities or not. (optional) # bool | Indicates if we want to only list down deleted identities or not. (optional)
    is_active = true # bool | Indicates if we want to only list active or inactive identities. (optional) # bool | Indicates if we want to only list active or inactive identities. (optional)
    limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
    offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)

    try:
        # Lists all the identities
        
        api_response = api_instance.list_historical_identities()
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.list_historical_identities(starts_with_query, is_deleted, is_active, limit, offset)
        print("The response of IdentityHistoryApi->list_historical_identities:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentityHistoryApi->list_historical_identities: %s\n" % e)

[Back to top]

list-identity-access-items

List Access Items by Identity This method retrieves a list of access item for the identity filtered by the access item type

API Spec

Parameters

Param Type Name Data Type Required Description
Path id str True The identity id
Query type str (optional) The type of access item for the identity. If not provided, it defaults to account. Types of access items: accessProfile, account, app, entitlement, role
Query filters str (optional) Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: source: eq standalone: eq privileged: eq attribute: eq cloudGoverned: eq
Query sorters str (optional) Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: name, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount
Query query str (optional) This param is used to search if certain fields of the access item contain the string provided. Searching is supported for the following fields depending on the type: Access Profiles: name, description Accounts: name, nativeIdentity Apps: name Entitlements: name, value, description Roles: name, description
Query limit int (optional) (default to 250) Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query count bool (optional) (default to False) 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.
Query offset int (optional) (default to 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.

Return type

List[ListIdentityAccessItems200ResponseInner]

Responses

Code Description Data Type Response headers
200 The list of access items. List[ListIdentityAccessItems200ResponseInner] -
400 Client Error - Returned if the request body is invalid. ErrorResponseDto -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response -
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto -
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto -
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessModelMetadataAttribute429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import sailpoint.beta
from sailpoint.beta.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner
from sailpoint.beta.rest import ApiException
from pprint import pprint

    id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
    type = 'account' # str | The type of access item for the identity. If not provided, it defaults to account.  Types of access items: **accessProfile, account, app, entitlement, role** (optional) # str | The type of access item for the identity. If not provided, it defaults to account.  Types of access items: **accessProfile, account, app, entitlement, role** (optional)
    filters = 'source eq \"DataScienceDataset\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **source**: *eq*  **standalone**: *eq*  **privileged**: *eq*  **attribute**: *eq*  **cloudGoverned**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **source**: *eq*  **standalone**: *eq*  **privileged**: *eq*  **attribute**: *eq*  **cloudGoverned**: *eq* (optional)
    sorters = 'name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **name, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results)  Sorting is supported for the following fields: **name, value, standalone, privileged, attribute, source, cloudGoverned, removeDate, nativeIdentity, entitlementCount** (optional)
    query = 'Dr. Arden' # str | This param is used to search if certain fields of the access item contain the string provided.  Searching is supported for the following fields depending on the type:  Access Profiles: **name, description**  Accounts: **name, nativeIdentity**  Apps: **name**  Entitlements: **name, value, description**  Roles: **name, description** (optional) # str | This param is used to search if certain fields of the access item contain the string provided.  Searching is supported for the following fields depending on the type:  Access Profiles: **name, description**  Accounts: **name, nativeIdentity**  Apps: **name**  Entitlements: **name, value, description**  Roles: **name, description** (optional)
    limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
    count = False # bool | 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False)
    offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)

    try:
        # List Access Items by Identity
        
        api_response = api_instance.list_identity_access_items(id, )
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.list_identity_access_items(id, type, filters, sorters, query, limit, count, offset)
        print("The response of IdentityHistoryApi->list_identity_access_items:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentityHistoryApi->list_identity_access_items: %s\n" % e)

[Back to top]

list-identity-snapshot-access-items

Get Identity Access Items Snapshot Use this API to get a list of identity access items at a specified date, filtered by item type.

API Spec

Parameters

Param Type Name Data Type Required Description
Path id str True Identity ID.
Path var_date str True Specified date.
Query type str (optional) Access item type.

Return type

List[ListIdentityAccessItems200ResponseInner]

Responses

Code Description Data Type Response headers
200 Identity object. List[ListIdentityAccessItems200ResponseInner] -
400 Client Error - Returned if the request body is invalid. ErrorResponseDto -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response -
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto -
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto -
429 Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. ListAccessModelMetadataAttribute429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import sailpoint.beta
from sailpoint.beta.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner
from sailpoint.beta.rest import ApiException
from pprint import pprint

    id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | Identity ID. # str | Identity ID.
    var_date = '2007-03-01T13:00:00Z' # str | Specified date. # str | Specified date.
    type = 'account' # str | Access item type. (optional) # str | Access item type. (optional)

    try:
        # Get Identity Access Items Snapshot
        
        api_response = api_instance.list_identity_snapshot_access_items(id, var_date, )
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.list_identity_snapshot_access_items(id, var_date, type)
        print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentityHistoryApi->list_identity_snapshot_access_items: %s\n" % e)

[Back to top]

list-identity-snapshots

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

API Spec

Parameters

Param Type Name Data Type Required Description
Path id str True The identity id
Query start str (optional) The specified start date
Query interval str (optional) The interval indicating the range in day or month for the specified interval-name
Query limit int (optional) (default to 250) Max number of results to return. See V3 API Standard Collection Parameters for more information.
Query offset int (optional) (default to 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.
Query count bool (optional) (default to False) 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.

Return type

List[IdentitySnapshotSummaryResponse]

Responses

Code Description Data Type Response headers
200 A list of identity summary for each snapshot. List[IdentitySnapshotSummaryResponse] -
400 Client Error - Returned if the request body is invalid. ErrorResponseDto -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessModelMetadataAttribute401Response -
403 Forbidden - Returned if the user you are running as, doesn't have access to this end-point. ErrorResponseDto -
404 Not Found - returned if the request URL refers to a resource or object that does not exist ErrorResponseDto -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

import sailpoint.beta
from sailpoint.beta.models.identity_snapshot_summary_response import IdentitySnapshotSummaryResponse
from sailpoint.beta.rest import ApiException
from pprint import pprint

    id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
    start = '2007-03-01T13:00:00Z' # str | The specified start date (optional) # str | The specified start date (optional)
    interval = 'interval_example' # str | The interval indicating the range in day or month for the specified interval-name (optional) # str | The interval indicating the range in day or month for the specified interval-name (optional)
    limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
    offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
    count = False # bool | 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False)

    try:
        # Lists all the snapshots for the identity
        
        api_response = api_instance.list_identity_snapshots(id, )
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.list_identity_snapshots(id, start, interval, limit, offset, count)
        print("The response of IdentityHistoryApi->list_identity_snapshots:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentityHistoryApi->list_identity_snapshots: %s\n" % e)

[Back to top]