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

Update python SDK docs: 16169917627

Browse Source
This commit is contained in:
developer-relations-sp
2025-07-09 12:57:19 +00:00
parent 3636f49e44
commit ddff157fb6
6 changed files with 85 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/tools/sdk/python/Reference/V2025/Methods/AccessRequestsApi.md
View File

@@ -36,7 +36,7 @@ Method | HTTP request | Description
[**close-access-request**](#close-access-request) | **POST** `/access-requests/close` | Close access request
[**create-access-request**](#create-access-request) | **POST** `/access-requests` | Submit access request
[**get-access-request-config**](#get-access-request-config) | **GET** `/access-request-config` | Get access request configuration
[**get-entitlement-details-for-identity**](#get-entitlement-details-for-identity) | **GET** `/access-requests/revocable-objects` | Identity entitlement details
[**get-entitlement-details-for-identity**](#get-entitlement-details-for-identity) | **GET** `/revocable-objects` | Identity entitlement details
[**list-access-request-status**](#list-access-request-status) | **GET** `/access-request-status` | Access request status
[**list-administrators-access-request-status**](#list-administrators-access-request-status) | **GET** `/access-request-administration` | Access request status for administrators
[**load-account-selections**](#load-account-selections) | **POST** `/access-requests/accounts-selection` | Get accounts selections for identity

28
docs/tools/sdk/python/Reference/V2025/Methods/LifecycleStatesApi.md
View File

@@ -104,6 +104,9 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID.
lifecycle_state = '''{
"accessActionConfiguration" : {
"removeAllAccessEnabled" : true
},
"accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ],
"emailNotificationOption" : {
"notifyManagers" : true,
@@ -112,21 +115,26 @@ with ApiClient(configuration) as api_client:
"notifyAllAdmins" : true
},
"created" : "2015-05-28T14:07:17Z",
"description" : "Lifecycle description",
"identityCount" : 42,
"priority" : 10,
"technicalName" : "Technical Name",
"identityState" : "INACTIVE_LONG_TERM",
"enabled" : true,
"name" : "aName",
"modified" : "2015-05-28T14:07:17Z",
"description" : "Lifecycle description",
"accountActions" : [ {
"allSources" : true,
"action" : "ENABLE",
"excludeSourceIds" : [ "3b551ccf5566478b9b77f37de25303aa" ],
"sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ]
}, {
"allSources" : true,
"action" : "ENABLE",
"excludeSourceIds" : [ "3b551ccf5566478b9b77f37de25303aa" ],
"sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ]
} ],
"id" : "id12345",
"identityCount" : 42,
"technicalName" : "Technical Name",
"identityState" : "identityState",
"enabled" : true
"id" : "id12345"
}''' # LifecycleState | Lifecycle state to be created.
try:
@@ -147,7 +155,7 @@ with ApiClient(configuration) as api_client:
## delete-lifecycle-state
Delete lifecycle state
Use this endpoint to delete the lifecycle state by its ID.
Use this endpoint to delete the lifecycle state by its ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/delete-lifecycle-state)
@@ -208,7 +216,7 @@ with ApiClient(configuration) as api_client:
## get-lifecycle-state
Get lifecycle state
Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID.
Use this endpoint to get a lifecycle state by its ID and its associated identity profile ID.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/get-lifecycle-state)
@@ -408,7 +416,7 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | identity_profile_id | **str** | True | Identity profile ID.
Path | lifecycle_state_id | **str** | True | Lifecycle state ID.
Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption
Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption * accessActionConfiguration * priority
### Return type
[**LifecycleState**](../models/lifecycle-state)
@@ -442,7 +450,7 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID.
lifecycle_state_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Lifecycle state ID. # str | Lifecycle state ID.
json_patch_operation = '''[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/accessProfileIds, value=[2c918087742bab150174407a80f3125e, 2c918087742bab150174407a80f3124f]}, {op=replace, path=/accountActions, value=[{action=ENABLE, sourceIds=[2c9180846a2f82fb016a481c1b1560c5, 2c9180846a2f82fb016a481c1b1560cc]}, {action=DISABLE, sourceIds=[2c91808869a0c9980169a207258513fb]}]}, {op=replace, path=/emailNotificationOption, value={notifyManagers=true, notifyAllAdmins=false, notifySpecificUsers=false, emailAddressList=[]}}]''' # List[JsonPatchOperation] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption
json_patch_operation = '''[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/accessProfileIds, value=[2c918087742bab150174407a80f3125e, 2c918087742bab150174407a80f3124f]}, {op=replace, path=/accountActions, value=[{action=ENABLE, sourceIds=[2c9180846a2f82fb016a481c1b1560c5, 2c9180846a2f82fb016a481c1b1560cc], excludeSourceIds=null, allSources=false}, {action=DISABLE, sourceIds=null, excludeSourceIds=[3b551ccf5566478b9b77f37de25303aa], allSources=true}]}, {op=replace, path=/emailNotificationOption, value={notifyManagers=true, notifyAllAdmins=false, notifySpecificUsers=false, emailAddressList=[]}}, {op=replace, path=/accessActionConfiguration, value={removeAllAccessEnabled=true}}]''' # List[JsonPatchOperation] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption * accessActionConfiguration * priority
try:
# Update lifecycle state

34
docs/tools/sdk/python/Reference/V2025/Models/AccessActionConfiguration.md Normal file
View File

@@ -0,0 +1,34 @@
---
id: v2025-access-action-configuration
title: AccessActionConfiguration
pagination_label: AccessActionConfiguration
sidebar_label: AccessActionConfiguration
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessActionConfiguration', 'V2025AccessActionConfiguration']
slug: /tools/sdk/python/v2025/models/access-action-configuration
tags: ['SDK', 'Software Development Kit', 'AccessActionConfiguration', 'V2025AccessActionConfiguration']
---
# AccessActionConfiguration
This is used for access configuration for a lifecycle state
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**remove_all_access_enabled** | **bool** | If true, then all accesses are marked for removal. | [optional] [default to False]
}
## Example
```python
from sailpoint.v2025.models.access_action_configuration import AccessActionConfiguration
access_action_configuration = AccessActionConfiguration(
remove_all_access_enabled=True
)
```
[[Back to top]](#)

8
docs/tools/sdk/python/Reference/V2025/Models/AccountAction.md
View File

@@ -18,7 +18,9 @@ Object for specifying Actions to be performed on a specified list of sources' ac
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**action** | **Enum** [ 'ENABLE', 'DISABLE' ] | Describes if action will be enabled or disabled | [optional]
**source_ids** | **[]str** | List of unique source IDs. The sources must have the ENABLE feature or flat file source. See \"/sources\" endpoint for source features. | [optional]
**source_ids** | **[]str** | A unique list of specific source IDs to apply the action to. The sources must have the ENABLE feature or flat file source. Required if allSources is not true. Must not be provided if allSources is true. Cannot be used together with excludeSourceIds See \"/sources\" endpoint for source features. | [optional]
**exclude_source_ids** | **[]str** | A list of source IDs to exclude from the action. Cannot be used together with sourceIds. | [optional]
**all_sources** | **bool** | If true, the action applies to all available sources. If true, sourceIds must not be provided. If false or not set, sourceIds is required. | [optional] [default to False]
}
## Example
@@ -28,7 +30,9 @@ from sailpoint.v2025.models.account_action import AccountAction
account_action = AccountAction(
action='ENABLE',
source_ids=[2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500]
source_ids=[2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500],
exclude_source_ids=[3b551ccf5566478b9b77f37de25303aa],
all_sources=True
)
```

13
docs/tools/sdk/python/Reference/V2025/Models/LifecycleState.md
View File

@@ -27,7 +27,9 @@ Name | Type | Description | Notes
**email_notification_option** | [**EmailNotificationOption**](email-notification-option) | | [optional]
**account_actions** | [**[]AccountAction**](account-action) | | [optional]
**access_profile_ids** | **[]str** | List of unique access-profile IDs that are associated with the lifecycle state. | [optional]
**identity_state** | **str** | The lifecycle state's associated identity state. This field is generally 'null'. | [optional]
**identity_state** | **Enum** [ 'ACTIVE', 'INACTIVE_SHORT_TERM', 'INACTIVE_LONG_TERM' ] | The lifecycle state's associated identity state. This field is generally 'null'. | [optional]
**access_action_configuration** | [**AccessActionConfiguration**](access-action-configuration) | | [optional]
**priority** | **int** | Priority level used to determine which profile to assign when a user exists in multiple profiles. Lower numeric values have higher priority. By default, new profiles are assigned the lowest priority. The assigned profile also controls access granted or removed during provisioning based on lifecycle state changes. | [optional]
}
## Example
@@ -52,10 +54,15 @@ email_notification_option=sailpoint.v2025.models.email_notification_option.Email
account_actions=[
sailpoint.v2025.models.account_action.AccountAction(
action = 'ENABLE',
source_ids = [2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500], )
source_ids = [2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500],
exclude_source_ids = [3b551ccf5566478b9b77f37de25303aa],
all_sources = True, )
],
access_profile_ids=[2c918084660f45d6016617daa9210584, 2c918084660f45d6016617daa9210500],
identity_state=''
identity_state='INACTIVE_LONG_TERM',
access_action_configuration=sailpoint.v2025.models.access_action_configuration.AccessActionConfiguration(
remove_all_access_enabled = True, ),
priority=10
)
```