LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 20:37:46 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
ed1043e2b57e16fa61926ea035a46e315d8a1a4b
developer.sailpoint.com/docs/tools/sdk/python/Reference/V2024/Methods/IdentitiesApi.md
darrell-thobe-sp ed1043e2b5 updating method docs for python sdk
2025-02-20 13:59:30 -05:00

45 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
v2024-identities Identities Identities Identities pythonsdk
python
Python
sdk
Identities
V2024Identities
/tools/sdk/python/v2024/methods/identities
SDK
Software Development Kit
Identities
V2024Identities

sailpoint.v2024.IdentitiesApi

Use this API to implement identity functionality. With this functionality in place, administrators can synchronize an identity's attributes with its various source attributes.

Identity Security Cloud uses identities as users' authoritative accounts. Identities can own other accounts, entitlements, and attributes.

An identity has a variety of attributes, such as an account name, an email address, a job title, and more. These identity attributes can be correlated with different attributes on different sources. For example, the identity John.Smith can own an account in the GitHub source with the account name John-Smith-Org, and Identity Security Cloud knows they are the same person with the same access and attributes.

In Identity Security Cloud, administrators often set up these synchronizations to get triggered automatically with a change or to run on a schedule. To manually synchronize attributes for an identity, administrators can use the Identities drop-down menu and select Identity List to view the list of identities. They can then select the identity they want to manually synchronize and use the hamburger menu to select 'Synchronize Attributes.' Doing so immediately begins the attribute synchronization and analyzes all accounts for the selected identity.

Refer to Synchronizing Attributes for more information about synchronizing attributes.

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

Method HTTP request Description
delete-identity DELETE /identities/{id} Delete identity
get-identity GET /identities/{id} Identity Details
get-identity-ownership-details GET /identities/{identityId}/ownership Get ownership details
get-role-assignment GET /identities/{identityId}/role-assignments/{assignmentId} Role assignment details
get-role-assignments GET /identities/{identityId}/role-assignments List role assignments
list-identities GET /identities List Identities
reset-identity POST /identities/{id}/reset Reset an identity
send-identity-verification-account-token POST /identities/{id}/verification/account/send Send password reset email
start-identities-invite POST /identities/invite Invite identities to register
start-identity-processing POST /identities/process Process a list of identityIds
synchronize-attributes-for-identity POST /identities/{identityId}/synchronize-attributes Attribute synchronization for single identity.

delete-identity

:::warning 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. ::: Delete identity The API returns successful response if the requested identity was deleted.

API Spec

Parameters

Param Type Name Data Type Required Description
Path id str True Identity Id
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.

Return type

(empty response body)

Responses

Code Description Data Type Response headers
204 No content - indicates the request was successful but there is no content to be returned in the response. -
400 Client Error - Returned if the request is invalid. It may indicate that the specified identity is marked as protected and cannot be deleted. IdentityAssociationDetails -
401 Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
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.v2024
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')

    try:
        # Delete identity
        
        api_instance.delete_identity(id, x_sail_point_experimental)
        
        # Below is a request that includes all optional parameters
        # api_instance.delete_identity(id, x_sail_point_experimental)
    except Exception as e:
        print("Exception when calling IdentitiesApi->delete_identity: %s\n" % e)

[Back to top]

get-identity

:::warning 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. ::: Identity Details This API returns a single identity using the Identity ID.

API Spec

Parameters

Param Type Name Data Type Required Description
Path id str True Identity Id
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.

Return type

Identity

Responses

Code Description Data Type Response headers
200 An identity object Identity -
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. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
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.v2024
from sailpoint.v2024.models.identity import Identity
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')

    try:
        # Identity Details
        
        api_response = api_instance.get_identity(id, x_sail_point_experimental)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.get_identity(id, x_sail_point_experimental)
        print("The response of IdentitiesApi->get_identity:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentitiesApi->get_identity: %s\n" % e)

[Back to top]

get-identity-ownership-details

