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

Update to python SDK docs: 13820107626

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-12 19:41:45 +00:00
parent 184517209d
commit 113200f5fe
221 changed files with 8723 additions and 7883 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
docs/tools/sdk/python/Reference/V2024/Methods/LifecycleStatesApi.md
View File

@@ -94,7 +94,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.lifecycle_states_api import LifecycleStatesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.lifecycle_state import LifecycleState
@@ -102,9 +101,10 @@ from pprint import pprint
from sailpoint.configuration import Configuration
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 = {
lifecycle_state = '''{
"accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ],
"emailNotificationOption" : {
"notifyManagers" : true,
@@ -128,18 +128,17 @@ with ApiClient(configuration) as api_client:
"technicalName" : "Technical Name",
"identityState" : "identityState",
"enabled" : true
} # LifecycleState | Lifecycle state to be created.
}''' # LifecycleState | Lifecycle state to be created.
try:
# Create Lifecycle State
new_lifecycle_state = LifecycleState()
new_lifecycle_state.from_json(lifecycle_state)
results =LifecycleStatesApi(api_client).create_lifecycle_state(identity_profile_id, new_lifecycle_state)
new_lifecycle_state = LifecycleState.from_json(lifecycle_state)
results = LifecycleStatesApi(api_client).create_lifecycle_state(identity_profile_id=identity_profile_id, lifecycle_state=new_lifecycle_state)
# Below is a request that includes all optional parameters
# results = LifecycleStatesApi(api_client).create_lifecycle_state(identity_profile_id, new_lifecycle_state)
print("The response of LifecycleStatesApi->create_lifecycle_state:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling LifecycleStatesApi->create_lifecycle_state: %s\n" % e)
```
@@ -181,7 +180,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.lifecycle_states_api import LifecycleStatesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.lifecyclestate_deleted import LifecyclestateDeleted
@@ -189,6 +187,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
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.
@@ -196,12 +195,12 @@ with ApiClient(configuration) as api_client:
try:
# Delete Lifecycle State
results =LifecycleStatesApi(api_client).delete_lifecycle_state(identity_profile_id, lifecycle_state_id)
results = LifecycleStatesApi(api_client).delete_lifecycle_state(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id)
# Below is a request that includes all optional parameters
# results = LifecycleStatesApi(api_client).delete_lifecycle_state(identity_profile_id, lifecycle_state_id)
print("The response of LifecycleStatesApi->delete_lifecycle_state:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling LifecycleStatesApi->delete_lifecycle_state: %s\n" % e)
```
@@ -243,7 +242,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.lifecycle_states_api import LifecycleStatesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.lifecycle_state import LifecycleState
@@ -251,6 +249,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
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.
@@ -258,12 +257,12 @@ with ApiClient(configuration) as api_client:
try:
# Get Lifecycle State
results =LifecycleStatesApi(api_client).get_lifecycle_state(identity_profile_id, lifecycle_state_id)
results = LifecycleStatesApi(api_client).get_lifecycle_state(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id)
# Below is a request that includes all optional parameters
# results = LifecycleStatesApi(api_client).get_lifecycle_state(identity_profile_id, lifecycle_state_id)
print("The response of LifecycleStatesApi->get_lifecycle_state:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling LifecycleStatesApi->get_lifecycle_state: %s\n" % e)
```
@@ -307,7 +306,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.lifecycle_states_api import LifecycleStatesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.lifecycle_state import LifecycleState
@@ -315,6 +313,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID.
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)
@@ -325,12 +324,12 @@ with ApiClient(configuration) as api_client:
try:
# Lists LifecycleStates
results =LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, )
results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id=identity_profile_id)
# Below is a request that includes all optional parameters
# results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, limit, offset, count, sorters)
print("The response of LifecycleStatesApi->get_lifecycle_states:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e)
```
@@ -372,7 +371,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.lifecycle_states_api import LifecycleStatesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.set_lifecycle_state200_response import SetLifecycleState200Response
@@ -381,20 +379,20 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = '2c9180857893f1290178944561990364' # str | ID of the identity to update. # str | ID of the identity to update.
set_lifecycle_state_request = sailpoint.v2024.SetLifecycleStateRequest() # SetLifecycleStateRequest |
set_lifecycle_state_request = '''sailpoint.v2024.SetLifecycleStateRequest()''' # SetLifecycleStateRequest |
try:
# Set Lifecycle State
new_set_lifecycle_state_request = SetLifecycleStateRequest()
new_set_lifecycle_state_request.from_json(set_lifecycle_state_request)
results =LifecycleStatesApi(api_client).set_lifecycle_state(identity_id, new_set_lifecycle_state_request)
new_set_lifecycle_state_request = SetLifecycleStateRequest.from_json(set_lifecycle_state_request)
results = LifecycleStatesApi(api_client).set_lifecycle_state(identity_id=identity_id, set_lifecycle_state_request=new_set_lifecycle_state_request)
# Below is a request that includes all optional parameters
# results = LifecycleStatesApi(api_client).set_lifecycle_state(identity_id, new_set_lifecycle_state_request)
print("The response of LifecycleStatesApi->set_lifecycle_state:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling LifecycleStatesApi->set_lifecycle_state: %s\n" % e)
```
@@ -437,7 +435,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.lifecycle_states_api import LifecycleStatesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
@@ -446,27 +443,21 @@ from pprint import pprint
from sailpoint.configuration import Configuration
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.
[{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" : "New description"
} # 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]}, {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
try:
# Update Lifecycle State
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =LifecycleStatesApi(api_client).update_lifecycle_states(identity_profile_id, lifecycle_state_id, new_json_patch_operation)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = LifecycleStatesApi(api_client).update_lifecycle_states(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = LifecycleStatesApi(api_client).update_lifecycle_states(identity_profile_id, lifecycle_state_id, new_json_patch_operation)
print("The response of LifecycleStatesApi->update_lifecycle_states:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e)
```