LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 12:27:47 +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

87
docs/tools/sdk/python/Reference/Beta/Methods/IdentitiesApi.md
View File

@@ -76,23 +76,23 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identities_api import IdentitiesApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id
try:
# Delete identity
IdentitiesApi(api_client).delete_identity(id)
IdentitiesApi(api_client).delete_identity(id=id)
# Below is a request that includes all optional parameters
# IdentitiesApi(api_client).delete_identity(id)
except Exception as e:
except Exception as e:
print("Exception when calling IdentitiesApi->delete_identity: %s\n" % e)
```
@@ -133,7 +133,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identities_api import IdentitiesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity import Identity
@@ -141,18 +140,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id
try:
# Identity Details
results =IdentitiesApi(api_client).get_identity(id)
results = IdentitiesApi(api_client).get_identity(id=id)
# Below is a request that includes all optional parameters
# results = IdentitiesApi(api_client).get_identity(id)
print("The response of IdentitiesApi->get_identity:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling IdentitiesApi->get_identity: %s\n" % e)
```
@@ -195,7 +195,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identities_api import IdentitiesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_ownership_association_details import IdentityOwnershipAssociationDetails
@@ -203,18 +202,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = 'ff8081814d2a8036014d701f3fbf53fa' # str | Identity ID. # str | Identity ID.
try:
# Get ownership details
results =IdentitiesApi(api_client).get_identity_ownership_details(identity_id)
results = IdentitiesApi(api_client).get_identity_ownership_details(identity_id=identity_id)
# Below is a request that includes all optional parameters
# results = IdentitiesApi(api_client).get_identity_ownership_details(identity_id)
print("The response of IdentitiesApi->get_identity_ownership_details:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling IdentitiesApi->get_identity_ownership_details: %s\n" % e)
```
@@ -256,7 +256,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identities_api import IdentitiesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_assignment_dto import RoleAssignmentDto
@@ -264,6 +263,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id
assignment_id = '1cbb0705b38c4226b1334eadd8874086' # str | Assignment Id # str | Assignment Id
@@ -271,12 +271,12 @@ with ApiClient(configuration) as api_client:
try:
# Role assignment details
results =IdentitiesApi(api_client).get_role_assignment(identity_id, assignment_id)
results = IdentitiesApi(api_client).get_role_assignment(identity_id=identity_id, assignment_id=assignment_id)
# Below is a request that includes all optional parameters
# results = IdentitiesApi(api_client).get_role_assignment(identity_id, assignment_id)
print("The response of IdentitiesApi->get_role_assignment:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling IdentitiesApi->get_role_assignment: %s\n" % e)
```
@@ -319,7 +319,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identities_api import IdentitiesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.get_role_assignments200_response_inner import GetRoleAssignments200ResponseInner
@@ -327,6 +326,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id to get the role assignments for # str | Identity Id to get the role assignments for
role_id = 'e7697a1e96d04db1ac7b0f4544915d2c' # str | Role Id to filter the role assignments with (optional) # str | Role Id to filter the role assignments with (optional)
@@ -335,12 +335,12 @@ with ApiClient(configuration) as api_client:
try:
# List role assignments
results =IdentitiesApi(api_client).get_role_assignments(identity_id, )
results = IdentitiesApi(api_client).get_role_assignments(identity_id=identity_id)
# Below is a request that includes all optional parameters
# results = IdentitiesApi(api_client).get_role_assignments(identity_id, role_id, role_name)
print("The response of IdentitiesApi->get_role_assignments:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling IdentitiesApi->get_role_assignments: %s\n" % e)
```
@@ -385,7 +385,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identities_api import IdentitiesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity import Identity
@@ -393,6 +392,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
@@ -404,12 +404,12 @@ with ApiClient(configuration) as api_client:
try:
# List Identities
results =IdentitiesApi(api_client).list_identities()
results = IdentitiesApi(api_client).list_identities()
# Below is a request that includes all optional parameters
# results = IdentitiesApi(api_client).list_identities(filters, sorters, default_filter, count, limit, offset)
print("The response of IdentitiesApi->list_identities:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling IdentitiesApi->list_identities: %s\n" % e)
```
@@ -450,23 +450,23 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identities_api import IdentitiesApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id
try:
# Reset an identity
IdentitiesApi(api_client).reset_identity(identity_id)
IdentitiesApi(api_client).reset_identity(identity_id=identity_id)
# Below is a request that includes all optional parameters
# IdentitiesApi(api_client).reset_identity(identity_id)
except Exception as e:
except Exception as e:
print("Exception when calling IdentitiesApi->reset_identity: %s\n" % e)
```
@@ -509,7 +509,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identities_api import IdentitiesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.send_account_verification_request import SendAccountVerificationRequest
@@ -517,21 +516,21 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID
send_account_verification_request = {
send_account_verification_request = '''{
"sourceName" : "Active Directory Source",
"via" : "EMAIL_WORK"
} # SendAccountVerificationRequest |
}''' # SendAccountVerificationRequest |
try:
# Send password reset email
new_send_account_verification_request = SendAccountVerificationRequest()
new_send_account_verification_request.from_json(send_account_verification_request)
IdentitiesApi(api_client).send_identity_verification_account_token(id, new_send_account_verification_request)
new_send_account_verification_request = SendAccountVerificationRequest.from_json(send_account_verification_request)
IdentitiesApi(api_client).send_identity_verification_account_token(id=id, send_account_verification_request=new_send_account_verification_request)
# Below is a request that includes all optional parameters
# IdentitiesApi(api_client).send_identity_verification_account_token(id, new_send_account_verification_request)
except Exception as e:
except Exception as e:
print("Exception when calling IdentitiesApi->send_identity_verification_account_token: %s\n" % e)
```
@@ -577,7 +576,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identities_api import IdentitiesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.invite_identities_request import InviteIdentitiesRequest
@@ -586,22 +584,22 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
invite_identities_request = {
invite_identities_request = '''{
"ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ],
"uninvited" : false
} # InviteIdentitiesRequest |
}''' # InviteIdentitiesRequest |
try:
# Invite identities to register
new_invite_identities_request = InviteIdentitiesRequest()
new_invite_identities_request.from_json(invite_identities_request)
results =IdentitiesApi(api_client).start_identities_invite(new_invite_identities_request)
new_invite_identities_request = InviteIdentitiesRequest.from_json(invite_identities_request)
results = IdentitiesApi(api_client).start_identities_invite(invite_identities_request=new_invite_identities_request)
# Below is a request that includes all optional parameters
# results = IdentitiesApi(api_client).start_identities_invite(new_invite_identities_request)
print("The response of IdentitiesApi->start_identities_invite:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling IdentitiesApi->start_identities_invite: %s\n" % e)
```
@@ -652,7 +650,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identities_api import IdentitiesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.process_identities_request import ProcessIdentitiesRequest
@@ -661,21 +658,21 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
process_identities_request = {
process_identities_request = '''{
"identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ]
} # ProcessIdentitiesRequest |
}''' # ProcessIdentitiesRequest |
try:
# Process a list of identityIds
new_process_identities_request = ProcessIdentitiesRequest()
new_process_identities_request.from_json(process_identities_request)
results =IdentitiesApi(api_client).start_identity_processing(new_process_identities_request)
new_process_identities_request = ProcessIdentitiesRequest.from_json(process_identities_request)
results = IdentitiesApi(api_client).start_identity_processing(process_identities_request=new_process_identities_request)
# Below is a request that includes all optional parameters
# results = IdentitiesApi(api_client).start_identity_processing(new_process_identities_request)
print("The response of IdentitiesApi->start_identity_processing:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling IdentitiesApi->start_identity_processing: %s\n" % e)
```
@@ -716,7 +713,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identities_api import IdentitiesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_sync_job import IdentitySyncJob
@@ -724,18 +720,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = 'identity_id_example' # str | The Identity id # str | The Identity id
try:
# Attribute synchronization for single identity.
results =IdentitiesApi(api_client).synchronize_attributes_for_identity(identity_id)
results = IdentitiesApi(api_client).synchronize_attributes_for_identity(identity_id=identity_id)
# Below is a request that includes all optional parameters
# results = IdentitiesApi(api_client).synchronize_attributes_for_identity(identity_id)
print("The response of IdentitiesApi->synchronize_attributes_for_identity:\n")
pprint(results)
except Exception as e:
except Exception as e:
print("Exception when calling IdentitiesApi->synchronize_attributes_for_identity: %s\n" % e)
```