:::warning 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. ::: Get ownership details Use this API to return an identity's owned objects that will cause problems for deleting the identity. Use this API as a checklist of objects that you need to reassign to a different identity before you can delete the identity. For a full list of objects owned by an identity, use the Search API. When you search for identities, the returned identities have a property, owns, that contains a more comprehensive list of identity's owned objects.

API Spec

Parameters

Param Type Name Data Type Required Description
Path identity_id str True Identity ID.
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.

Return type

IdentityOwnershipAssociationDetails

Responses

Code Description Data Type Response headers
200 Identity's ownership association details. IdentityOwnershipAssociationDetails -
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. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
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.v2024
from sailpoint.v2024.models.identity_ownership_association_details import IdentityOwnershipAssociationDetails
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    identity_id = 'ff8081814d2a8036014d701f3fbf53fa' # str | Identity ID. # str | Identity ID.
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')

    try:
        # Get ownership details
        
        api_response = api_instance.get_identity_ownership_details(identity_id, x_sail_point_experimental)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.get_identity_ownership_details(identity_id, x_sail_point_experimental)
        print("The response of IdentitiesApi->get_identity_ownership_details:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentitiesApi->get_identity_ownership_details: %s\n" % e)

[Back to top]

get-role-assignment

:::warning 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. ::: Role assignment details

API Spec

Parameters

Param Type Name Data Type Required Description
Path identity_id str True Identity Id
Path assignment_id str True Assignment Id
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.

Return type

RoleAssignmentDto

Responses

Code Description Data Type Response headers
200 A role assignment object RoleAssignmentDto -
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. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
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.v2024
from sailpoint.v2024.models.role_assignment_dto import RoleAssignmentDto
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id
    assignment_id = '1cbb0705b38c4226b1334eadd8874086' # str | Assignment Id # str | Assignment Id
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')

    try:
        # Role assignment details
        
        api_response = api_instance.get_role_assignment(identity_id, assignment_id, x_sail_point_experimental)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.get_role_assignment(identity_id, assignment_id, x_sail_point_experimental)
        print("The response of IdentitiesApi->get_role_assignment:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentitiesApi->get_role_assignment: %s\n" % e)

[Back to top]

get-role-assignments

:::warning 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. ::: List role assignments This returns either a list of Role Assignments when querying with either a Role Id or Role Name, or a list of Role Assignment References if querying with only identity Id.

API Spec

Parameters

Param Type Name Data Type Required Description
Path identity_id str True Identity Id to get the role assignments for
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.
Query role_id str (optional) Role Id to filter the role assignments with
Query role_name str (optional) Role name to filter the role assignments with

Return type

List[GetRoleAssignments200ResponseInner]

Responses

