LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-09 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update python SDK docs: 15116515953

Browse Source
This commit is contained in:
developer-relations-sp
2025-05-19 15:05:01 +00:00
parent d73e77c393
commit c8938e0862
279 changed files with 7276 additions and 7276 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
docs/tools/sdk/python/Reference/V2024/Methods/IdentitiesApi.md
View File

@@ -31,15 +31,15 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
Method | HTTP request | Description
------------- | ------------- | -------------
[**delete-identity**](#delete-identity) | **DELETE** `/identities/{id}` | Delete identity
[**get-identity**](#get-identity) | **GET** `/identities/{id}` | Identity Details
[**get-identity**](#get-identity) | **GET** `/identities/{id}` | Identity details
[**get-identity-ownership-details**](#get-identity-ownership-details) | **GET** `/identities/{identityId}/ownership` | Get ownership details
[**get-role-assignment**](#get-role-assignment) | **GET** `/identities/{identityId}/role-assignments/{assignmentId}` | Role assignment details
[**get-role-assignments**](#get-role-assignments) | **GET** `/identities/{identityId}/role-assignments` | List role assignments
[**list-identities**](#list-identities) | **GET** `/identities` | List Identities
[**list-identities**](#list-identities) | **GET** `/identities` | List identities
[**reset-identity**](#reset-identity) | **POST** `/identities/{id}/reset` | Reset an identity
[**send-identity-verification-account-token**](#send-identity-verification-account-token) | **POST** `/identities/{id}/verification/account/send` | Send password reset email
[**start-identities-invite**](#start-identities-invite) | **POST** `/identities/invite` | Invite identities to register
[**start-identity-processing**](#start-identity-processing) | **POST** `/identities/process` | Process a list of identityIds
[**start-identity-processing**](#start-identity-processing) | **POST** `/identities/process` | Process a list of identityids
[**synchronize-attributes-for-identity**](#synchronize-attributes-for-identity) | **POST** `/identities/{identityId}/synchronize-attributes` | Attribute synchronization for single identity.
@@ -125,7 +125,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Identity Details
Identity details
This API returns a single identity using the Identity ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-identity)
@@ -171,7 +171,7 @@ with ApiClient(configuration) as api_client:
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
# Identity details
results = IdentitiesApi(api_client).get_identity(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -426,7 +426,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
List Identities
List identities
This API returns a list of identities.
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-identities)
@@ -481,7 +481,7 @@ with ApiClient(configuration) as api_client:
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
# List identities
results = IdentitiesApi(api_client).list_identities(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -738,7 +738,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Process a list of identityIds
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](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#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:
@@ -794,7 +794,7 @@ with ApiClient(configuration) as api_client:
}''' # ProcessIdentitiesRequest |
try:
# Process a list of identityIds
# Process a list of identityids
new_process_identities_request = ProcessIdentitiesRequest.from_json(process_identities_request)
results = IdentitiesApi(api_client).start_identity_processing(x_sail_point_experimental=x_sail_point_experimental, process_identities_request=new_process_identities_request)
# Below is a request that includes all optional parameters