Code Description Data Type Response headers
200 A role assignment object List[GetRoleAssignments200ResponseInner] -
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. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
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.v2024
from sailpoint.v2024.models.get_role_assignments200_response_inner import GetRoleAssignments200ResponseInner
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id to get the role assignments for # str | Identity Id to get the role assignments for
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    role_id = 'e7697a1e96d04db1ac7b0f4544915d2c' # str | Role Id to filter the role assignments with (optional) # str | Role Id to filter the role assignments with (optional)
    role_name = 'Engineer' # str | Role name to filter the role assignments with (optional) # str | Role name to filter the role assignments with (optional)

    try:
        # List role assignments
        
        api_response = api_instance.get_role_assignments(identity_id, x_sail_point_experimental, )
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.get_role_assignments(identity_id, x_sail_point_experimental, role_id, role_name)
        print("The response of IdentitiesApi->get_role_assignments:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e)

[Back to top]

list-identities

:::warning 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. ::: List Identities This API returns a list of identities.

API Spec

Parameters

Param Type Name Data Type Required Description
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.
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: id: eq, in name: eq, sw alias: eq, sw firstname: eq, sw lastname: eq, sw email: eq, sw cloudStatus: eq processingState: eq correlated: eq protected: 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, alias, cloudStatus
Query default_filter str (optional) (default to CORRELATED_ONLY) Adds additional filter to filters query parameter. CORRELATED_ONLY adds correlated=true and returns only identities that are correlated. NONE does not add any and returns all identities that satisfy filters query parameter.
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 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[Identity]

Responses

Code Description Data Type Response headers
200 List of identities. List[Identity] -
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. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
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.v2024
from sailpoint.v2024.models.identity import Identity
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    filters = 'id eq \"6c9079b270a266a60170a2779fcb0006\" or correlated eq false' # 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:  **id**: *eq, in*  **name**: *eq, sw*  **alias**: *eq, sw*  **firstname**: *eq, sw*  **lastname**: *eq, sw*  **email**: *eq, sw*  **cloudStatus**: *eq*  **processingState**: *eq*  **correlated**: *eq*  **protected**: *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:  **id**: *eq, in*  **name**: *eq, sw*  **alias**: *eq, sw*  **firstname**: *eq, sw*  **lastname**: *eq, sw*  **email**: *eq, sw*  **cloudStatus**: *eq*  **processingState**: *eq*  **correlated**: *eq*  **protected**: *eq* (optional)
    sorters = 'name,-cloudStatus' # 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, alias, cloudStatus** (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, alias, cloudStatus** (optional)
    default_filter = CORRELATED_ONLY # str | Adds additional filter to filters query parameter.  CORRELATED_ONLY adds correlated=true and returns only identities that are correlated.  NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to CORRELATED_ONLY) # str | Adds additional filter to filters query parameter.  CORRELATED_ONLY adds correlated=true and returns only identities that are correlated.  NONE does not add any and returns all identities that satisfy filters query parameter. (optional) (default to CORRELATED_ONLY)
    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)
    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:
        # List Identities
        
        api_response = api_instance.list_identities(x_sail_point_experimental, )
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.list_identities(x_sail_point_experimental, filters, sorters, default_filter, count, limit, offset)
        print("The response of IdentitiesApi->list_identities:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentitiesApi->list_identities: %s\n" % e)

[Back to top]

reset-identity

:::warning 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. ::: Reset an identity Use this endpoint to reset a user's identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have.

API Spec

Parameters

Param Type Name Data Type Required Description
Path identity_id str True Identity Id
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.

Return type

(empty response body)

Responses

Code Description Data Type Response headers
202 Accepted. The reset request accepted and is in progress. -
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. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
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.v2024
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')

    try:
        # Reset an identity
        
        api_instance.reset_identity(identity_id, x_sail_point_experimental)
        
        # Below is a request that includes all optional parameters
        # api_instance.reset_identity(identity_id, x_sail_point_experimental)
    except Exception as e:
        print("Exception when calling IdentitiesApi->reset_identity: %s\n" % e)

[Back to top]

send-identity-verification-account-token

:::warning 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. ::: Send password reset email This API sends an email with the link to start Password Reset. After selecting the link an identity will be able to set up a new password. Emails expire after 2 hours.

API Spec

Parameters

Param Type Name Data Type Required Description
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.
Path id str True Identity ID
Body send_account_verification_request SendAccountVerificationRequest True

Return type

(empty response body)

Responses

Code Description Data Type Response headers
200 The email was successfully sent -
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. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

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

Example

import sailpoint.v2024
from sailpoint.v2024.models.send_account_verification_request import SendAccountVerificationRequest
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID
    send_account_verification_request = {
          "sourceName" : "Active Directory Source",
          "via" : "EMAIL_WORK"
        } # SendAccountVerificationRequest | 

    try:
        # Send password reset email
        Result = send_account_verification_request.from_json(send_account_verification_request)
        api_instance.send_identity_verification_account_token(x_sail_point_experimental, id, Result)
        
        # Below is a request that includes all optional parameters
        # api_instance.send_identity_verification_account_token(x_sail_point_experimental, id, Result)
    except Exception as e:
        print("Exception when calling IdentitiesApi->send_identity_verification_account_token: %s\n" % e)

[Back to top]

start-identities-invite

:::warning 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. ::: Invite identities to register This API submits a task for inviting given identities via email to complete registration. The invitation email will include the link. After selecting the link an identity will be able to set up password and log in into the system. Invitations expire after 7 days. By default invitations send to the work identity email. It can be changed in Admin > Identities > Identity Profiles by selecting corresponding profile and editing Invitation Options.

This task will send an invitation email only for unregistered identities.

The executed task status can be checked by Task Management > Get task status by ID.

API Spec

Parameters

Param Type Name Data Type Required Description
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.
Body invite_identities_request InviteIdentitiesRequest True

Return type

TaskStatus

Responses

Code Description Data Type Response headers
202 Responds with an initial TaskStatus for the executed task TaskStatus -
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. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

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

Example

import sailpoint.v2024
from sailpoint.v2024.models.invite_identities_request import InviteIdentitiesRequest
from sailpoint.v2024.models.task_status import TaskStatus
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    invite_identities_request = {
          "ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ],
          "uninvited" : false
        } # InviteIdentitiesRequest | 

    try:
        # Invite identities to register
        Result = invite_identities_request.from_json(invite_identities_request)
        api_response = api_instance.start_identities_invite(x_sail_point_experimental, Result)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.start_identities_invite(x_sail_point_experimental, Result)
        print("The response of IdentitiesApi->start_identities_invite:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentitiesApi->start_identities_invite: %s\n" % e)

[Back to top]

start-identity-processing

:::warning 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. ::: Process a list of identityIds This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of event-based processing and scheduled processing that runs every day at 8:00 AM and 8:00 PM in the tenant's timezone to keep your identities synchronized.

This endpoint will perform the following tasks:

  1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it's expected to change).
  2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles.
  3. Enforce provisioning for any assigned accesses that haven't been fulfilled (e.g. failure due to source health).
  4. Recalculate manager relationships.
  5. Potentially clean-up identity processing errors, assuming the error has been resolved.

API Spec

Parameters

Param Type Name Data Type Required Description
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.
Body process_identities_request ProcessIdentitiesRequest True

Return type

TaskResultResponse

Responses

Code Description Data Type Response headers
202 Object containing the DTO type TASK_RESULT and the job id for the task TaskResultResponse -
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. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
500 Internal Server Error - Returned if there is an unexpected error. ErrorResponseDto -

HTTP request headers

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

Example

import sailpoint.v2024
from sailpoint.v2024.models.process_identities_request import ProcessIdentitiesRequest
from sailpoint.v2024.models.task_result_response import TaskResultResponse
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    process_identities_request = {
          "identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ]
        } # ProcessIdentitiesRequest | 

    try:
        # Process a list of identityIds
        Result = process_identities_request.from_json(process_identities_request)
        api_response = api_instance.start_identity_processing(x_sail_point_experimental, Result)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.start_identity_processing(x_sail_point_experimental, Result)
        print("The response of IdentitiesApi->start_identity_processing:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentitiesApi->start_identity_processing: %s\n" % e)

[Back to top]

synchronize-attributes-for-identity

:::warning 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. ::: Attribute synchronization for single identity. This end-point performs attribute synchronization for a selected identity. The endpoint can be called once in 10 seconds per identity.

API Spec

Parameters

Param Type Name Data Type Required Description
Path identity_id str True The Identity id
x_sail_point_experimental str True (default to 'true') Use this header to enable this experimental API.

Return type

IdentitySyncJob

Responses

Code Description Data Type Response headers
202 An Identity Sync job IdentitySyncJob -
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. ListAccessProfiles401Response -
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. ListAccessProfiles429Response -
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.v2024
from sailpoint.v2024.models.identity_sync_job import IdentitySyncJob
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    identity_id = 'identity_id_example' # str | The Identity id # str | The Identity id
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')

    try:
        # Attribute synchronization for single identity.
        
        api_response = api_instance.synchronize_attributes_for_identity(identity_id, x_sail_point_experimental)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.synchronize_attributes_for_identity(identity_id, x_sail_point_experimental)
        print("The response of IdentitiesApi->synchronize_attributes_for_identity:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentitiesApi->synchronize_attributes_for_identity: %s\n" % e)

[Back to top]