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 layout for method examples

Browse Source
This commit is contained in:
darrell-thobe-sp
2025-02-25 11:46:14 -05:00
parent a4e2ab4717
commit aa76768244
208 changed files with 14924 additions and 9712 deletions
Download Patch File Download Diff File Expand all files Collapse all files

112
docs/tools/sdk/python/Reference/V3/Methods/AccessProfilesApi.md
View File

@@ -93,10 +93,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.access_profiles_api import AccessProfilesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.access_profile import AccessProfile
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
access_profile = {
"owner" : {
"name" : "support",
@@ -185,14 +189,14 @@ from pprint import pprint
try:
# Create Access Profile
Result = access_profile.from_json(access_profile)
api_response = api_instance.create_access_profile(Result)
new_access_profile = AccessProfile()
new_access_profile.from_json(access_profile)
results =AccessProfilesApi(api_client).create_access_profile(new_access_profile)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_access_profile(Result)
# results = AccessProfilesApi(api_client).create_access_profile(new_access_profile)
print("The response of AccessProfilesApi->create_access_profile:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessProfilesApi->create_access_profile: %s\n" % e)
```
@@ -237,19 +241,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.access_profiles_api import AccessProfilesApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to delete # str | ID of the Access Profile to delete
try:
# Delete the specified Access Profile
api_instance.delete_access_profile(id)
AccessProfilesApi(api_client).delete_access_profile(id)
# Below is a request that includes all optional parameters
# api_instance.delete_access_profile(id)
except Exception as e:
# AccessProfilesApi(api_client).delete_access_profile(id)
except Exception as e:
print("Exception when calling AccessProfilesApi->delete_access_profile: %s\n" % e)
```
@@ -295,11 +302,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.access_profiles_api import AccessProfilesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.access_profile_bulk_delete_request import AccessProfileBulkDeleteRequest
from sailpoint.v3.models.access_profile_bulk_delete_response import AccessProfileBulkDeleteResponse
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
access_profile_bulk_delete_request = {
"accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ],
"bestEffortOnly" : true
@@ -307,14 +318,14 @@ from pprint import pprint
try:
# Delete Access Profile(s)
Result = access_profile_bulk_delete_request.from_json(access_profile_bulk_delete_request)
api_response = api_instance.delete_access_profiles_in_bulk(Result)
new_access_profile_bulk_delete_request = AccessProfileBulkDeleteRequest()
new_access_profile_bulk_delete_request.from_json(access_profile_bulk_delete_request)
results =AccessProfilesApi(api_client).delete_access_profiles_in_bulk(new_access_profile_bulk_delete_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_access_profiles_in_bulk(Result)
# results = AccessProfilesApi(api_client).delete_access_profiles_in_bulk(new_access_profile_bulk_delete_request)
print("The response of AccessProfilesApi->delete_access_profiles_in_bulk:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessProfilesApi->delete_access_profiles_in_bulk: %s\n" % e)
```
@@ -355,22 +366,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.access_profiles_api import AccessProfilesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.access_profile import AccessProfile
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Access Profile # str | ID of the Access Profile
try:
# Get an Access Profile
api_response = api_instance.get_access_profile(id)
results =AccessProfilesApi(api_client).get_access_profile(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_access_profile(id)
# results = AccessProfilesApi(api_client).get_access_profile(id)
print("The response of AccessProfilesApi->get_access_profile:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessProfilesApi->get_access_profile: %s\n" % e)
```
@@ -418,10 +432,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.access_profiles_api import AccessProfilesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.entitlement import Entitlement
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121919ecca' # str | ID of the access profile containing the entitlements. # str | ID of the access profile containing the entitlements.
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)
@@ -432,13 +450,12 @@ from pprint import pprint
try:
# List Access Profile's Entitlements
api_response = api_instance.get_access_profile_entitlements(id, )
results =AccessProfilesApi(api_client).get_access_profile_entitlements(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_access_profile_entitlements(id, limit, offset, count, filters, sorters)
# results = AccessProfilesApi(api_client).get_access_profile_entitlements(id, limit, offset, count, filters, sorters)
print("The response of AccessProfilesApi->get_access_profile_entitlements:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessProfilesApi->get_access_profile_entitlements: %s\n" % e)
```
@@ -487,10 +504,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.access_profiles_api import AccessProfilesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.access_profile import AccessProfile
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
for_subadmin = '8c190e6787aa4ed9a90bd9d5344523fb' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID, or the special value **me**, which is shorthand for the calling identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin. (optional) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID, or the special value **me**, which is shorthand for the calling identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin. (optional)
limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50)
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)
@@ -503,13 +524,12 @@ from pprint import pprint
try:
# List Access Profiles
api_response = api_instance.list_access_profiles()
results =AccessProfilesApi(api_client).list_access_profiles()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented)
# results = AccessProfilesApi(api_client).list_access_profiles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented)
print("The response of AccessProfilesApi->list_access_profiles:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessProfilesApi->list_access_profiles: %s\n" % e)
```
@@ -580,11 +600,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.access_profiles_api import AccessProfilesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.access_profile import AccessProfile
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to patch # str | ID of the Access Profile to patch
[{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}] # List[JsonPatchOperation] |
json_patch_operation = {
@@ -596,14 +620,14 @@ from pprint import pprint
try:
# Patch a specified Access Profile
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_access_profile(id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =AccessProfilesApi(api_client).patch_access_profile(id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_access_profile(id, Result)
# results = AccessProfilesApi(api_client).patch_access_profile(id, new_json_patch_operation)
print("The response of AccessProfilesApi->patch_access_profile:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessProfilesApi->patch_access_profile: %s\n" % e)
```

96
docs/tools/sdk/python/Reference/V3/Methods/AccessRequestApprovalsApi.md
View File

@@ -75,10 +75,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.comment_dto import CommentDto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID.
comment_dto = {
"created" : "2017-07-11T18:45:37.098Z",
@@ -93,13 +97,12 @@ from pprint import pprint
try:
# Approve Access Request Approval
api_response = api_instance.approve_access_request(approval_id, )
results =AccessRequestApprovalsApi(api_client).approve_access_request(approval_id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.approve_access_request(approval_id, Result)
# results = AccessRequestApprovalsApi(api_client).approve_access_request(approval_id, new_comment_dto)
print("The response of AccessRequestApprovalsApi->approve_access_request:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestApprovalsApi->approve_access_request: %s\n" % e)
```
@@ -142,10 +145,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.forward_approval_dto import ForwardApprovalDto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID.
forward_approval_dto = {
"newOwnerId" : "2c91808568c529c60168cca6f90c1314",
@@ -154,14 +161,14 @@ from pprint import pprint
try:
# Forward Access Request Approval
Result = forward_approval_dto.from_json(forward_approval_dto)
api_response = api_instance.forward_access_request(approval_id, Result)
new_forward_approval_dto = ForwardApprovalDto()
new_forward_approval_dto.from_json(forward_approval_dto)
results =AccessRequestApprovalsApi(api_client).forward_access_request(approval_id, new_forward_approval_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.forward_access_request(approval_id, Result)
# results = AccessRequestApprovalsApi(api_client).forward_access_request(approval_id, new_forward_approval_dto)
print("The response of AccessRequestApprovalsApi->forward_access_request:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestApprovalsApi->forward_access_request: %s\n" % e)
```
@@ -203,23 +210,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.approval_summary import ApprovalSummary
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = '2c91808568c529c60168cca6f90c1313' # str | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # str | The ID of the owner or approver identity of the approvals. If present, the value returns approval summary for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN user can also fetch all the approvals in the org, when owner-id is not used. * Non ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional)
from_date = 'from-date=2020-03-19T19:59:11Z' # str | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional) # str | This is the date and time the results will be shown from. It must be in a valid ISO-8601 format. (optional)
try:
# Get Access Requests Approvals Number
api_response = api_instance.get_access_request_approval_summary()
results =AccessRequestApprovalsApi(api_client).get_access_request_approval_summary()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_access_request_approval_summary(owner_id, from_date)
# results = AccessRequestApprovalsApi(api_client).get_access_request_approval_summary(owner_id, from_date)
print("The response of AccessRequestApprovalsApi->get_access_request_approval_summary:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestApprovalsApi->get_access_request_approval_summary: %s\n" % e)
```
@@ -265,10 +275,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.completed_approval import CompletedApproval
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = '2c91808568c529c60168cca6f90c1313' # str | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # str | If present, the value returns only completed approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional)
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)
@@ -279,13 +293,12 @@ from pprint import pprint
try:
# Completed Access Request Approvals List
api_response = api_instance.list_completed_approvals()
results =AccessRequestApprovalsApi(api_client).list_completed_approvals()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_completed_approvals(owner_id, limit, offset, count, filters, sorters)
# results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters)
print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestApprovalsApi->list_completed_approvals: %s\n" % e)
```
@@ -331,10 +344,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.pending_approval import PendingApproval
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = '2c91808568c529c60168cca6f90c1313' # str | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional) # str | If present, the value returns only pending approvals for the specified identity. * ORG_ADMIN users can call this with any identity ID value. * ORG_ADMIN users can also fetch all the approvals in the org, when owner-id is not used. * Non-ORG_ADMIN users can only specify *me* or pass their own identity ID value. (optional)
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)
@@ -345,13 +362,12 @@ from pprint import pprint
try:
# Pending Access Request Approvals List
api_response = api_instance.list_pending_approvals()
results =AccessRequestApprovalsApi(api_client).list_pending_approvals()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_pending_approvals(owner_id, limit, offset, count, filters, sorters)
# results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters)
print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestApprovalsApi->list_pending_approvals: %s\n" % e)
```
@@ -394,10 +410,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.comment_dto import CommentDto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
approval_id = '2c91808b7294bea301729568c68c002e' # str | Approval ID. # str | Approval ID.
comment_dto = {
"created" : "2017-07-11T18:45:37.098Z",
@@ -411,14 +431,14 @@ from pprint import pprint
try:
# Reject Access Request Approval
Result = comment_dto.from_json(comment_dto)
api_response = api_instance.reject_access_request(approval_id, Result)
new_comment_dto = CommentDto()
new_comment_dto.from_json(comment_dto)
results =AccessRequestApprovalsApi(api_client).reject_access_request(approval_id, new_comment_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.reject_access_request(approval_id, Result)
# results = AccessRequestApprovalsApi(api_client).reject_access_request(approval_id, new_comment_dto)
print("The response of AccessRequestApprovalsApi->reject_access_request:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestApprovalsApi->reject_access_request: %s\n" % e)
```

84
docs/tools/sdk/python/Reference/V3/Methods/AccessRequestsApi.md
View File

@@ -72,10 +72,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.access_requests_api import AccessRequestsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.cancel_access_request import CancelAccessRequest
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
cancel_access_request = {
"accountActivityId" : "2c9180835d2e5168015d32f890ca1581",
"comment" : "I requested this role by mistake."
@@ -83,14 +87,14 @@ from pprint import pprint
try:
# Cancel Access Request
Result = cancel_access_request.from_json(cancel_access_request)
api_response = api_instance.cancel_access_request(Result)
new_cancel_access_request = CancelAccessRequest()
new_cancel_access_request.from_json(cancel_access_request)
results =AccessRequestsApi(api_client).cancel_access_request(new_cancel_access_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.cancel_access_request(Result)
# results = AccessRequestsApi(api_client).cancel_access_request(new_cancel_access_request)
print("The response of AccessRequestsApi->cancel_access_request:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestsApi->cancel_access_request: %s\n" % e)
```
@@ -161,11 +165,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.access_requests_api import AccessRequestsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.access_request import AccessRequest
from sailpoint.v3.models.access_request_response import AccessRequestResponse
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
access_request = {
"requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ],
"clientMetadata" : {
@@ -223,14 +231,14 @@ from pprint import pprint
try:
# Submit Access Request
Result = access_request.from_json(access_request)
api_response = api_instance.create_access_request(Result)
new_access_request = AccessRequest()
new_access_request.from_json(access_request)
results =AccessRequestsApi(api_client).create_access_request(new_access_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_access_request(Result)
# results = AccessRequestsApi(api_client).create_access_request(new_access_request)
print("The response of AccessRequestsApi->create_access_request:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestsApi->create_access_request: %s\n" % e)
```
@@ -268,21 +276,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.access_requests_api import AccessRequestsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.access_request_config import AccessRequestConfig
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Access Request Configuration
api_response = api_instance.get_access_request_config()
results =AccessRequestsApi(api_client).get_access_request_config()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_access_request_config()
# results = AccessRequestsApi(api_client).get_access_request_config()
print("The response of AccessRequestsApi->get_access_request_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestsApi->get_access_request_config: %s\n" % e)
```
@@ -334,10 +345,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.access_requests_api import AccessRequestsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.requested_item_status import RequestedItemStatus
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
requested_for = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | Filter the results by the identity the requests were made for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
requested_by = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | Filter the results by the identity who made the requests. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
regarding_identity = '2c9180877b2b6ea4017b2c545f971429' # str | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # str | Filter the results by the specified identity who is either the requester or target of the requests. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional)
@@ -352,13 +367,12 @@ from pprint import pprint
try:
# Access Request Status
api_response = api_instance.list_access_request_status()
results =AccessRequestsApi(api_client).list_access_request_status()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state)
# results = AccessRequestsApi(api_client).list_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state)
print("The response of AccessRequestsApi->list_access_request_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestsApi->list_access_request_status: %s\n" % e)
```
@@ -399,10 +413,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.access_requests_api import AccessRequestsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.access_request_config import AccessRequestConfig
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
access_request_config = {
"requestOnBehalfOfConfig" : {
"allowRequestOnBehalfOfEmployeeByManager" : true,
@@ -432,14 +450,14 @@ from pprint import pprint
try:
# Update Access Request Configuration
Result = access_request_config.from_json(access_request_config)
api_response = api_instance.set_access_request_config(Result)
new_access_request_config = AccessRequestConfig()
new_access_request_config.from_json(access_request_config)
results =AccessRequestsApi(api_client).set_access_request_config(new_access_request_config)
# Below is a request that includes all optional parameters
# api_response = api_instance.set_access_request_config(Result)
# results = AccessRequestsApi(api_client).set_access_request_config(new_access_request_config)
print("The response of AccessRequestsApi->set_access_request_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccessRequestsApi->set_access_request_config: %s\n" % e)
```

30
docs/tools/sdk/python/Reference/V3/Methods/AccountActivitiesApi.md
View File

@@ -86,22 +86,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.account_activities_api import AccountActivitiesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.account_activity import AccountActivity
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account activity id # str | The account activity id
try:
# Get an Account Activity
api_response = api_instance.get_account_activity(id)
results =AccountActivitiesApi(api_client).get_account_activity(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_account_activity(id)
# results = AccountActivitiesApi(api_client).get_account_activity(id)
print("The response of AccountActivitiesApi->get_account_activity:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountActivitiesApi->get_account_activity: %s\n" % e)
```
@@ -149,10 +152,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.account_activities_api import AccountActivitiesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.account_activity import AccountActivity
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
requested_for = '2c91808568c529c60168cca6f90c1313' # str | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | The identity that the activity was requested for. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
requested_by = '2c91808568c529c60168cca6f90c1313' # str | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional) # str | The identity that requested the activity. *me* indicates the current user. Mutually exclusive with *regarding-identity*. (optional)
regarding_identity = '2c91808568c529c60168cca6f90c1313' # str | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional) # str | The specified identity will be either the requester or target of the account activity. *me* indicates the current user. Mutually exclusive with *requested-for* and *requested-by*. (optional)
@@ -165,13 +172,12 @@ from pprint import pprint
try:
# List Account Activities
api_response = api_instance.list_account_activities()
results =AccountActivitiesApi(api_client).list_account_activities()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_account_activities(requested_for, requested_by, regarding_identity, limit, offset, count, filters, sorters)
# results = AccountActivitiesApi(api_client).list_account_activities(requested_for, requested_by, regarding_identity, limit, offset, count, filters, sorters)
print("The response of AccountActivitiesApi->list_account_activities:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountActivitiesApi->list_account_activities: %s\n" % e)
```

15
docs/tools/sdk/python/Reference/V3/Methods/AccountUsagesApi.md
View File

@@ -58,10 +58,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.account_usages_api import AccountUsagesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.account_usage import AccountUsage
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of IDN account # str | ID of IDN account
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)
@@ -71,13 +75,12 @@ from pprint import pprint
try:
# Returns account usage insights
api_response = api_instance.get_usages_by_account_id(account_id, )
results =AccountUsagesApi(api_client).get_usages_by_account_id(account_id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_usages_by_account_id(account_id, limit, offset, count, sorters)
# results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id, limit, offset, count, sorters)
print("The response of AccountUsagesApi->get_usages_by_account_id:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountUsagesApi->get_usages_by_account_id: %s\n" % e)
```

183
docs/tools/sdk/python/Reference/V3/Methods/AccountsApi.md
View File

@@ -99,11 +99,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.accounts_api import AccountsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.account_attributes_create import AccountAttributesCreate
from sailpoint.v3.models.accounts_async_result import AccountsAsyncResult
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
account_attributes_create = {
"attributes" : {
"sourceId" : "34bfcbe116c9407464af37acbaf7a4dc",
@@ -117,14 +121,14 @@ from pprint import pprint
try:
# Create Account
Result = account_attributes_create.from_json(account_attributes_create)
api_response = api_instance.create_account(Result)
new_account_attributes_create = AccountAttributesCreate()
new_account_attributes_create.from_json(account_attributes_create)
results =AccountsApi(api_client).create_account(new_account_attributes_create)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_account(Result)
# results = AccountsApi(api_client).create_account(new_account_attributes_create)
print("The response of AccountsApi->create_account:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->create_account: %s\n" % e)
```
@@ -169,22 +173,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.accounts_api import AccountsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.accounts_async_result import AccountsAsyncResult
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID.
try:
# Delete Account
api_response = api_instance.delete_account(id)
results =AccountsApi(api_client).delete_account(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_account(id)
# results = AccountsApi(api_client).delete_account(id)
print("The response of AccountsApi->delete_account:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->delete_account: %s\n" % e)
```
@@ -227,11 +234,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.accounts_api import AccountsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.account_toggle_request import AccountToggleRequest
from sailpoint.v3.models.accounts_async_result import AccountsAsyncResult
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id
account_toggle_request = {
"forceProvisioning" : false,
@@ -240,14 +251,14 @@ from pprint import pprint
try:
# Disable Account
Result = account_toggle_request.from_json(account_toggle_request)
api_response = api_instance.disable_account(id, Result)
new_account_toggle_request = AccountToggleRequest()
new_account_toggle_request.from_json(account_toggle_request)
results =AccountsApi(api_client).disable_account(id, new_account_toggle_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.disable_account(id, Result)
# results = AccountsApi(api_client).disable_account(id, new_account_toggle_request)
print("The response of AccountsApi->disable_account:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->disable_account: %s\n" % e)
```
@@ -290,11 +301,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.accounts_api import AccountsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.account_toggle_request import AccountToggleRequest
from sailpoint.v3.models.accounts_async_result import AccountsAsyncResult
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id
account_toggle_request = {
"forceProvisioning" : false,
@@ -303,14 +318,14 @@ from pprint import pprint
try:
# Enable Account
Result = account_toggle_request.from_json(account_toggle_request)
api_response = api_instance.enable_account(id, Result)
new_account_toggle_request = AccountToggleRequest()
new_account_toggle_request.from_json(account_toggle_request)
results =AccountsApi(api_client).enable_account(id, new_account_toggle_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.enable_account(id, Result)
# results = AccountsApi(api_client).enable_account(id, new_account_toggle_request)
print("The response of AccountsApi->enable_account:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->enable_account: %s\n" % e)
```
@@ -352,22 +367,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.accounts_api import AccountsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.account import Account
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID.
try:
# Account Details
api_response = api_instance.get_account(id)
results =AccountsApi(api_client).get_account(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_account(id)
# results = AccountsApi(api_client).get_account(id)
print("The response of AccountsApi->get_account:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->get_account: %s\n" % e)
```
@@ -412,10 +430,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.accounts_api import AccountsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.entitlement_dto import EntitlementDto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account 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)
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)
@@ -424,13 +446,12 @@ from pprint import pprint
try:
# Account Entitlements
api_response = api_instance.get_account_entitlements(id, )
results =AccountsApi(api_client).get_account_entitlements(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_account_entitlements(id, limit, offset, count)
# results = AccountsApi(api_client).get_account_entitlements(id, limit, offset, count)
print("The response of AccountsApi->get_account_entitlements:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->get_account_entitlements: %s\n" % e)
```
@@ -476,10 +497,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.accounts_api import AccountsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.account import Account
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
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)
@@ -490,13 +515,12 @@ from pprint import pprint
try:
# Accounts List
api_response = api_instance.list_accounts()
results =AccountsApi(api_client).list_accounts()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_accounts(limit, offset, count, detail_level, filters, sorters)
# results = AccountsApi(api_client).list_accounts(limit, offset, count, detail_level, filters, sorters)
print("The response of AccountsApi->list_accounts:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->list_accounts: %s\n" % e)
```
@@ -544,11 +568,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.accounts_api import AccountsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.account_attributes import AccountAttributes
from sailpoint.v3.models.accounts_async_result import AccountsAsyncResult
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID.
account_attributes = {
"attributes" : {
@@ -562,14 +590,14 @@ from pprint import pprint
try:
# Update Account
Result = account_attributes.from_json(account_attributes)
api_response = api_instance.put_account(id, Result)
new_account_attributes = AccountAttributes()
new_account_attributes.from_json(account_attributes)
results =AccountsApi(api_client).put_account(id, new_account_attributes)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_account(id, Result)
# results = AccountsApi(api_client).put_account(id, new_account_attributes)
print("The response of AccountsApi->put_account:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->put_account: %s\n" % e)
```
@@ -611,22 +639,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.accounts_api import AccountsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.accounts_async_result import AccountsAsyncResult
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account id # str | The account id
try:
# Reload Account
api_response = api_instance.submit_reload_account(id)
results =AccountsApi(api_client).submit_reload_account(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.submit_reload_account(id)
# results = AccountsApi(api_client).submit_reload_account(id)
print("The response of AccountsApi->submit_reload_account:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->submit_reload_account: %s\n" % e)
```
@@ -670,11 +701,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.accounts_api import AccountsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.account_unlock_request import AccountUnlockRequest
from sailpoint.v3.models.accounts_async_result import AccountsAsyncResult
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. # str | The account ID.
account_unlock_request = {
"forceProvisioning" : false,
@@ -684,14 +719,14 @@ from pprint import pprint
try:
# Unlock Account
Result = account_unlock_request.from_json(account_unlock_request)
api_response = api_instance.unlock_account(id, Result)
new_account_unlock_request = AccountUnlockRequest()
new_account_unlock_request.from_json(account_unlock_request)
results =AccountsApi(api_client).unlock_account(id, new_account_unlock_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.unlock_account(id, Result)
# results = AccountsApi(api_client).unlock_account(id, new_account_unlock_request)
print("The response of AccountsApi->unlock_account:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->unlock_account: %s\n" % e)
```
@@ -744,9 +779,13 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.accounts_api import AccountsApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID.
request_body = [{op=remove, path=/identityId}] # List[object] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
request_body = [{op=remove, path=/identityId}] # List[object] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
@@ -754,14 +793,14 @@ from pprint import pprint
try:
# Update Account
Result = request_body.from_json(request_body)
api_response = api_instance.update_account(id, Result)
new_request_body = RequestBody()
new_request_body.from_json(request_body)
results =AccountsApi(api_client).update_account(id, new_request_body)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_account(id, Result)
# results = AccountsApi(api_client).update_account(id, new_request_body)
print("The response of AccountsApi->update_account:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AccountsApi->update_account: %s\n" % e)
```

43
docs/tools/sdk/python/Reference/V3/Methods/ApplicationDiscoveryApi.md
View File

@@ -60,10 +60,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.application_discovery_api import ApplicationDiscoveryApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.get_discovered_applications200_response_inner import GetDiscoveredApplications200ResponseInner
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
detail = 'FULL' # str | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional) # str | Determines whether slim, or increased level of detail is provided for each discovered application in the returned list. SLIM is the default behavior. (optional)
@@ -73,13 +77,12 @@ from pprint import pprint
try:
# Get Discovered Applications for Tenant
api_response = api_instance.get_discovered_applications()
results =ApplicationDiscoveryApi(api_client).get_discovered_applications()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_discovered_applications(limit, offset, detail, filter, sorters)
# results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters)
print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ApplicationDiscoveryApi->get_discovered_applications: %s\n" % e)
```
@@ -120,21 +123,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.application_discovery_api import ApplicationDiscoveryApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.manual_discover_applications_template import ManualDiscoverApplicationsTemplate
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Download CSV Template for Discovery
api_response = api_instance.get_manual_discover_applications_csv_template()
results =ApplicationDiscoveryApi(api_client).get_manual_discover_applications_csv_template()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_manual_discover_applications_csv_template()
# results = ApplicationDiscoveryApi(api_client).get_manual_discover_applications_csv_template()
print("The response of ApplicationDiscoveryApi->get_manual_discover_applications_csv_template:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ApplicationDiscoveryApi->get_manual_discover_applications_csv_template: %s\n" % e)
```
@@ -176,19 +182,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.application_discovery_api import ApplicationDiscoveryApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
file = None # bytearray | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered. # bytearray | The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered.
try:
# Upload CSV to Discover Applications
api_instance.send_manual_discover_applications_csv_template(file)
ApplicationDiscoveryApi(api_client).send_manual_discover_applications_csv_template(file)
# Below is a request that includes all optional parameters
# api_instance.send_manual_discover_applications_csv_template(file)
except Exception as e:
# ApplicationDiscoveryApi(api_client).send_manual_discover_applications_csv_template(file)
except Exception as e:
print("Exception when calling ApplicationDiscoveryApi->send_manual_discover_applications_csv_template: %s\n" % e)
```

33
docs/tools/sdk/python/Reference/V3/Methods/AuthUsersApi.md
View File

@@ -58,22 +58,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.auth_users_api import AuthUsersApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.auth_user import AuthUser
from sailpoint.v3.rest import ApiException
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:
# Auth User Details
api_response = api_instance.get_auth_user(id)
results =AuthUsersApi(api_client).get_auth_user(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_auth_user(id)
# results = AuthUsersApi(api_client).get_auth_user(id)
print("The response of AuthUsersApi->get_auth_user:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AuthUsersApi->get_auth_user: %s\n" % e)
```
@@ -120,11 +123,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.auth_users_api import AuthUsersApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.auth_user import AuthUser
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
from sailpoint.v3.rest import ApiException
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
[{op=replace, path=/capabilities, value=[ORG_ADMIN]}] # List[JsonPatchOperation] | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
json_patch_operation = {
@@ -136,14 +143,14 @@ from pprint import pprint
try:
# Auth User Update
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_auth_user(id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =AuthUsersApi(api_client).patch_auth_user(id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_auth_user(id, Result)
# results = AuthUsersApi(api_client).patch_auth_user(id, new_json_patch_operation)
print("The response of AuthUsersApi->patch_auth_user:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling AuthUsersApi->patch_auth_user: %s\n" % e)
```

73
docs/tools/sdk/python/Reference/V3/Methods/BrandingApi.md
View File

@@ -67,10 +67,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.branding_api import BrandingApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.branding_item import BrandingItem
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
name = 'name_example' # str | name of branding item # str | name of branding item
product_name = 'product_name_example' # str | product name # str | product name
action_button_color = 'action_button_color_example' # str | hex value of color for action button (optional) # str | hex value of color for action button (optional)
@@ -83,13 +87,12 @@ from pprint import pprint
try:
# Create a branding item
api_response = api_instance.create_branding_item(name, product_name, )
results =BrandingApi(api_client).create_branding_item(name, product_name, )
# Below is a request that includes all optional parameters
# api_response = api_instance.create_branding_item(name, product_name, action_button_color, active_link_color, navigation_color, email_from_address, login_informational_message, file_standard)
# results = BrandingApi(api_client).create_branding_item(name, product_name, action_button_color, active_link_color, navigation_color, email_from_address, login_informational_message, file_standard)
print("The response of BrandingApi->create_branding_item:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling BrandingApi->create_branding_item: %s\n" % e)
```
@@ -131,19 +134,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.branding_api import BrandingApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
name = 'default' # str | The name of the branding item to be deleted # str | The name of the branding item to be deleted
try:
# Delete a branding item
api_instance.delete_branding(name)
BrandingApi(api_client).delete_branding(name)
# Below is a request that includes all optional parameters
# api_instance.delete_branding(name)
except Exception as e:
# BrandingApi(api_client).delete_branding(name)
except Exception as e:
print("Exception when calling BrandingApi->delete_branding: %s\n" % e)
```
@@ -185,22 +191,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.branding_api import BrandingApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.branding_item import BrandingItem
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
name = 'default' # str | The name of the branding item to be retrieved # str | The name of the branding item to be retrieved
try:
# Get a branding item
api_response = api_instance.get_branding(name)
results =BrandingApi(api_client).get_branding(name)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_branding(name)
# results = BrandingApi(api_client).get_branding(name)
print("The response of BrandingApi->get_branding:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling BrandingApi->get_branding: %s\n" % e)
```
@@ -238,21 +247,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.branding_api import BrandingApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.branding_item import BrandingItem
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List of branding items
api_response = api_instance.get_branding_list()
results =BrandingApi(api_client).get_branding_list()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_branding_list()
# results = BrandingApi(api_client).get_branding_list()
print("The response of BrandingApi->get_branding_list:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling BrandingApi->get_branding_list: %s\n" % e)
```
@@ -302,10 +314,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.branding_api import BrandingApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.branding_item import BrandingItem
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
name = 'default' # str | The name of the branding item to be retrieved # str | The name of the branding item to be retrieved
name2 = 'name_example' # str | name of branding item # str | name of branding item
product_name = 'product_name_example' # str | product name # str | product name
@@ -319,13 +335,12 @@ from pprint import pprint
try:
# Update a branding item
api_response = api_instance.set_branding_item(name, name2, product_name, )
results =BrandingApi(api_client).set_branding_item(name, name2, product_name, )
# Below is a request that includes all optional parameters
# api_response = api_instance.set_branding_item(name, name2, product_name, action_button_color, active_link_color, navigation_color, email_from_address, login_informational_message, file_standard)
# results = BrandingApi(api_client).set_branding_item(name, name2, product_name, action_button_color, active_link_color, navigation_color, email_from_address, login_informational_message, file_standard)
print("The response of BrandingApi->set_branding_item:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling BrandingApi->set_branding_item: %s\n" % e)
```

82
docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignFiltersApi.md
View File

@@ -82,10 +82,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaign_filters_api import CertificationCampaignFiltersApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.campaign_filter_details import CampaignFilterDetails
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
campaign_filter_details = {
"owner" : "SailPoint Support",
"mode" : "INCLUSION",
@@ -107,14 +111,14 @@ from pprint import pprint
try:
# Create Campaign Filter
Result = campaign_filter_details.from_json(campaign_filter_details)
api_response = api_instance.create_campaign_filter(Result)
new_campaign_filter_details = CampaignFilterDetails()
new_campaign_filter_details.from_json(campaign_filter_details)
results =CertificationCampaignFiltersApi(api_client).create_campaign_filter(new_campaign_filter_details)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_campaign_filter(Result)
# results = CertificationCampaignFiltersApi(api_client).create_campaign_filter(new_campaign_filter_details)
print("The response of CertificationCampaignFiltersApi->create_campaign_filter:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignFiltersApi->create_campaign_filter: %s\n" % e)
```
@@ -156,21 +160,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.certification_campaign_filters_api import CertificationCampaignFiltersApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
request_body = ['request_body_example'] # List[str] | A json list of IDs of campaign filters to delete.
request_body = ['request_body_example'] # List[str] | A json list of IDs of campaign filters to delete.
try:
# Deletes Campaign Filters
Result = request_body.from_json(request_body)
api_instance.delete_campaign_filters(Result)
new_request_body = RequestBody()
new_request_body.from_json(request_body)
CertificationCampaignFiltersApi(api_client).delete_campaign_filters(new_request_body)
# Below is a request that includes all optional parameters
# api_instance.delete_campaign_filters(Result)
except Exception as e:
# CertificationCampaignFiltersApi(api_client).delete_campaign_filters(new_request_body)
except Exception as e:
print("Exception when calling CertificationCampaignFiltersApi->delete_campaign_filters: %s\n" % e)
```
@@ -212,22 +220,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaign_filters_api import CertificationCampaignFiltersApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.campaign_filter_details import CampaignFilterDetails
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'e9f9a1397b842fd5a65842087040d3ac' # str | The ID of the campaign filter to be retrieved. # str | The ID of the campaign filter to be retrieved.
try:
# Get Campaign Filter by ID
api_response = api_instance.get_campaign_filter_by_id(id)
results =CertificationCampaignFiltersApi(api_client).get_campaign_filter_by_id(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_campaign_filter_by_id(id)
# results = CertificationCampaignFiltersApi(api_client).get_campaign_filter_by_id(id)
print("The response of CertificationCampaignFiltersApi->get_campaign_filter_by_id:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignFiltersApi->get_campaign_filter_by_id: %s\n" % e)
```
@@ -270,10 +281,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaign_filters_api import CertificationCampaignFiltersApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.list_campaign_filters200_response import ListCampaignFilters200Response
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
start = 0 # int | Start/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 | Start/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)
include_system_filters = True # bool | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to True) # bool | If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true. (optional) (default to True)
@@ -281,13 +296,12 @@ from pprint import pprint
try:
# List Campaign Filters
api_response = api_instance.list_campaign_filters()
results =CertificationCampaignFiltersApi(api_client).list_campaign_filters()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_campaign_filters(limit, start, include_system_filters)
# results = CertificationCampaignFiltersApi(api_client).list_campaign_filters(limit, start, include_system_filters)
print("The response of CertificationCampaignFiltersApi->list_campaign_filters:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignFiltersApi->list_campaign_filters: %s\n" % e)
```
@@ -329,10 +343,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaign_filters_api import CertificationCampaignFiltersApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.campaign_filter_details import CampaignFilterDetails
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
filter_id = 'e9f9a1397b842fd5a65842087040d3ac' # str | The ID of the campaign filter being modified. # str | The ID of the campaign filter being modified.
campaign_filter_details = {
"owner" : "SailPoint Support",
@@ -355,14 +373,14 @@ from pprint import pprint
try:
# Updates a Campaign Filter
Result = campaign_filter_details.from_json(campaign_filter_details)
api_response = api_instance.update_campaign_filter(filter_id, Result)
new_campaign_filter_details = CampaignFilterDetails()
new_campaign_filter_details.from_json(campaign_filter_details)
results =CertificationCampaignFiltersApi(api_client).update_campaign_filter(filter_id, new_campaign_filter_details)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_campaign_filter(filter_id, Result)
# results = CertificationCampaignFiltersApi(api_client).update_campaign_filter(filter_id, new_campaign_filter_details)
print("The response of CertificationCampaignFiltersApi->update_campaign_filter:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignFiltersApi->update_campaign_filter: %s\n" % e)
```

345
docs/tools/sdk/python/Reference/V3/Methods/CertificationCampaignsApi.md
View File

@@ -149,10 +149,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.campaign_complete_options import CampaignCompleteOptions
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Campaign ID. # str | Campaign ID.
campaign_complete_options = {
"autoCompleteAction" : "REVOKE"
@@ -161,13 +165,12 @@ from pprint import pprint
try:
# Complete a Campaign
api_response = api_instance.complete_campaign(id, )
results =CertificationCampaignsApi(api_client).complete_campaign(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.complete_campaign(id, Result)
# results = CertificationCampaignsApi(api_client).complete_campaign(id, new_campaign_complete_options)
print("The response of CertificationCampaignsApi->complete_campaign:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->complete_campaign: %s\n" % e)
```
@@ -209,10 +212,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.campaign import Campaign
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
campaign = {
"totalCertifications" : 100,
"sourcesWithOrphanEntitlements" : [ {
@@ -325,14 +332,14 @@ from pprint import pprint
try:
# Create a campaign
Result = campaign.from_json(campaign)
api_response = api_instance.create_campaign(Result)
new_campaign = Campaign()
new_campaign.from_json(campaign)
results =CertificationCampaignsApi(api_client).create_campaign(new_campaign)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_campaign(Result)
# results = CertificationCampaignsApi(api_client).create_campaign(new_campaign)
print("The response of CertificationCampaignsApi->create_campaign:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->create_campaign: %s\n" % e)
```
@@ -374,10 +381,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.campaign_template import CampaignTemplate
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
campaign_template = {
"ownerRef" : {
"name" : "Mister Manager",
@@ -505,14 +516,14 @@ from pprint import pprint
try:
# Create a Campaign Template
Result = campaign_template.from_json(campaign_template)
api_response = api_instance.create_campaign_template(Result)
new_campaign_template = CampaignTemplate()
new_campaign_template.from_json(campaign_template)
results =CertificationCampaignsApi(api_client).create_campaign_template(new_campaign_template)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_campaign_template(Result)
# results = CertificationCampaignsApi(api_client).create_campaign_template(new_campaign_template)
print("The response of CertificationCampaignsApi->create_campaign_template:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->create_campaign_template: %s\n" % e)
```
@@ -555,19 +566,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being deleted. # str | ID of the campaign template being deleted.
try:
# Delete a Campaign Template
api_instance.delete_campaign_template(id)
CertificationCampaignsApi(api_client).delete_campaign_template(id)
# Below is a request that includes all optional parameters
# api_instance.delete_campaign_template(id)
except Exception as e:
# CertificationCampaignsApi(api_client).delete_campaign_template(id)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->delete_campaign_template: %s\n" % e)
```
@@ -610,19 +624,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '04bedce387bd47b2ae1f86eb0bb36dee' # str | ID of the campaign template whose schedule is being deleted. # str | ID of the campaign template whose schedule is being deleted.
try:
# Delete Campaign Template Schedule
api_instance.delete_campaign_template_schedule(id)
CertificationCampaignsApi(api_client).delete_campaign_template_schedule(id)
# Below is a request that includes all optional parameters
# api_instance.delete_campaign_template_schedule(id)
except Exception as e:
# CertificationCampaignsApi(api_client).delete_campaign_template_schedule(id)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->delete_campaign_template_schedule: %s\n" % e)
```
@@ -665,24 +682,28 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.campaigns_delete_request import CampaignsDeleteRequest
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
campaigns_delete_request = {
"ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ]
} # CampaignsDeleteRequest | IDs of the campaigns to delete.
try:
# Delete Campaigns
Result = campaigns_delete_request.from_json(campaigns_delete_request)
api_response = api_instance.delete_campaigns(Result)
new_campaigns_delete_request = CampaignsDeleteRequest()
new_campaigns_delete_request.from_json(campaigns_delete_request)
results =CertificationCampaignsApi(api_client).delete_campaigns(new_campaigns_delete_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_campaigns(Result)
# results = CertificationCampaignsApi(api_client).delete_campaigns(new_campaigns_delete_request)
print("The response of CertificationCampaignsApi->delete_campaigns:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->delete_campaigns: %s\n" % e)
```
@@ -729,10 +750,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
detail = 'FULL' # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional)
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)
@@ -743,13 +768,12 @@ from pprint import pprint
try:
# List Campaigns
api_response = api_instance.get_active_campaigns()
results =CertificationCampaignsApi(api_client).get_active_campaigns()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_active_campaigns(detail, limit, offset, count, filters, sorters)
# results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters)
print("The response of CertificationCampaignsApi->get_active_campaigns:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->get_active_campaigns: %s\n" % e)
```
@@ -793,23 +817,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign to be retrieved. # str | ID of the campaign to be retrieved.
detail = 'FULL' # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional) # str | Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior. (optional)
try:
# Get Campaign
api_response = api_instance.get_campaign(id, )
results =CertificationCampaignsApi(api_client).get_campaign(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_campaign(id, detail)
# results = CertificationCampaignsApi(api_client).get_campaign(id, detail)
print("The response of CertificationCampaignsApi->get_campaign:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->get_campaign: %s\n" % e)
```
@@ -852,22 +879,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.campaign_report import CampaignReport
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign whose reports are being fetched. # str | ID of the campaign whose reports are being fetched.
try:
# Get Campaign Reports
api_response = api_instance.get_campaign_reports(id)
results =CertificationCampaignsApi(api_client).get_campaign_reports(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_campaign_reports(id)
# results = CertificationCampaignsApi(api_client).get_campaign_reports(id)
print("The response of CertificationCampaignsApi->get_campaign_reports:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->get_campaign_reports: %s\n" % e)
```
@@ -906,21 +936,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.campaign_reports_config import CampaignReportsConfig
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Campaign Reports Configuration
api_response = api_instance.get_campaign_reports_config()
results =CertificationCampaignsApi(api_client).get_campaign_reports_config()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_campaign_reports_config()
# results = CertificationCampaignsApi(api_client).get_campaign_reports_config()
print("The response of CertificationCampaignsApi->get_campaign_reports_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->get_campaign_reports_config: %s\n" % e)
```
@@ -963,22 +996,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.campaign_template import CampaignTemplate
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | Requested campaign template's ID. # str | Requested campaign template's ID.
try:
# Get a Campaign Template
api_response = api_instance.get_campaign_template(id)
results =CertificationCampaignsApi(api_client).get_campaign_template(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_campaign_template(id)
# results = CertificationCampaignsApi(api_client).get_campaign_template(id)
print("The response of CertificationCampaignsApi->get_campaign_template:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->get_campaign_template: %s\n" % e)
```
@@ -1021,22 +1057,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.schedule import Schedule
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '04bedce387bd47b2ae1f86eb0bb36dee' # str | ID of the campaign template whose schedule is being fetched. # str | ID of the campaign template whose schedule is being fetched.
try:
# Get Campaign Template Schedule
api_response = api_instance.get_campaign_template_schedule(id)
results =CertificationCampaignsApi(api_client).get_campaign_template_schedule(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_campaign_template_schedule(id)
# results = CertificationCampaignsApi(api_client).get_campaign_template_schedule(id)
print("The response of CertificationCampaignsApi->get_campaign_template_schedule:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->get_campaign_template_schedule: %s\n" % e)
```
@@ -1084,10 +1123,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.campaign_template import CampaignTemplate
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
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)
@@ -1097,13 +1140,12 @@ from pprint import pprint
try:
# List Campaign Templates
api_response = api_instance.get_campaign_templates()
results =CertificationCampaignsApi(api_client).get_campaign_templates()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_campaign_templates(limit, offset, count, sorters, filters)
# results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters)
print("The response of CertificationCampaignsApi->get_campaign_templates:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->get_campaign_templates: %s\n" % e)
```
@@ -1147,11 +1189,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.admin_review_reassign import AdminReviewReassign
from sailpoint.v3.models.certification_task import CertificationTask
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification campaign ID # str | The certification campaign ID
admin_review_reassign = {
"certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ],
@@ -1164,14 +1210,14 @@ from pprint import pprint
try:
# Reassign Certifications
Result = admin_review_reassign.from_json(admin_review_reassign)
api_response = api_instance.move(id, Result)
new_admin_review_reassign = AdminReviewReassign()
new_admin_review_reassign.from_json(admin_review_reassign)
results =CertificationCampaignsApi(api_client).move(id, new_admin_review_reassign)
# Below is a request that includes all optional parameters
# api_response = api_instance.move(id, Result)
# results = CertificationCampaignsApi(api_client).move(id, new_admin_review_reassign)
print("The response of CertificationCampaignsApi->move:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->move: %s\n" % e)
```
@@ -1215,11 +1261,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.campaign_template import CampaignTemplate
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified.
[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/campaign/filter/id, value=ff80818155fe8c080155fe8d925b0316}] # List[JsonPatchOperation] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create)
json_patch_operation = {
@@ -1231,14 +1281,14 @@ from pprint import pprint
try:
# Update a Campaign Template
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_campaign_template(id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =CertificationCampaignsApi(api_client).patch_campaign_template(id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_campaign_template(id, Result)
# results = CertificationCampaignsApi(api_client).patch_campaign_template(id, new_json_patch_operation)
print("The response of CertificationCampaignsApi->patch_campaign_template:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->patch_campaign_template: %s\n" % e)
```
@@ -1280,24 +1330,28 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.campaign_reports_config import CampaignReportsConfig
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
campaign_reports_config = {
"identityAttributeColumns" : [ "firstname", "lastname" ]
} # CampaignReportsConfig | Campaign report configuration.
try:
# Set Campaign Reports Configuration
Result = campaign_reports_config.from_json(campaign_reports_config)
api_response = api_instance.set_campaign_reports_config(Result)
new_campaign_reports_config = CampaignReportsConfig()
new_campaign_reports_config.from_json(campaign_reports_config)
results =CertificationCampaignsApi(api_client).set_campaign_reports_config(new_campaign_reports_config)
# Below is a request that includes all optional parameters
# api_response = api_instance.set_campaign_reports_config(Result)
# results = CertificationCampaignsApi(api_client).set_campaign_reports_config(new_campaign_reports_config)
print("The response of CertificationCampaignsApi->set_campaign_reports_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->set_campaign_reports_config: %s\n" % e)
```
@@ -1341,10 +1395,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.schedule import Schedule
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '04bedce387bd47b2ae1f86eb0bb36dee' # str | ID of the campaign template being scheduled. # str | ID of the campaign template being scheduled.
schedule = {
"hours" : {
@@ -1370,11 +1428,10 @@ from pprint import pprint
try:
# Set Campaign Template Schedule
api_instance.set_campaign_template_schedule(id, )
CertificationCampaignsApi(api_client).set_campaign_template_schedule(id, )
# Below is a request that includes all optional parameters
# api_instance.set_campaign_template_schedule(id, Result)
except Exception as e:
# CertificationCampaignsApi(api_client).set_campaign_template_schedule(id, new_schedule)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->set_campaign_template_schedule: %s\n" % e)
```
@@ -1418,10 +1475,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.activate_campaign_options import ActivateCampaignOptions
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Campaign ID. # str | Campaign ID.
activate_campaign_options = {
"timeZone" : "-05:00"
@@ -1430,13 +1491,12 @@ from pprint import pprint
try:
# Activate a Campaign
api_response = api_instance.start_campaign(id, )
results =CertificationCampaignsApi(api_client).start_campaign(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.start_campaign(id, Result)
# results = CertificationCampaignsApi(api_client).start_campaign(id, new_activate_campaign_options)
print("The response of CertificationCampaignsApi->start_campaign:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->start_campaign: %s\n" % e)
```
@@ -1479,21 +1539,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign the remediation scan is being run for. # str | ID of the campaign the remediation scan is being run for.
try:
# Run Campaign Remediation Scan
api_response = api_instance.start_campaign_remediation_scan(id)
results =CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.start_campaign_remediation_scan(id)
# results = CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id)
print("The response of CertificationCampaignsApi->start_campaign_remediation_scan:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->start_campaign_remediation_scan: %s\n" % e)
```
@@ -1537,23 +1600,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.report_type import ReportType
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign the report is being run for. # str | ID of the campaign the report is being run for.
type = sailpoint.v3.ReportType() # ReportType | Type of the report to run. # ReportType | Type of the report to run.
try:
# Run Campaign Report
api_response = api_instance.start_campaign_report(id, type)
results =CertificationCampaignsApi(api_client).start_campaign_report(id, type)
# Below is a request that includes all optional parameters
# api_response = api_instance.start_campaign_report(id, type)
# results = CertificationCampaignsApi(api_client).start_campaign_report(id, type)
print("The response of CertificationCampaignsApi->start_campaign_report:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->start_campaign_report: %s\n" % e)
```
@@ -1605,22 +1671,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.campaign_reference import CampaignReference
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template to use for generation. # str | ID of the campaign template to use for generation.
try:
# Generate a Campaign from Template
api_response = api_instance.start_generate_campaign_template(id)
results =CertificationCampaignsApi(api_client).start_generate_campaign_template(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.start_generate_campaign_template(id)
# results = CertificationCampaignsApi(api_client).start_generate_campaign_template(id)
print("The response of CertificationCampaignsApi->start_generate_campaign_template:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->start_generate_campaign_template: %s\n" % e)
```
@@ -1664,11 +1733,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
from sailpoint.v3.models.slim_campaign import SlimCampaign
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign template being modified. # str | ID of the campaign template being modified.
[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}] # List[JsonPatchOperation] | A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline
json_patch_operation = {
@@ -1680,14 +1753,14 @@ from pprint import pprint
try:
# Update a Campaign
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.update_campaign(id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =CertificationCampaignsApi(api_client).update_campaign(id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_campaign(id, Result)
# results = CertificationCampaignsApi(api_client).update_campaign(id, new_json_patch_operation)
print("The response of CertificationCampaignsApi->update_campaign:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationCampaignsApi->update_campaign: %s\n" % e)
```

60
docs/tools/sdk/python/Reference/V3/Methods/CertificationSummariesApi.md
View File

@@ -75,10 +75,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.access_summary import AccessSummary
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID
type = 'ACCESS_PROFILE' # str | The type of access review item to retrieve summaries for # str | The type of access review item to retrieve summaries for
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)
@@ -90,13 +94,12 @@ from pprint import pprint
try:
# Access Summaries
api_response = api_instance.get_identity_access_summaries(id, type, )
results =CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identity_access_summaries(id, type, limit, offset, count, filters, sorters)
# results = CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, limit, offset, count, filters, sorters)
print("The response of CertificationSummariesApi->get_identity_access_summaries:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationSummariesApi->get_identity_access_summaries: %s\n" % e)
```
@@ -139,23 +142,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.identity_cert_decision_summary import IdentityCertDecisionSummary
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID
filters = 'identitySummary.id eq \"ef38f94347e94562b5bb8424a56397d8\"' # 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: **identitySummary.id**: *eq, in* (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: **identitySummary.id**: *eq, in* (optional)
try:
# Summary of Certification Decisions
api_response = api_instance.get_identity_decision_summary(id, )
results =CertificationSummariesApi(api_client).get_identity_decision_summary(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identity_decision_summary(id, filters)
# results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters)
print("The response of CertificationSummariesApi->get_identity_decision_summary:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationSummariesApi->get_identity_decision_summary: %s\n" % e)
```
@@ -202,10 +208,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification 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)
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)
@@ -216,13 +226,12 @@ from pprint import pprint
try:
# Identity Summaries for Campaign Certification
api_response = api_instance.get_identity_summaries(id, )
results =CertificationSummariesApi(api_client).get_identity_summaries(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identity_summaries(id, limit, offset, count, filters, sorters)
# results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters)
print("The response of CertificationSummariesApi->get_identity_summaries:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationSummariesApi->get_identity_summaries: %s\n" % e)
```
@@ -265,23 +274,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certification_summaries_api import CertificationSummariesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.certification_identity_summary import CertificationIdentitySummary
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID
identity_summary_id = '2c91808772a504f50172a9540e501ba8' # str | The identity summary ID # str | The identity summary ID
try:
# Summary for Identity
api_response = api_instance.get_identity_summary(id, identity_summary_id)
results =CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identity_summary(id, identity_summary_id)
# results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id)
print("The response of CertificationSummariesApi->get_identity_summary:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationSummariesApi->get_identity_summary: %s\n" % e)
```

174
docs/tools/sdk/python/Reference/V3/Methods/CertificationsApi.md
View File

@@ -85,22 +85,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certifications_api import CertificationsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.certification_task import CertificationTask
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '63b32151-26c0-42f4-9299-8898dc1c9daa' # str | The task ID # str | The task ID
try:
# Certification Task by ID
api_response = api_instance.get_certification_task(id)
results =CertificationsApi(api_client).get_certification_task(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_certification_task(id)
# results = CertificationsApi(api_client).get_certification_task(id)
print("The response of CertificationsApi->get_certification_task:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationsApi->get_certification_task: %s\n" % e)
```
@@ -142,22 +145,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certifications_api import CertificationsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.identity_certification_dto import IdentityCertificationDto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification id # str | The certification id
try:
# Identity Certification by ID
api_response = api_instance.get_identity_certification(id)
results =CertificationsApi(api_client).get_identity_certification(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identity_certification(id)
# results = CertificationsApi(api_client).get_identity_certification(id)
print("The response of CertificationsApi->get_identity_certification:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationsApi->get_identity_certification: %s\n" % e)
```
@@ -204,10 +210,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certifications_api import CertificationsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.permission_dto import PermissionDto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
certification_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification ID
item_id = '2c91808671bcbab40171bd945d961227' # str | The certification item ID # str | The certification item ID
filters = 'target eq \"SYS.OBJAUTH2\"' # 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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (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: **target**: *eq, sw* **rights**: *ca* Supported composite operators: *and, or* All field values (second filter operands) are case-insensitive for this API. Only a single *and* or *or* composite filter operator may be used. It must also be used between a target filter and a rights filter, not between 2 filters for the same field. For example, the following is valid: `?filters=rights+ca+(%22CREATE%22)+and+target+eq+%22SYS.OBJAUTH2%22` The following is invalid: 1?filters=rights+ca+(%22CREATE%22)+and+rights+ca+(%SELECT%22)1 (optional)
@@ -218,13 +228,12 @@ from pprint import pprint
try:
# Permissions for Entitlement Certification Item
api_response = api_instance.get_identity_certification_item_permissions(certification_id, item_id, )
results =CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id, item_id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count)
# results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id, item_id, filters, limit, offset, count)
print("The response of CertificationsApi->get_identity_certification_item_permissions:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationsApi->get_identity_certification_item_permissions: %s\n" % e)
```
@@ -270,10 +279,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certifications_api import CertificationsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.certification_task import CertificationTask
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
reviewer_identity = 'Ada.1de82e55078344' # str | The ID of reviewer identity. *me* indicates the current user. (optional) # str | The ID of reviewer identity. *me* indicates the current user. (optional)
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)
@@ -283,13 +296,12 @@ from pprint import pprint
try:
# List of Pending Certification Tasks
api_response = api_instance.get_pending_certification_tasks()
results =CertificationsApi(api_client).get_pending_certification_tasks()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters)
# results = CertificationsApi(api_client).get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters)
print("The response of CertificationsApi->get_pending_certification_tasks:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationsApi->get_pending_certification_tasks: %s\n" % e)
```
@@ -336,10 +348,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certifications_api import CertificationsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.identity_reference_with_name_and_email import IdentityReferenceWithNameAndEmail
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The certification ID # str | The certification 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)
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)
@@ -350,13 +366,12 @@ from pprint import pprint
try:
# List of Reviewers for certification
api_response = api_instance.list_certification_reviewers(id, )
results =CertificationsApi(api_client).list_certification_reviewers(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_certification_reviewers(id, limit, offset, count, filters, sorters)
# results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters)
print("The response of CertificationsApi->list_certification_reviewers:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationsApi->list_certification_reviewers: %s\n" % e)
```
@@ -406,10 +421,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certifications_api import CertificationsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.access_review_item import AccessReviewItem
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification 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)
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)
@@ -423,13 +442,12 @@ from pprint import pprint
try:
# List of Access Review Items
api_response = api_instance.list_identity_access_review_items(id, )
results =CertificationsApi(api_client).list_identity_access_review_items(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_identity_access_review_items(id, limit, offset, count, filters, sorters, entitlements, access_profiles, roles)
# results = CertificationsApi(api_client).list_identity_access_review_items(id, limit, offset, count, filters, sorters, entitlements, access_profiles, roles)
print("The response of CertificationsApi->list_identity_access_review_items:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationsApi->list_identity_access_review_items: %s\n" % e)
```
@@ -475,10 +493,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certifications_api import CertificationsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.identity_certification_dto import IdentityCertificationDto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
reviewer_identity = 'me' # str | Reviewer's identity. *me* indicates the current user. (optional) # str | Reviewer's identity. *me* indicates the current user. (optional)
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)
@@ -489,13 +511,12 @@ from pprint import pprint
try:
# List Identity Campaign Certifications
api_response = api_instance.list_identity_certifications()
results =CertificationsApi(api_client).list_identity_certifications()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters)
# results = CertificationsApi(api_client).list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters)
print("The response of CertificationsApi->list_identity_certifications:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationsApi->list_identity_certifications: %s\n" % e)
```
@@ -538,11 +559,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certifications_api import CertificationsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.identity_certification_dto import IdentityCertificationDto
from sailpoint.v3.models.review_decision import ReviewDecision
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the identity campaign certification on which to make decisions # str | The ID of the identity campaign certification on which to make decisions
[{id=ef38f94347e94562b5bb8424a56396b5, decision=APPROVE, bulk=true, comments=This user still needs access to this source.}, {id=ef38f94347e94562b5bb8424a56397d8, decision=APPROVE, bulk=true, comments=This user still needs access to this source too.}] # List[ReviewDecision] | A non-empty array of decisions to be made.
review_decision = {
@@ -561,14 +586,14 @@ from pprint import pprint
try:
# Decide on a Certification Item
Result = review_decision.from_json(review_decision)
api_response = api_instance.make_identity_decision(id, Result)
new_review_decision = ReviewDecision()
new_review_decision.from_json(review_decision)
results =CertificationsApi(api_client).make_identity_decision(id, new_review_decision)
# Below is a request that includes all optional parameters
# api_response = api_instance.make_identity_decision(id, Result)
# results = CertificationsApi(api_client).make_identity_decision(id, new_review_decision)
print("The response of CertificationsApi->make_identity_decision:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationsApi->make_identity_decision: %s\n" % e)
```
@@ -611,11 +636,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certifications_api import CertificationsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.identity_certification_dto import IdentityCertificationDto
from sailpoint.v3.models.review_reassign import ReviewReassign
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID
review_reassign = {
"reason" : "reassigned for some reason",
@@ -631,14 +660,14 @@ from pprint import pprint
try:
# Reassign Identities or Items
Result = review_reassign.from_json(review_reassign)
api_response = api_instance.reassign_identity_certifications(id, Result)
new_review_reassign = ReviewReassign()
new_review_reassign.from_json(review_reassign)
results =CertificationsApi(api_client).reassign_identity_certifications(id, new_review_reassign)
# Below is a request that includes all optional parameters
# api_response = api_instance.reassign_identity_certifications(id, Result)
# results = CertificationsApi(api_client).reassign_identity_certifications(id, new_review_reassign)
print("The response of CertificationsApi->reassign_identity_certifications:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationsApi->reassign_identity_certifications: %s\n" % e)
```
@@ -680,22 +709,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certifications_api import CertificationsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.identity_certification_dto import IdentityCertificationDto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID
try:
# Finalize Identity Certification Decisions
api_response = api_instance.sign_off_identity_certification(id)
results =CertificationsApi(api_client).sign_off_identity_certification(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.sign_off_identity_certification(id)
# results = CertificationsApi(api_client).sign_off_identity_certification(id)
print("The response of CertificationsApi->sign_off_identity_certification:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationsApi->sign_off_identity_certification: %s\n" % e)
```
@@ -743,11 +775,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.certifications_api import CertificationsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.certification_task import CertificationTask
from sailpoint.v3.models.review_reassign import ReviewReassign
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The identity campaign certification ID # str | The identity campaign certification ID
review_reassign = {
"reason" : "reassigned for some reason",
@@ -763,14 +799,14 @@ from pprint import pprint
try:
# Reassign Certifications Asynchronously
Result = review_reassign.from_json(review_reassign)
api_response = api_instance.submit_reassign_certs_async(id, Result)
new_review_reassign = ReviewReassign()
new_review_reassign.from_json(review_reassign)
results =CertificationsApi(api_client).submit_reassign_certs_async(id, new_review_reassign)
# Below is a request that includes all optional parameters
# api_response = api_instance.submit_reassign_certs_async(id, Result)
# results = CertificationsApi(api_client).submit_reassign_certs_async(id, new_review_reassign)
print("The response of CertificationsApi->submit_reassign_certs_async:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling CertificationsApi->submit_reassign_certs_async: %s\n" % e)
```

140
docs/tools/sdk/python/Reference/V3/Methods/ConfigurationHubApi.md
View File

@@ -73,11 +73,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.object_mapping_request import ObjectMappingRequest
from sailpoint.v3.models.object_mapping_response import ObjectMappingResponse
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_org = 'source-org' # str | The name of the source org. # str | The name of the source org.
object_mapping_request = {
"targetValue" : "My New Governance Group Name",
@@ -89,14 +93,14 @@ from pprint import pprint
try:
# Creates an object mapping
Result = object_mapping_request.from_json(object_mapping_request)
api_response = api_instance.create_object_mapping(source_org, Result)
new_object_mapping_request = ObjectMappingRequest()
new_object_mapping_request.from_json(object_mapping_request)
results =ConfigurationHubApi(api_client).create_object_mapping(source_org, new_object_mapping_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_object_mapping(source_org, Result)
# results = ConfigurationHubApi(api_client).create_object_mapping(source_org, new_object_mapping_request)
print("The response of ConfigurationHubApi->create_object_mapping:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->create_object_mapping: %s\n" % e)
```
@@ -142,11 +146,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.object_mapping_bulk_create_request import ObjectMappingBulkCreateRequest
from sailpoint.v3.models.object_mapping_bulk_create_response import ObjectMappingBulkCreateResponse
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_org = 'source-org' # str | The name of the source org. # str | The name of the source org.
object_mapping_bulk_create_request = {
"newObjectsMappings" : [ {
@@ -166,14 +174,14 @@ from pprint import pprint
try:
# Bulk creates object mappings
Result = object_mapping_bulk_create_request.from_json(object_mapping_bulk_create_request)
api_response = api_instance.create_object_mappings(source_org, Result)
new_object_mapping_bulk_create_request = ObjectMappingBulkCreateRequest()
new_object_mapping_bulk_create_request.from_json(object_mapping_bulk_create_request)
results =ConfigurationHubApi(api_client).create_object_mappings(source_org, new_object_mapping_bulk_create_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_object_mappings(source_org, Result)
# results = ConfigurationHubApi(api_client).create_object_mappings(source_org, new_object_mapping_bulk_create_request)
print("The response of ConfigurationHubApi->create_object_mappings:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->create_object_mappings: %s\n" % e)
```
@@ -219,23 +227,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.backup_response import BackupResponse
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported.
name = 'name_example' # str | Name that will be assigned to the uploaded configuration file. # str | Name that will be assigned to the uploaded configuration file.
try:
# Upload a Configuration
api_response = api_instance.create_uploaded_configuration(data, name)
results =ConfigurationHubApi(api_client).create_uploaded_configuration(data, name)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_uploaded_configuration(data, name)
# results = ConfigurationHubApi(api_client).create_uploaded_configuration(data, name)
print("The response of ConfigurationHubApi->create_uploaded_configuration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->create_uploaded_configuration: %s\n" % e)
```
@@ -281,20 +292,23 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_org = 'source-org' # str | The name of the source org. # str | The name of the source org.
object_mapping_id = '3d6e0144-963f-4bd6-8d8d-d77b4e507ce4' # str | The id of the object mapping to be deleted. # str | The id of the object mapping to be deleted.
try:
# Deletes an object mapping
api_instance.delete_object_mapping(source_org, object_mapping_id)
ConfigurationHubApi(api_client).delete_object_mapping(source_org, object_mapping_id)
# Below is a request that includes all optional parameters
# api_instance.delete_object_mapping(source_org, object_mapping_id)
except Exception as e:
# ConfigurationHubApi(api_client).delete_object_mapping(source_org, object_mapping_id)
except Exception as e:
print("Exception when calling ConfigurationHubApi->delete_object_mapping: %s\n" % e)
```
@@ -340,19 +354,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '3d0fe04b-57df-4a46-a83b-8f04b0f9d10b' # str | The id of the uploaded configuration. # str | The id of the uploaded configuration.
try:
# Delete an Uploaded Configuration
api_instance.delete_uploaded_configuration(id)
ConfigurationHubApi(api_client).delete_uploaded_configuration(id)
# Below is a request that includes all optional parameters
# api_instance.delete_uploaded_configuration(id)
except Exception as e:
# ConfigurationHubApi(api_client).delete_uploaded_configuration(id)
except Exception as e:
print("Exception when calling ConfigurationHubApi->delete_uploaded_configuration: %s\n" % e)
```
@@ -397,22 +414,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.object_mapping_response import ObjectMappingResponse
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_org = 'source-org' # str | The name of the source org. # str | The name of the source org.
try:
# Gets list of object mappings
api_response = api_instance.get_object_mappings(source_org)
results =ConfigurationHubApi(api_client).get_object_mappings(source_org)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_object_mappings(source_org)
# results = ConfigurationHubApi(api_client).get_object_mappings(source_org)
print("The response of ConfigurationHubApi->get_object_mappings:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->get_object_mappings: %s\n" % e)
```
@@ -454,22 +474,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.backup_response import BackupResponse
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '3d0fe04b-57df-4a46-a83b-8f04b0f9d10b' # str | The id of the uploaded configuration. # str | The id of the uploaded configuration.
try:
# Get an Uploaded Configuration
api_response = api_instance.get_uploaded_configuration(id)
results =ConfigurationHubApi(api_client).get_uploaded_configuration(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_uploaded_configuration(id)
# results = ConfigurationHubApi(api_client).get_uploaded_configuration(id)
print("The response of ConfigurationHubApi->get_uploaded_configuration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->get_uploaded_configuration: %s\n" % e)
```
@@ -511,22 +534,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.backup_response import BackupResponse
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
filters = 'status eq \"COMPLETE\"' # 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: **status**: *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: **status**: *eq* (optional)
try:
# List Uploaded Configurations
api_response = api_instance.list_uploaded_configurations()
results =ConfigurationHubApi(api_client).list_uploaded_configurations()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_uploaded_configurations(filters)
# results = ConfigurationHubApi(api_client).list_uploaded_configurations(filters)
print("The response of ConfigurationHubApi->list_uploaded_configurations:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->list_uploaded_configurations: %s\n" % e)
```
@@ -572,11 +598,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.object_mapping_bulk_patch_request import ObjectMappingBulkPatchRequest
from sailpoint.v3.models.object_mapping_bulk_patch_response import ObjectMappingBulkPatchResponse
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_org = 'source-org' # str | The name of the source org. # str | The name of the source org.
object_mapping_bulk_patch_request = {
"patches" : {
@@ -595,14 +625,14 @@ from pprint import pprint
try:
# Bulk updates object mappings
Result = object_mapping_bulk_patch_request.from_json(object_mapping_bulk_patch_request)
api_response = api_instance.update_object_mappings(source_org, Result)
new_object_mapping_bulk_patch_request = ObjectMappingBulkPatchRequest()
new_object_mapping_bulk_patch_request.from_json(object_mapping_bulk_patch_request)
results =ConfigurationHubApi(api_client).update_object_mappings(source_org, new_object_mapping_bulk_patch_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_object_mappings(source_org, Result)
# results = ConfigurationHubApi(api_client).update_object_mappings(source_org, new_object_mapping_bulk_patch_request)
print("The response of ConfigurationHubApi->update_object_mappings:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConfigurationHubApi->update_object_mappings: %s\n" % e)
```

169
docs/tools/sdk/python/Reference/V3/Methods/ConnectorsApi.md
View File

@@ -76,11 +76,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.connectors_api import ConnectorsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.v3_connector_dto import V3ConnectorDto
from sailpoint.v3.models.v3_create_connector_dto import V3CreateConnectorDto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
v3_create_connector_dto = {
"name" : "custom connector",
"directConnect" : true,
@@ -91,14 +95,14 @@ from pprint import pprint
try:
# Create Custom Connector
Result = v3_create_connector_dto.from_json(v3_create_connector_dto)
api_response = api_instance.create_custom_connector(Result)
new_v3_create_connector_dto = V3CreateConnectorDto()
new_v3_create_connector_dto.from_json(v3_create_connector_dto)
results =ConnectorsApi(api_client).create_custom_connector(new_v3_create_connector_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_custom_connector(Result)
# results = ConnectorsApi(api_client).create_custom_connector(new_v3_create_connector_dto)
print("The response of ConnectorsApi->create_custom_connector:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorsApi->create_custom_connector: %s\n" % e)
```
@@ -140,19 +144,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.connectors_api import ConnectorsApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
try:
# Delete Connector by Script Name
api_instance.delete_custom_connector(script_name)
ConnectorsApi(api_client).delete_custom_connector(script_name)
# Below is a request that includes all optional parameters
# api_instance.delete_custom_connector(script_name)
except Exception as e:
# ConnectorsApi(api_client).delete_custom_connector(script_name)
except Exception as e:
print("Exception when calling ConnectorsApi->delete_custom_connector: %s\n" % e)
```
@@ -195,23 +202,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.connectors_api import ConnectorsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.connector_detail import ConnectorDetail
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
locale = 'de' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional) # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" (optional)
try:
# Get Connector by Script Name
api_response = api_instance.get_connector(script_name, )
results =ConnectorsApi(api_client).get_connector(script_name, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_connector(script_name, locale)
# results = ConnectorsApi(api_client).get_connector(script_name, locale)
print("The response of ConnectorsApi->get_connector:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorsApi->get_connector: %s\n" % e)
```
@@ -257,10 +267,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.connectors_api import ConnectorsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.v3_connector_dto import V3ConnectorDto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
filters = 'directConnect eq \"true\"' # 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: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (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: **name**: *sw, co* **type**: *sw, co, eq* **directConnect**: *eq* **category**: *eq* **features**: *ca* **labels**: *ca* (optional)
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)
@@ -270,13 +284,12 @@ from pprint import pprint
try:
# Get Connector List
api_response = api_instance.get_connector_list()
results =ConnectorsApi(api_client).get_connector_list()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_connector_list(filters, limit, offset, count, locale)
# results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale)
print("The response of ConnectorsApi->get_connector_list:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorsApi->get_connector_list: %s\n" % e)
```
@@ -318,21 +331,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.connectors_api import ConnectorsApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
try:
# Get Connector Source Configuration
api_response = api_instance.get_connector_source_config(script_name)
results =ConnectorsApi(api_client).get_connector_source_config(script_name)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_connector_source_config(script_name)
# results = ConnectorsApi(api_client).get_connector_source_config(script_name)
print("The response of ConnectorsApi->get_connector_source_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorsApi->get_connector_source_config: %s\n" % e)
```
@@ -374,21 +390,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.connectors_api import ConnectorsApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
try:
# Get Connector Source Template
api_response = api_instance.get_connector_source_template(script_name)
results =ConnectorsApi(api_client).get_connector_source_template(script_name)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_connector_source_template(script_name)
# results = ConnectorsApi(api_client).get_connector_source_template(script_name)
print("The response of ConnectorsApi->get_connector_source_template:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorsApi->get_connector_source_template: %s\n" % e)
```
@@ -431,22 +450,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.connectors_api import ConnectorsApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
locale = 'de' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\"
try:
# Get Connector Translations
api_response = api_instance.get_connector_translations(script_name, locale)
results =ConnectorsApi(api_client).get_connector_translations(script_name, locale)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_connector_translations(script_name, locale)
# results = ConnectorsApi(api_client).get_connector_translations(script_name, locale)
print("The response of ConnectorsApi->get_connector_translations:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorsApi->get_connector_translations: %s\n" % e)
```
@@ -489,23 +511,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.connectors_api import ConnectorsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.update_detail import UpdateDetail
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
file = None # bytearray | connector source config xml file # bytearray | connector source config xml file
try:
# Update Connector Source Configuration
api_response = api_instance.put_connector_source_config(script_name, file)
results =ConnectorsApi(api_client).put_connector_source_config(script_name, file)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_connector_source_config(script_name, file)
# results = ConnectorsApi(api_client).put_connector_source_config(script_name, file)
print("The response of ConnectorsApi->put_connector_source_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorsApi->put_connector_source_config: %s\n" % e)
```
@@ -548,23 +573,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.connectors_api import ConnectorsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.update_detail import UpdateDetail
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
file = None # bytearray | connector source template xml file # bytearray | connector source template xml file
try:
# Update Connector Source Template
api_response = api_instance.put_connector_source_template(script_name, file)
results =ConnectorsApi(api_client).put_connector_source_template(script_name, file)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_connector_source_template(script_name, file)
# results = ConnectorsApi(api_client).put_connector_source_template(script_name, file)
print("The response of ConnectorsApi->put_connector_source_template:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorsApi->put_connector_source_template: %s\n" % e)
```
@@ -607,23 +635,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.connectors_api import ConnectorsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.update_detail import UpdateDetail
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation. # str | The scriptName value of the connector. Scriptname is the unique id generated at connector creation.
locale = 'de' # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\" # str | The locale to apply to the config. If no viable locale is given, it will default to \"en\"
try:
# Update Connector Translations
api_response = api_instance.put_connector_translations(script_name, locale)
results =ConnectorsApi(api_client).put_connector_translations(script_name, locale)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_connector_translations(script_name, locale)
# results = ConnectorsApi(api_client).put_connector_translations(script_name, locale)
print("The response of ConnectorsApi->put_connector_translations:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorsApi->put_connector_translations: %s\n" % e)
```
@@ -678,11 +709,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.connectors_api import ConnectorsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.connector_detail import ConnectorDetail
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation. # str | The scriptName value of the connector. ScriptName is the unique id generated at connector creation.
[sailpoint.v3.JsonPatchOperation()] # List[JsonPatchOperation] | A list of connector detail update operations
json_patch_operation = {
@@ -694,14 +729,14 @@ from pprint import pprint
try:
# Update Connector by Script Name
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.update_connector(script_name, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =ConnectorsApi(api_client).update_connector(script_name, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_connector(script_name, Result)
# results = ConnectorsApi(api_client).update_connector(script_name, new_json_patch_operation)
print("The response of ConnectorsApi->update_connector:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ConnectorsApi->update_connector: %s\n" % e)
```

150
docs/tools/sdk/python/Reference/V3/Methods/GlobalTenantSecuritySettingsApi.md
View File

@@ -63,10 +63,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.network_configuration import NetworkConfiguration
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
network_configuration = {
"range" : [ "1.3.7.2", "255.255.255.252/30" ],
"whitelisted" : true,
@@ -75,14 +79,14 @@ from pprint import pprint
try:
# Create security network configuration.
Result = network_configuration.from_json(network_configuration)
api_response = api_instance.create_auth_org_network_config(Result)
new_network_configuration = NetworkConfiguration()
new_network_configuration.from_json(network_configuration)
results =GlobalTenantSecuritySettingsApi(api_client).create_auth_org_network_config(new_network_configuration)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_auth_org_network_config(Result)
# results = GlobalTenantSecuritySettingsApi(api_client).create_auth_org_network_config(new_network_configuration)
print("The response of GlobalTenantSecuritySettingsApi->create_auth_org_network_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GlobalTenantSecuritySettingsApi->create_auth_org_network_config: %s\n" % e)
```
@@ -121,21 +125,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.lockout_configuration import LockoutConfiguration
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Auth Org Lockout Configuration.
api_response = api_instance.get_auth_org_lockout_config()
results =GlobalTenantSecuritySettingsApi(api_client).get_auth_org_lockout_config()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_auth_org_lockout_config()
# results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_lockout_config()
print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_lockout_config: %s\n" % e)
```
@@ -174,21 +181,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.network_configuration import NetworkConfiguration
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get security network configuration.
api_response = api_instance.get_auth_org_network_config()
results =GlobalTenantSecuritySettingsApi(api_client).get_auth_org_network_config()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_auth_org_network_config()
# results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_network_config()
print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_network_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_network_config: %s\n" % e)
```
@@ -227,21 +237,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.service_provider_configuration import ServiceProviderConfiguration
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Service Provider Configuration.
api_response = api_instance.get_auth_org_service_provider_config()
results =GlobalTenantSecuritySettingsApi(api_client).get_auth_org_service_provider_config()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_auth_org_service_provider_config()
# results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_service_provider_config()
print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_service_provider_config: %s\n" % e)
```
@@ -280,21 +293,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.session_configuration import SessionConfiguration
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Auth Org Session Configuration.
api_response = api_instance.get_auth_org_session_config()
results =GlobalTenantSecuritySettingsApi(api_client).get_auth_org_session_config()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_auth_org_session_config()
# results = GlobalTenantSecuritySettingsApi(api_client).get_auth_org_session_config()
print("The response of GlobalTenantSecuritySettingsApi->get_auth_org_session_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GlobalTenantSecuritySettingsApi->get_auth_org_session_config: %s\n" % e)
```
@@ -337,11 +353,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
from sailpoint.v3.models.lockout_configuration import LockoutConfiguration
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
[{op=replace, path=/maximumAttempts, value=7,}, {op=add, path=/lockoutDuration, value=35}] # List[JsonPatchOperation] | A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: `1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60`
json_patch_operation = {
"op" : "replace",
@@ -352,14 +372,14 @@ from pprint import pprint
try:
# Update Auth Org Lockout Configuration
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_auth_org_lockout_config(Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_lockout_config(new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_auth_org_lockout_config(Result)
# results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_lockout_config(new_json_patch_operation)
print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_lockout_config: %s\n" % e)
```
@@ -402,11 +422,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
from sailpoint.v3.models.network_configuration import NetworkConfiguration
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
[{op=replace, path=/whitelisted, value=false,}, {op=add, path=/geolocation, value=[AF, HN, ES]}] # List[JsonPatchOperation] | A list of auth org network configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Network Config conforms to certain logical guidelines, which are: 1. Each string element in the range array must be a valid ip address or ip subnet mask. 2. Each string element in the geolocation array must be 2 characters, and they can only be uppercase letters.
json_patch_operation = {
"op" : "replace",
@@ -417,14 +441,14 @@ from pprint import pprint
try:
# Update security network configuration.
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_auth_org_network_config(Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_network_config(new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_auth_org_network_config(Result)
# results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_network_config(new_json_patch_operation)
print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_network_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_network_config: %s\n" % e)
```
@@ -466,11 +490,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
from sailpoint.v3.models.service_provider_configuration import ServiceProviderConfiguration
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
[{op=replace, path=/enabled, value=true,}, {op=add, path=/federationProtocolDetails/0/jitConfiguration, value={enabled=true, sourceId=2c9180857377ed2901739c12a2da5ac8, sourceAttributeMappings={firstName=okta.firstName, lastName=okta.lastName, email=okta.email, employeeNumber=okta.employeeNumber}}}] # List[JsonPatchOperation] | A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email)
json_patch_operation = {
"op" : "replace",
@@ -481,14 +509,14 @@ from pprint import pprint
try:
# Update Service Provider Configuration
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_auth_org_service_provider_config(Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_service_provider_config(new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_auth_org_service_provider_config(Result)
# results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_service_provider_config(new_json_patch_operation)
print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_service_provider_config: %s\n" % e)
```
@@ -530,11 +558,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.global_tenant_security_settings_api import GlobalTenantSecuritySettingsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
from sailpoint.v3.models.session_configuration import SessionConfiguration
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
[{op=replace, path=/rememberMe, value=true,}, {op=add, path=/maxSessionTime, value=480}] # List[JsonPatchOperation] | A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: `1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.`
json_patch_operation = {
"op" : "replace",
@@ -545,14 +577,14 @@ from pprint import pprint
try:
# Update Auth Org Session Configuration
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_auth_org_session_config(Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_session_config(new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_auth_org_session_config(Result)
# results = GlobalTenantSecuritySettingsApi(api_client).patch_auth_org_session_config(new_json_patch_operation)
print("The response of GlobalTenantSecuritySettingsApi->patch_auth_org_session_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling GlobalTenantSecuritySettingsApi->patch_auth_org_session_config: %s\n" % e)
```

180
docs/tools/sdk/python/Reference/V3/Methods/IdentityProfilesApi.md
View File

@@ -71,10 +71,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.identity_profile import IdentityProfile
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile = {
"owner" : {
"name" : "William Wilson",
@@ -127,14 +131,14 @@ from pprint import pprint
try:
# Create an Identity Profile
Result = identity_profile.from_json(identity_profile)
api_response = api_instance.create_identity_profile(Result)
new_identity_profile = IdentityProfile()
new_identity_profile.from_json(identity_profile)
results =IdentityProfilesApi(api_client).create_identity_profile(new_identity_profile)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_identity_profile(Result)
# results = IdentityProfilesApi(api_client).create_identity_profile(new_identity_profile)
print("The response of IdentityProfilesApi->create_identity_profile:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityProfilesApi->create_identity_profile: %s\n" % e)
```
@@ -181,22 +185,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.task_result_simplified import TaskResultSimplified
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Identity Profile ID. # str | The Identity Profile ID.
try:
# Delete an Identity Profile
api_response = api_instance.delete_identity_profile(identity_profile_id)
results =IdentityProfilesApi(api_client).delete_identity_profile(identity_profile_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_identity_profile(identity_profile_id)
# results = IdentityProfilesApi(api_client).delete_identity_profile(identity_profile_id)
print("The response of IdentityProfilesApi->delete_identity_profile:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityProfilesApi->delete_identity_profile: %s\n" % e)
```
@@ -241,24 +248,28 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.task_result_simplified import TaskResultSimplified
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body.
request_body = ['request_body_example'] # List[str] | Identity Profile bulk delete request body.
try:
# Delete Identity Profiles
Result = request_body.from_json(request_body)
api_response = api_instance.delete_identity_profiles(Result)
new_request_body = RequestBody()
new_request_body.from_json(request_body)
results =IdentityProfilesApi(api_client).delete_identity_profiles(new_request_body)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_identity_profiles(Result)
# results = IdentityProfilesApi(api_client).delete_identity_profiles(new_request_body)
print("The response of IdentityProfilesApi->delete_identity_profiles:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityProfilesApi->delete_identity_profiles: %s\n" % e)
```
@@ -303,10 +314,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.identity_profile_exported_object import IdentityProfileExportedObject
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
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)
@@ -316,13 +331,12 @@ from pprint import pprint
try:
# Export Identity Profiles
api_response = api_instance.export_identity_profiles()
results =IdentityProfilesApi(api_client).export_identity_profiles()
# Below is a request that includes all optional parameters
# api_response = api_instance.export_identity_profiles(limit, offset, count, filters, sorters)
# results = IdentityProfilesApi(api_client).export_identity_profiles(limit, offset, count, filters, sorters)
print("The response of IdentityProfilesApi->export_identity_profiles:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityProfilesApi->export_identity_profiles: %s\n" % e)
```
@@ -364,22 +378,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.identity_attribute_config import IdentityAttributeConfig
from sailpoint.v3.rest import ApiException
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 | The Identity Profile ID. # str | The Identity Profile ID.
try:
# Get default Identity Attribute Config
api_response = api_instance.get_default_identity_attribute_config(identity_profile_id)
results =IdentityProfilesApi(api_client).get_default_identity_attribute_config(identity_profile_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_default_identity_attribute_config(identity_profile_id)
# results = IdentityProfilesApi(api_client).get_default_identity_attribute_config(identity_profile_id)
print("The response of IdentityProfilesApi->get_default_identity_attribute_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityProfilesApi->get_default_identity_attribute_config: %s\n" % e)
```
@@ -421,22 +438,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.identity_profile import IdentityProfile
from sailpoint.v3.rest import ApiException
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 | The Identity Profile ID. # str | The Identity Profile ID.
try:
# Get single Identity Profile
api_response = api_instance.get_identity_profile(identity_profile_id)
results =IdentityProfilesApi(api_client).get_identity_profile(identity_profile_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_identity_profile(identity_profile_id)
# results = IdentityProfilesApi(api_client).get_identity_profile(identity_profile_id)
print("The response of IdentityProfilesApi->get_identity_profile:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityProfilesApi->get_identity_profile: %s\n" % e)
```
@@ -477,11 +497,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.identity_profile_exported_object import IdentityProfileExportedObject
from sailpoint.v3.models.object_import_result import ObjectImportResult
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
[sailpoint.v3.IdentityProfileExportedObject()] # List[IdentityProfileExportedObject] | Previously exported Identity Profiles.
identity_profile_exported_object = {
"self" : {
@@ -544,14 +568,14 @@ from pprint import pprint
try:
# Import Identity Profiles
Result = identity_profile_exported_object.from_json(identity_profile_exported_object)
api_response = api_instance.import_identity_profiles(Result)
new_identity_profile_exported_object = IdentityProfileExportedObject()
new_identity_profile_exported_object.from_json(identity_profile_exported_object)
results =IdentityProfilesApi(api_client).import_identity_profiles(new_identity_profile_exported_object)
# Below is a request that includes all optional parameters
# api_response = api_instance.import_identity_profiles(Result)
# results = IdentityProfilesApi(api_client).import_identity_profiles(new_identity_profile_exported_object)
print("The response of IdentityProfilesApi->import_identity_profiles:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityProfilesApi->import_identity_profiles: %s\n" % e)
```
@@ -596,10 +620,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.identity_profile import IdentityProfile
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
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)
@@ -609,13 +637,12 @@ from pprint import pprint
try:
# Identity Profiles List
api_response = api_instance.list_identity_profiles()
results =IdentityProfilesApi(api_client).list_identity_profiles()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_identity_profiles(limit, offset, count, filters, sorters)
# results = IdentityProfilesApi(api_client).list_identity_profiles(limit, offset, count, filters, sorters)
print("The response of IdentityProfilesApi->list_identity_profiles:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityProfilesApi->list_identity_profiles: %s\n" % e)
```
@@ -657,11 +684,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.identity_preview_request import IdentityPreviewRequest
from sailpoint.v3.models.identity_preview_response import IdentityPreviewResponse
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_preview_request = {
"identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"identityAttributeConfig" : {
@@ -692,14 +723,14 @@ from pprint import pprint
try:
# Generate Identity Profile Preview
Result = identity_preview_request.from_json(identity_preview_request)
api_response = api_instance.show_identity_preview(Result)
new_identity_preview_request = IdentityPreviewRequest()
new_identity_preview_request.from_json(identity_preview_request)
results =IdentityProfilesApi(api_client).show_identity_preview(new_identity_preview_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.show_identity_preview(Result)
# results = IdentityProfilesApi(api_client).show_identity_preview(new_identity_preview_request)
print("The response of IdentityProfilesApi->show_identity_preview:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityProfilesApi->show_identity_preview: %s\n" % e)
```
@@ -745,21 +776,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Identity Profile ID to be processed # str | The Identity Profile ID to be processed
try:
# Process identities under profile
api_response = api_instance.sync_identity_profile(identity_profile_id)
results =IdentityProfilesApi(api_client).sync_identity_profile(identity_profile_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.sync_identity_profile(identity_profile_id)
# results = IdentityProfilesApi(api_client).sync_identity_profile(identity_profile_id)
print("The response of IdentityProfilesApi->sync_identity_profile:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityProfilesApi->sync_identity_profile: %s\n" % e)
```
@@ -812,11 +846,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.identity_profile import IdentityProfile
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Identity Profile ID # str | The Identity Profile ID
[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}] # List[JsonPatchOperation] | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
json_patch_operation = {
@@ -828,14 +866,14 @@ from pprint import pprint
try:
# Update the Identity Profile
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.update_identity_profile(identity_profile_id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =IdentityProfilesApi(api_client).update_identity_profile(identity_profile_id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_identity_profile(identity_profile_id, Result)
# results = IdentityProfilesApi(api_client).update_identity_profile(identity_profile_id, new_json_patch_operation)
print("The response of IdentityProfilesApi->update_identity_profile:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling IdentityProfilesApi->update_identity_profile: %s\n" % e)
```

99
docs/tools/sdk/python/Reference/V3/Methods/LifecycleStatesApi.md
View File

@@ -95,10 +95,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.lifecycle_states_api import LifecycleStatesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.lifecycle_state import LifecycleState
from sailpoint.v3.rest import ApiException
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 = {
"accessProfileIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ],
@@ -128,14 +132,14 @@ from pprint import pprint
try:
# Create Lifecycle State
Result = lifecycle_state.from_json(lifecycle_state)
api_response = api_instance.create_lifecycle_state(identity_profile_id, Result)
new_lifecycle_state = LifecycleState()
new_lifecycle_state.from_json(lifecycle_state)
results =LifecycleStatesApi(api_client).create_lifecycle_state(identity_profile_id, new_lifecycle_state)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_lifecycle_state(identity_profile_id, Result)
# results = LifecycleStatesApi(api_client).create_lifecycle_state(identity_profile_id, new_lifecycle_state)
print("The response of LifecycleStatesApi->create_lifecycle_state:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling LifecycleStatesApi->create_lifecycle_state: %s\n" % e)
```
@@ -178,23 +182,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.lifecycle_states_api import LifecycleStatesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.lifecyclestate_deleted import LifecyclestateDeleted
from sailpoint.v3.rest import ApiException
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.
try:
# Delete Lifecycle State
api_response = api_instance.delete_lifecycle_state(identity_profile_id, lifecycle_state_id)
results =LifecycleStatesApi(api_client).delete_lifecycle_state(identity_profile_id, lifecycle_state_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_lifecycle_state(identity_profile_id, lifecycle_state_id)
# results = LifecycleStatesApi(api_client).delete_lifecycle_state(identity_profile_id, lifecycle_state_id)
print("The response of LifecycleStatesApi->delete_lifecycle_state:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling LifecycleStatesApi->delete_lifecycle_state: %s\n" % e)
```
@@ -237,23 +244,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.lifecycle_states_api import LifecycleStatesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.lifecycle_state import LifecycleState
from sailpoint.v3.rest import ApiException
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.
try:
# Get Lifecycle State
api_response = api_instance.get_lifecycle_state(identity_profile_id, lifecycle_state_id)
results =LifecycleStatesApi(api_client).get_lifecycle_state(identity_profile_id, lifecycle_state_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_lifecycle_state(identity_profile_id, lifecycle_state_id)
# results = LifecycleStatesApi(api_client).get_lifecycle_state(identity_profile_id, lifecycle_state_id)
print("The response of LifecycleStatesApi->get_lifecycle_state:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling LifecycleStatesApi->get_lifecycle_state: %s\n" % e)
```
@@ -298,10 +308,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.lifecycle_states_api import LifecycleStatesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.lifecycle_state import LifecycleState
from sailpoint.v3.rest import ApiException
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)
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)
@@ -311,13 +325,12 @@ from pprint import pprint
try:
# Lists LifecycleStates
api_response = api_instance.get_lifecycle_states(identity_profile_id, )
results =LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_lifecycle_states(identity_profile_id, limit, offset, count, sorters)
# results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, limit, offset, count, sorters)
print("The response of LifecycleStatesApi->get_lifecycle_states:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling LifecycleStatesApi->get_lifecycle_states: %s\n" % e)
```
@@ -360,24 +373,28 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.lifecycle_states_api import LifecycleStatesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.set_lifecycle_state200_response import SetLifecycleState200Response
from sailpoint.v3.models.set_lifecycle_state_request import SetLifecycleStateRequest
from sailpoint.v3.rest import ApiException
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.v3.SetLifecycleStateRequest() # SetLifecycleStateRequest |
try:
# Set Lifecycle State
Result = set_lifecycle_state_request.from_json(set_lifecycle_state_request)
api_response = api_instance.set_lifecycle_state(identity_id, Result)
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)
# Below is a request that includes all optional parameters
# api_response = api_instance.set_lifecycle_state(identity_id, Result)
# results = LifecycleStatesApi(api_client).set_lifecycle_state(identity_id, new_set_lifecycle_state_request)
print("The response of LifecycleStatesApi->set_lifecycle_state:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling LifecycleStatesApi->set_lifecycle_state: %s\n" % e)
```
@@ -421,11 +438,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.lifecycle_states_api import LifecycleStatesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
from sailpoint.v3.models.lifecycle_state import LifecycleState
from sailpoint.v3.rest import ApiException
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
@@ -438,14 +459,14 @@ from pprint import pprint
try:
# Update Lifecycle State
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.update_lifecycle_states(identity_profile_id, lifecycle_state_id, Result)
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)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_lifecycle_states(identity_profile_id, lifecycle_state_id, Result)
# 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(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling LifecycleStatesApi->update_lifecycle_states: %s\n" % e)
```

129
docs/tools/sdk/python/Reference/V3/Methods/MFAConfigurationApi.md
View File

@@ -58,22 +58,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.mfa_configuration_api import MFAConfigurationApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.mfa_okta_config import MfaOktaConfig
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'.
try:
# Delete MFA method configuration
api_response = api_instance.delete_mfa_config(method)
results =MFAConfigurationApi(api_client).delete_mfa_config(method)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_mfa_config(method)
# results = MFAConfigurationApi(api_client).delete_mfa_config(method)
print("The response of MFAConfigurationApi->delete_mfa_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling MFAConfigurationApi->delete_mfa_config: %s\n" % e)
```
@@ -111,21 +114,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.mfa_configuration_api import MFAConfigurationApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.mfa_duo_config import MfaDuoConfig
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Configuration of Duo MFA method
api_response = api_instance.get_mfa_duo_config()
results =MFAConfigurationApi(api_client).get_mfa_duo_config()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_mfa_duo_config()
# results = MFAConfigurationApi(api_client).get_mfa_duo_config()
print("The response of MFAConfigurationApi->get_mfa_duo_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling MFAConfigurationApi->get_mfa_duo_config: %s\n" % e)
```
@@ -166,22 +172,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.mfa_configuration_api import MFAConfigurationApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.kba_question import KbaQuestion
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
all_languages = allLanguages=true # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional) # bool | Indicator whether the question text should be returned in all configured languages * If true, the question text is returned in all languages that it is configured in. * If false, the question text is returned in the user locale if available, else for the default locale. * If not passed, it behaves the same way as passing this parameter as false (optional)
try:
# Configuration of KBA MFA method
api_response = api_instance.get_mfa_kba_config()
results =MFAConfigurationApi(api_client).get_mfa_kba_config()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_mfa_kba_config(all_languages)
# results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages)
print("The response of MFAConfigurationApi->get_mfa_kba_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling MFAConfigurationApi->get_mfa_kba_config: %s\n" % e)
```
@@ -219,21 +228,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.mfa_configuration_api import MFAConfigurationApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.mfa_okta_config import MfaOktaConfig
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Configuration of Okta MFA method
api_response = api_instance.get_mfa_okta_config()
results =MFAConfigurationApi(api_client).get_mfa_okta_config()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_mfa_okta_config()
# results = MFAConfigurationApi(api_client).get_mfa_okta_config()
print("The response of MFAConfigurationApi->get_mfa_okta_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling MFAConfigurationApi->get_mfa_okta_config: %s\n" % e)
```
@@ -274,10 +286,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.mfa_configuration_api import MFAConfigurationApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.mfa_duo_config import MfaDuoConfig
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
mfa_duo_config = {
"accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y",
"host" : "example.com",
@@ -292,14 +308,14 @@ from pprint import pprint
try:
# Set Duo MFA configuration
Result = mfa_duo_config.from_json(mfa_duo_config)
api_response = api_instance.set_mfa_duo_config(Result)
new_mfa_duo_config = MfaDuoConfig()
new_mfa_duo_config.from_json(mfa_duo_config)
results =MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config)
# Below is a request that includes all optional parameters
# api_response = api_instance.set_mfa_duo_config(Result)
# results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config)
print("The response of MFAConfigurationApi->set_mfa_duo_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling MFAConfigurationApi->set_mfa_duo_config: %s\n" % e)
```
@@ -340,10 +356,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.mfa_configuration_api import MFAConfigurationApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.mfa_okta_config import MfaOktaConfig
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
mfa_okta_config = {
"accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y",
"host" : "example.com",
@@ -354,14 +374,14 @@ from pprint import pprint
try:
# Set Okta MFA configuration
Result = mfa_okta_config.from_json(mfa_okta_config)
api_response = api_instance.set_mfa_okta_config(Result)
new_mfa_okta_config = MfaOktaConfig()
new_mfa_okta_config.from_json(mfa_okta_config)
results =MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config)
# Below is a request that includes all optional parameters
# api_response = api_instance.set_mfa_okta_config(Result)
# results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config)
print("The response of MFAConfigurationApi->set_mfa_okta_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling MFAConfigurationApi->set_mfa_okta_config: %s\n" % e)
```
@@ -402,11 +422,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.mfa_configuration_api import MFAConfigurationApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.kba_answer_request_item import KbaAnswerRequestItem
from sailpoint.v3.models.kba_answer_response_item import KbaAnswerResponseItem
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] |
kba_answer_request_item = {
"answer" : "Your answer",
@@ -416,14 +440,14 @@ from pprint import pprint
try:
# Set MFA KBA configuration
Result = kba_answer_request_item.from_json(kba_answer_request_item)
api_response = api_instance.set_mfakba_config(Result)
new_kba_answer_request_item = KbaAnswerRequestItem()
new_kba_answer_request_item.from_json(kba_answer_request_item)
results =MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item)
# Below is a request that includes all optional parameters
# api_response = api_instance.set_mfakba_config(Result)
# results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item)
print("The response of MFAConfigurationApi->set_mfakba_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling MFAConfigurationApi->set_mfakba_config: %s\n" % e)
```
@@ -464,22 +488,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.mfa_configuration_api import MFAConfigurationApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.mfa_config_test_response import MfaConfigTestResponse
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'. # str | The name of the MFA method. The currently supported method names are 'okta-verify' and 'duo-web'.
try:
# MFA method's test configuration
api_response = api_instance.test_mfa_config(method)
results =MFAConfigurationApi(api_client).test_mfa_config(method)
# Below is a request that includes all optional parameters
# api_response = api_instance.test_mfa_config(method)
# results = MFAConfigurationApi(api_client).test_mfa_config(method)
print("The response of MFAConfigurationApi->test_mfa_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling MFAConfigurationApi->test_mfa_config: %s\n" % e)
```

108
docs/tools/sdk/python/Reference/V3/Methods/MFAControllerApi.md
View File

@@ -56,11 +56,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.mfa_controller_api import MFAControllerApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.send_token_request import SendTokenRequest
from sailpoint.v3.models.send_token_response import SendTokenResponse
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
send_token_request = {
"userAlias" : "will.albin",
"deliveryType" : "EMAIL_WORK"
@@ -68,14 +72,14 @@ from pprint import pprint
try:
# Create and send user token
Result = send_token_request.from_json(send_token_request)
api_response = api_instance.create_send_token(Result)
new_send_token_request = SendTokenRequest()
new_send_token_request.from_json(send_token_request)
results =MFAControllerApi(api_client).create_send_token(new_send_token_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_send_token(Result)
# results = MFAControllerApi(api_client).create_send_token(new_send_token_request)
print("The response of MFAControllerApi->create_send_token:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling MFAControllerApi->create_send_token: %s\n" % e)
```
@@ -117,11 +121,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.mfa_controller_api import MFAControllerApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.verification_poll_request import VerificationPollRequest
from sailpoint.v3.models.verification_response import VerificationResponse
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
method = 'okta-verify' # str | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa' # str | The name of the MFA method. The currently supported method names are 'okta-verify', 'duo-web', 'kba','token', 'rsa'
verification_poll_request = {
"requestId" : "089899f13a8f4da7824996191587bab9"
@@ -129,14 +137,14 @@ from pprint import pprint
try:
# Polling MFA method by VerificationPollRequest
Result = verification_poll_request.from_json(verification_poll_request)
api_response = api_instance.ping_verification_status(method, Result)
new_verification_poll_request = VerificationPollRequest()
new_verification_poll_request.from_json(verification_poll_request)
results =MFAControllerApi(api_client).ping_verification_status(method, new_verification_poll_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.ping_verification_status(method, Result)
# results = MFAControllerApi(api_client).ping_verification_status(method, new_verification_poll_request)
print("The response of MFAControllerApi->ping_verification_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling MFAControllerApi->ping_verification_status: %s\n" % e)
```
@@ -177,11 +185,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.mfa_controller_api import MFAControllerApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.duo_verification_request import DuoVerificationRequest
from sailpoint.v3.models.verification_response import VerificationResponse
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
duo_verification_request = {
"signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2",
"userId" : "2c9180947f0ef465017f215cbcfd004b"
@@ -189,14 +201,14 @@ from pprint import pprint
try:
# Verifying authentication via Duo method
Result = duo_verification_request.from_json(duo_verification_request)
api_response = api_instance.send_duo_verify_request(Result)
new_duo_verification_request = DuoVerificationRequest()
new_duo_verification_request.from_json(duo_verification_request)
results =MFAControllerApi(api_client).send_duo_verify_request(new_duo_verification_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.send_duo_verify_request(Result)
# results = MFAControllerApi(api_client).send_duo_verify_request(new_duo_verification_request)
print("The response of MFAControllerApi->send_duo_verify_request:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling MFAControllerApi->send_duo_verify_request: %s\n" % e)
```
@@ -237,11 +249,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.mfa_controller_api import MFAControllerApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.kba_answer_request_item import KbaAnswerRequestItem
from sailpoint.v3.models.kba_auth_response import KbaAuthResponse
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}] # List[KbaAnswerRequestItem] |
kba_answer_request_item = {
"answer" : "Your answer",
@@ -251,14 +267,14 @@ from pprint import pprint
try:
# Authenticate KBA provided MFA method
Result = kba_answer_request_item.from_json(kba_answer_request_item)
api_response = api_instance.send_kba_answers(Result)
new_kba_answer_request_item = KbaAnswerRequestItem()
new_kba_answer_request_item.from_json(kba_answer_request_item)
results =MFAControllerApi(api_client).send_kba_answers(new_kba_answer_request_item)
# Below is a request that includes all optional parameters
# api_response = api_instance.send_kba_answers(Result)
# results = MFAControllerApi(api_client).send_kba_answers(new_kba_answer_request_item)
print("The response of MFAControllerApi->send_kba_answers:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling MFAControllerApi->send_kba_answers: %s\n" % e)
```
@@ -299,25 +315,29 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.mfa_controller_api import MFAControllerApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.okta_verification_request import OktaVerificationRequest
from sailpoint.v3.models.verification_response import VerificationResponse
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
okta_verification_request = {
"userId" : "example@mail.com"
} # OktaVerificationRequest |
try:
# Verifying authentication via Okta method
Result = okta_verification_request.from_json(okta_verification_request)
api_response = api_instance.send_okta_verify_request(Result)
new_okta_verification_request = OktaVerificationRequest()
new_okta_verification_request.from_json(okta_verification_request)
results =MFAControllerApi(api_client).send_okta_verify_request(new_okta_verification_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.send_okta_verify_request(Result)
# results = MFAControllerApi(api_client).send_okta_verify_request(new_okta_verification_request)
print("The response of MFAControllerApi->send_okta_verify_request:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling MFAControllerApi->send_okta_verify_request: %s\n" % e)
```
@@ -358,11 +378,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.mfa_controller_api import MFAControllerApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.token_auth_request import TokenAuthRequest
from sailpoint.v3.models.token_auth_response import TokenAuthResponse
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
token_auth_request = {
"userAlias" : "will.albin",
"deliveryType" : "EMAIL_WORK",
@@ -371,14 +395,14 @@ from pprint import pprint
try:
# Authenticate Token provided MFA method
Result = token_auth_request.from_json(token_auth_request)
api_response = api_instance.send_token_auth_request(Result)
new_token_auth_request = TokenAuthRequest()
new_token_auth_request.from_json(token_auth_request)
results =MFAControllerApi(api_client).send_token_auth_request(new_token_auth_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.send_token_auth_request(Result)
# results = MFAControllerApi(api_client).send_token_auth_request(new_token_auth_request)
print("The response of MFAControllerApi->send_token_auth_request:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling MFAControllerApi->send_token_auth_request: %s\n" % e)
```

94
docs/tools/sdk/python/Reference/V3/Methods/ManagedClientsApi.md
View File

@@ -59,11 +59,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.managed_clients_api import ManagedClientsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.managed_client import ManagedClient
from sailpoint.v3.models.managed_client_request import ManagedClientRequest
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
managed_client_request = {
"name" : "aName",
"description" : "A short description of the ManagedClient",
@@ -73,14 +77,14 @@ from pprint import pprint
try:
# Create Managed Client
Result = managed_client_request.from_json(managed_client_request)
api_response = api_instance.create_managed_client(Result)
new_managed_client_request = ManagedClientRequest()
new_managed_client_request.from_json(managed_client_request)
results =ManagedClientsApi(api_client).create_managed_client(new_managed_client_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_managed_client(Result)
# results = ManagedClientsApi(api_client).create_managed_client(new_managed_client_request)
print("The response of ManagedClientsApi->create_managed_client:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ManagedClientsApi->create_managed_client: %s\n" % e)
```
@@ -121,19 +125,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.managed_clients_api import ManagedClientsApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID.
try:
# Delete Managed Client
api_instance.delete_managed_client(id)
ManagedClientsApi(api_client).delete_managed_client(id)
# Below is a request that includes all optional parameters
# api_instance.delete_managed_client(id)
except Exception as e:
# ManagedClientsApi(api_client).delete_managed_client(id)
except Exception as e:
print("Exception when calling ManagedClientsApi->delete_managed_client: %s\n" % e)
```
@@ -175,22 +182,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.managed_clients_api import ManagedClientsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.managed_client import ManagedClient
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID.
try:
# Get Managed Client
api_response = api_instance.get_managed_client(id)
results =ManagedClientsApi(api_client).get_managed_client(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_managed_client(id)
# results = ManagedClientsApi(api_client).get_managed_client(id)
print("The response of ManagedClientsApi->get_managed_client:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ManagedClientsApi->get_managed_client: %s\n" % e)
```
@@ -233,24 +243,27 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.managed_clients_api import ManagedClientsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.managed_client_status import ManagedClientStatus
from sailpoint.v3.models.managed_client_type import ManagedClientType
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'aClientId' # str | Managed client ID to get status for. # str | Managed client ID to get status for.
type = sailpoint.v3.ManagedClientType() # ManagedClientType | Managed client type to get status for. # ManagedClientType | Managed client type to get status for.
try:
# Get Managed Client Status
api_response = api_instance.get_managed_client_status(id, type)
results =ManagedClientsApi(api_client).get_managed_client_status(id, type)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_managed_client_status(id, type)
# results = ManagedClientsApi(api_client).get_managed_client_status(id, type)
print("The response of ManagedClientsApi->get_managed_client_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ManagedClientsApi->get_managed_client_status: %s\n" % e)
```
@@ -294,10 +307,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.managed_clients_api import ManagedClientsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.managed_client import ManagedClient
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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)
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)
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)
@@ -306,13 +323,12 @@ from pprint import pprint
try:
# Get Managed Clients
api_response = api_instance.get_managed_clients()
results =ManagedClientsApi(api_client).get_managed_clients()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_managed_clients(offset, limit, count, filters)
# results = ManagedClientsApi(api_client).get_managed_clients(offset, limit, count, filters)
print("The response of ManagedClientsApi->get_managed_clients:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ManagedClientsApi->get_managed_clients: %s\n" % e)
```
@@ -355,11 +371,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.managed_clients_api import ManagedClientsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
from sailpoint.v3.models.managed_client import ManagedClient
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '4440278c-0ce2-41ee-a0a9-f5cfd5e8d3b7' # str | Managed client ID. # str | Managed client ID.
[sailpoint.v3.JsonPatchOperation()] # List[JsonPatchOperation] | JSONPatch payload used to update the object.
json_patch_operation = {
@@ -371,14 +391,14 @@ from pprint import pprint
try:
# Update Managed Client
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.update_managed_client(id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =ManagedClientsApi(api_client).update_managed_client(id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_managed_client(id, Result)
# results = ManagedClientsApi(api_client).update_managed_client(id, new_json_patch_operation)
print("The response of ManagedClientsApi->update_managed_client:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ManagedClientsApi->update_managed_client: %s\n" % e)
```

112
docs/tools/sdk/python/Reference/V3/Methods/ManagedClustersApi.md
View File

@@ -60,11 +60,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.managed_cluster import ManagedCluster
from sailpoint.v3.models.managed_cluster_request import ManagedClusterRequest
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
managed_cluster_request = {
"configuration" : {
"clusterExternalId" : "externalId",
@@ -77,14 +81,14 @@ from pprint import pprint
try:
# Create Create Managed Cluster
Result = managed_cluster_request.from_json(managed_cluster_request)
api_response = api_instance.create_managed_cluster(Result)
new_managed_cluster_request = ManagedClusterRequest()
new_managed_cluster_request.from_json(managed_cluster_request)
results =ManagedClustersApi(api_client).create_managed_cluster(new_managed_cluster_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_managed_cluster(Result)
# results = ManagedClustersApi(api_client).create_managed_cluster(new_managed_cluster_request)
print("The response of ManagedClustersApi->create_managed_cluster:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ManagedClustersApi->create_managed_cluster: %s\n" % e)
```
@@ -126,20 +130,23 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID.
remove_clients = False # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False) # bool | Flag to determine the need to delete a cluster with clients. (optional) (default to False)
try:
# Delete Managed Cluster
api_instance.delete_managed_cluster(id, )
ManagedClustersApi(api_client).delete_managed_cluster(id, )
# Below is a request that includes all optional parameters
# api_instance.delete_managed_cluster(id, remove_clients)
except Exception as e:
# ManagedClustersApi(api_client).delete_managed_cluster(id, remove_clients)
except Exception as e:
print("Exception when calling ManagedClustersApi->delete_managed_cluster: %s\n" % e)
```
@@ -182,22 +189,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of managed cluster to get log configuration for. # str | ID of managed cluster to get log configuration for.
try:
# Get Managed Cluster Log Configuration
api_response = api_instance.get_client_log_configuration(id)
results =ManagedClustersApi(api_client).get_client_log_configuration(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_client_log_configuration(id)
# results = ManagedClustersApi(api_client).get_client_log_configuration(id)
print("The response of ManagedClustersApi->get_client_log_configuration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ManagedClustersApi->get_client_log_configuration: %s\n" % e)
```
@@ -239,22 +249,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.managed_cluster import ManagedCluster
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID.
try:
# Get Managed Cluster
api_response = api_instance.get_managed_cluster(id)
results =ManagedClustersApi(api_client).get_managed_cluster(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_managed_cluster(id)
# results = ManagedClustersApi(api_client).get_managed_cluster(id)
print("The response of ManagedClustersApi->get_managed_cluster:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ManagedClustersApi->get_managed_cluster: %s\n" % e)
```
@@ -298,10 +311,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.managed_cluster import ManagedCluster
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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)
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)
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)
@@ -310,13 +327,12 @@ from pprint import pprint
try:
# Get Managed Clusters
api_response = api_instance.get_managed_clusters()
results =ManagedClustersApi(api_client).get_managed_clusters()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_managed_clusters(offset, limit, count, filters)
# results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters)
print("The response of ManagedClustersApi->get_managed_clusters:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ManagedClustersApi->get_managed_clusters: %s\n" % e)
```
@@ -359,24 +375,28 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.client_log_configuration import ClientLogConfiguration
from sailpoint.v3.models.put_client_log_configuration_request import PutClientLogConfigurationRequest
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | ID of the managed cluster to update the log configuration for. # str | ID of the managed cluster to update the log configuration for.
put_client_log_configuration_request = sailpoint.v3.PutClientLogConfigurationRequest() # PutClientLogConfigurationRequest | Client log configuration for the given managed cluster.
try:
# Update Managed Cluster Log Configuration
Result = put_client_log_configuration_request.from_json(put_client_log_configuration_request)
api_response = api_instance.put_client_log_configuration(id, Result)
new_put_client_log_configuration_request = PutClientLogConfigurationRequest()
new_put_client_log_configuration_request.from_json(put_client_log_configuration_request)
results =ManagedClustersApi(api_client).put_client_log_configuration(id, new_put_client_log_configuration_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_client_log_configuration(id, Result)
# results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_put_client_log_configuration_request)
print("The response of ManagedClustersApi->put_client_log_configuration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ManagedClustersApi->put_client_log_configuration: %s\n" % e)
```
@@ -419,11 +439,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.managed_clusters_api import ManagedClustersApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
from sailpoint.v3.models.managed_cluster import ManagedCluster
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180897de347a2017de8859e8c5039' # str | Managed cluster ID. # str | Managed cluster ID.
[sailpoint.v3.JsonPatchOperation()] # List[JsonPatchOperation] | JSONPatch payload used to update the object.
json_patch_operation = {
@@ -435,14 +459,14 @@ from pprint import pprint
try:
# Update Managed Cluster
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.update_managed_cluster(id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =ManagedClustersApi(api_client).update_managed_cluster(id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_managed_cluster(id, Result)
# results = ManagedClustersApi(api_client).update_managed_cluster(id, new_json_patch_operation)
print("The response of ManagedClustersApi->update_managed_cluster:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ManagedClustersApi->update_managed_cluster: %s\n" % e)
```

497
docs/tools/sdk/python/Reference/V3/Methods/NonEmployeeLifecycleManagementApi.md
View File

File diff suppressed because it is too large Load Diff

79
docs/tools/sdk/python/Reference/V3/Methods/OAuthClientsApi.md
View File

@@ -58,11 +58,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.o_auth_clients_api import OAuthClientsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.create_o_auth_client_request import CreateOAuthClientRequest
from sailpoint.v3.models.create_o_auth_client_response import CreateOAuthClientResponse
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
create_o_auth_client_request = {
"internal" : false,
"businessName" : "Acme-Solar",
@@ -83,14 +87,14 @@ from pprint import pprint
try:
# Create OAuth Client
Result = create_o_auth_client_request.from_json(create_o_auth_client_request)
api_response = api_instance.create_oauth_client(Result)
new_create_o_auth_client_request = CreateOAuthClientRequest()
new_create_o_auth_client_request.from_json(create_o_auth_client_request)
results =OAuthClientsApi(api_client).create_oauth_client(new_create_o_auth_client_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_oauth_client(Result)
# results = OAuthClientsApi(api_client).create_oauth_client(new_create_o_auth_client_request)
print("The response of OAuthClientsApi->create_oauth_client:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling OAuthClientsApi->create_oauth_client: %s\n" % e)
```
@@ -132,19 +136,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.o_auth_clients_api import OAuthClientsApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id
try:
# Delete OAuth Client
api_instance.delete_oauth_client(id)
OAuthClientsApi(api_client).delete_oauth_client(id)
# Below is a request that includes all optional parameters
# api_instance.delete_oauth_client(id)
except Exception as e:
# OAuthClientsApi(api_client).delete_oauth_client(id)
except Exception as e:
print("Exception when calling OAuthClientsApi->delete_oauth_client: %s\n" % e)
```
@@ -186,22 +193,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.o_auth_clients_api import OAuthClientsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.get_o_auth_client_response import GetOAuthClientResponse
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id
try:
# Get OAuth Client
api_response = api_instance.get_oauth_client(id)
results =OAuthClientsApi(api_client).get_oauth_client(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_oauth_client(id)
# results = OAuthClientsApi(api_client).get_oauth_client(id)
print("The response of OAuthClientsApi->get_oauth_client:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling OAuthClientsApi->get_oauth_client: %s\n" % e)
```
@@ -242,22 +252,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.o_auth_clients_api import OAuthClientsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.get_o_auth_client_response import GetOAuthClientResponse
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # 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: **lastUsed**: *le, isnull* (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: **lastUsed**: *le, isnull* (optional)
try:
# List OAuth Clients
api_response = api_instance.list_oauth_clients()
results =OAuthClientsApi(api_client).list_oauth_clients()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_oauth_clients(filters)
# results = OAuthClientsApi(api_client).list_oauth_clients(filters)
print("The response of OAuthClientsApi->list_oauth_clients:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling OAuthClientsApi->list_oauth_clients: %s\n" % e)
```
@@ -300,11 +313,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.o_auth_clients_api import OAuthClientsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.get_o_auth_client_response import GetOAuthClientResponse
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id
[{op=replace, path=/strongAuthSupported, value=true}, {op=replace, path=/businessName, value=acme-solar}] # List[JsonPatchOperation] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * tenant * businessName * homepageUrl * name * description * accessTokenValiditySeconds * refreshTokenValiditySeconds * redirectUris * grantTypes * accessType * enabled * strongAuthSupported * claimsSupported
json_patch_operation = {
@@ -316,14 +333,14 @@ from pprint import pprint
try:
# Patch OAuth Client
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_oauth_client(id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =OAuthClientsApi(api_client).patch_oauth_client(id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_oauth_client(id, Result)
# results = OAuthClientsApi(api_client).patch_oauth_client(id, new_json_patch_operation)
print("The response of OAuthClientsApi->patch_oauth_client:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling OAuthClientsApi->patch_oauth_client: %s\n" % e)
```

51
docs/tools/sdk/python/Reference/V3/Methods/PasswordConfigurationApi.md
View File

@@ -61,10 +61,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.password_configuration_api import PasswordConfigurationApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.password_org_config import PasswordOrgConfig
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
password_org_config = {
"digitTokenLength" : 9,
"digitTokenEnabled" : true,
@@ -74,14 +78,14 @@ from pprint import pprint
try:
# Create Password Org Config
Result = password_org_config.from_json(password_org_config)
api_response = api_instance.create_password_org_config(Result)
new_password_org_config = PasswordOrgConfig()
new_password_org_config.from_json(password_org_config)
results =PasswordConfigurationApi(api_client).create_password_org_config(new_password_org_config)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_password_org_config(Result)
# results = PasswordConfigurationApi(api_client).create_password_org_config(new_password_org_config)
print("The response of PasswordConfigurationApi->create_password_org_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordConfigurationApi->create_password_org_config: %s\n" % e)
```
@@ -119,21 +123,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.password_configuration_api import PasswordConfigurationApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.password_org_config import PasswordOrgConfig
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Password Org Config
api_response = api_instance.get_password_org_config()
results =PasswordConfigurationApi(api_client).get_password_org_config()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_password_org_config()
# results = PasswordConfigurationApi(api_client).get_password_org_config()
print("The response of PasswordConfigurationApi->get_password_org_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordConfigurationApi->get_password_org_config: %s\n" % e)
```
@@ -176,10 +183,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.password_configuration_api import PasswordConfigurationApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.password_org_config import PasswordOrgConfig
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
password_org_config = {
"digitTokenLength" : 9,
"digitTokenEnabled" : true,
@@ -189,14 +200,14 @@ from pprint import pprint
try:
# Update Password Org Config
Result = password_org_config.from_json(password_org_config)
api_response = api_instance.put_password_org_config(Result)
new_password_org_config = PasswordOrgConfig()
new_password_org_config.from_json(password_org_config)
results =PasswordConfigurationApi(api_client).put_password_org_config(new_password_org_config)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_password_org_config(Result)
# results = PasswordConfigurationApi(api_client).put_password_org_config(new_password_org_config)
print("The response of PasswordConfigurationApi->put_password_org_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordConfigurationApi->put_password_org_config: %s\n" % e)
```

28
docs/tools/sdk/python/Reference/V3/Methods/PasswordDictionaryApi.md
View File

@@ -125,20 +125,23 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.password_dictionary_api import PasswordDictionaryApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Password Dictionary
api_response = api_instance.get_password_dictionary()
results =PasswordDictionaryApi(api_client).get_password_dictionary()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_password_dictionary()
# results = PasswordDictionaryApi(api_client).get_password_dictionary()
print("The response of PasswordDictionaryApi->get_password_dictionary:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordDictionaryApi->get_password_dictionary: %s\n" % e)
```
@@ -209,19 +212,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.password_dictionary_api import PasswordDictionaryApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
file = None # bytearray | (optional) # bytearray | (optional)
try:
# Update Password Dictionary
api_instance.put_password_dictionary()
PasswordDictionaryApi(api_client).put_password_dictionary()
# Below is a request that includes all optional parameters
# api_instance.put_password_dictionary(file)
except Exception as e:
# PasswordDictionaryApi(api_client).put_password_dictionary(file)
except Exception as e:
print("Exception when calling PasswordDictionaryApi->put_password_dictionary: %s\n" % e)
```

51
docs/tools/sdk/python/Reference/V3/Methods/PasswordManagementApi.md
View File

@@ -78,22 +78,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.password_management_api import PasswordManagementApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.password_status import PasswordStatus
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '089899f13a8f4da7824996191587bab9' # str | Password change request ID # str | Password change request ID
try:
# Get Password Change Request Status
api_response = api_instance.get_password_change_status(id)
results =PasswordManagementApi(api_client).get_password_change_status(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_password_change_status(id)
# results = PasswordManagementApi(api_client).get_password_change_status(id)
print("The response of PasswordManagementApi->get_password_change_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordManagementApi->get_password_change_status: %s\n" % e)
```
@@ -135,11 +138,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.password_management_api import PasswordManagementApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.password_info import PasswordInfo
from sailpoint.v3.models.password_info_query_dto import PasswordInfoQueryDTO
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
password_info_query_dto = {
"sourceName" : "My-AD",
"userName" : "Abby.Smith"
@@ -147,14 +154,14 @@ from pprint import pprint
try:
# Query Password Info
Result = password_info_query_dto.from_json(password_info_query_dto)
api_response = api_instance.query_password_info(Result)
new_password_info_query_dto = PasswordInfoQueryDto()
new_password_info_query_dto.from_json(password_info_query_dto)
results =PasswordManagementApi(api_client).query_password_info(new_password_info_query_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.query_password_info(Result)
# results = PasswordManagementApi(api_client).query_password_info(new_password_info_query_dto)
print("The response of PasswordManagementApi->query_password_info:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordManagementApi->query_password_info: %s\n" % e)
```
@@ -214,11 +221,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.password_management_api import PasswordManagementApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.password_change_request import PasswordChangeRequest
from sailpoint.v3.models.password_change_response import PasswordChangeResponse
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
password_change_request = {
"sourceId" : "8a807d4c73c545510173c545d4b60246",
"accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com",
@@ -229,14 +240,14 @@ from pprint import pprint
try:
# Set Identity's Password
Result = password_change_request.from_json(password_change_request)
api_response = api_instance.set_password(Result)
new_password_change_request = PasswordChangeRequest()
new_password_change_request.from_json(password_change_request)
results =PasswordManagementApi(api_client).set_password(new_password_change_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.set_password(Result)
# results = PasswordManagementApi(api_client).set_password(new_password_change_request)
print("The response of PasswordManagementApi->set_password:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordManagementApi->set_password: %s\n" % e)
```

79
docs/tools/sdk/python/Reference/V3/Methods/PasswordPoliciesApi.md
View File

@@ -64,10 +64,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.password_policies_api import PasswordPoliciesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.password_policy_v3_dto import PasswordPolicyV3Dto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
password_policy_v3_dto = {
"validateAgainstAccountName" : true,
"minLength" : 8,
@@ -104,14 +108,14 @@ from pprint import pprint
try:
# Create Password Policy
Result = password_policy_v3_dto.from_json(password_policy_v3_dto)
api_response = api_instance.create_password_policy(Result)
new_password_policy_v3_dto = PasswordPolicyV3Dto()
new_password_policy_v3_dto.from_json(password_policy_v3_dto)
results =PasswordPoliciesApi(api_client).create_password_policy(new_password_policy_v3_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_password_policy(Result)
# results = PasswordPoliciesApi(api_client).create_password_policy(new_password_policy_v3_dto)
print("The response of PasswordPoliciesApi->create_password_policy:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordPoliciesApi->create_password_policy: %s\n" % e)
```
@@ -153,19 +157,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.password_policies_api import PasswordPoliciesApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ff808081838d9e9d01838da6a03e0002' # str | The ID of password policy to delete. # str | The ID of password policy to delete.
try:
# Delete Password Policy by ID
api_instance.delete_password_policy(id)
PasswordPoliciesApi(api_client).delete_password_policy(id)
# Below is a request that includes all optional parameters
# api_instance.delete_password_policy(id)
except Exception as e:
# PasswordPoliciesApi(api_client).delete_password_policy(id)
except Exception as e:
print("Exception when calling PasswordPoliciesApi->delete_password_policy: %s\n" % e)
```
@@ -207,22 +214,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.password_policies_api import PasswordPoliciesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.password_policy_v3_dto import PasswordPolicyV3Dto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ff808081838d9e9d01838da6a03e0005' # str | The ID of password policy to retrieve. # str | The ID of password policy to retrieve.
try:
# Get Password Policy by ID
api_response = api_instance.get_password_policy_by_id(id)
results =PasswordPoliciesApi(api_client).get_password_policy_by_id(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_password_policy_by_id(id)
# results = PasswordPoliciesApi(api_client).get_password_policy_by_id(id)
print("The response of PasswordPoliciesApi->get_password_policy_by_id:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordPoliciesApi->get_password_policy_by_id: %s\n" % e)
```
@@ -266,10 +276,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.password_policies_api import PasswordPoliciesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.password_policy_v3_dto import PasswordPolicyV3Dto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
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)
@@ -277,13 +291,12 @@ from pprint import pprint
try:
# List Password Policies
api_response = api_instance.list_password_policies()
results =PasswordPoliciesApi(api_client).list_password_policies()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_password_policies(limit, offset, count)
# results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count)
print("The response of PasswordPoliciesApi->list_password_policies:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordPoliciesApi->list_password_policies: %s\n" % e)
```
@@ -326,10 +339,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.password_policies_api import PasswordPoliciesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.password_policy_v3_dto import PasswordPolicyV3Dto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ff808081838d9e9d01838da6a03e0007' # str | The ID of password policy to update. # str | The ID of password policy to update.
password_policy_v3_dto = {
"validateAgainstAccountName" : true,
@@ -367,14 +384,14 @@ from pprint import pprint
try:
# Update Password Policy by ID
Result = password_policy_v3_dto.from_json(password_policy_v3_dto)
api_response = api_instance.set_password_policy(id, Result)
new_password_policy_v3_dto = PasswordPolicyV3Dto()
new_password_policy_v3_dto.from_json(password_policy_v3_dto)
results =PasswordPoliciesApi(api_client).set_password_policy(id, new_password_policy_v3_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.set_password_policy(id, Result)
# results = PasswordPoliciesApi(api_client).set_password_policy(id, new_password_policy_v3_dto)
print("The response of PasswordPoliciesApi->set_password_policy:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordPoliciesApi->set_password_policy: %s\n" % e)
```

79
docs/tools/sdk/python/Reference/V3/Methods/PasswordSyncGroupsApi.md
View File

@@ -87,10 +87,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.password_sync_groups_api import PasswordSyncGroupsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.password_sync_group import PasswordSyncGroup
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
password_sync_group = {
"created" : "2023-03-16T04:00:00Z",
"name" : "Password Sync Group 1",
@@ -102,14 +106,14 @@ from pprint import pprint
try:
# Create Password Sync Group
Result = password_sync_group.from_json(password_sync_group)
api_response = api_instance.create_password_sync_group(Result)
new_password_sync_group = PasswordSyncGroup()
new_password_sync_group.from_json(password_sync_group)
results =PasswordSyncGroupsApi(api_client).create_password_sync_group(new_password_sync_group)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_password_sync_group(Result)
# results = PasswordSyncGroupsApi(api_client).create_password_sync_group(new_password_sync_group)
print("The response of PasswordSyncGroupsApi->create_password_sync_group:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordSyncGroupsApi->create_password_sync_group: %s\n" % e)
```
@@ -150,19 +154,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.password_sync_groups_api import PasswordSyncGroupsApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '6881f631-3bd5-4213-9c75-8e05cc3e35dd' # str | The ID of password sync group to delete. # str | The ID of password sync group to delete.
try:
# Delete Password Sync Group by ID
api_instance.delete_password_sync_group(id)
PasswordSyncGroupsApi(api_client).delete_password_sync_group(id)
# Below is a request that includes all optional parameters
# api_instance.delete_password_sync_group(id)
except Exception as e:
# PasswordSyncGroupsApi(api_client).delete_password_sync_group(id)
except Exception as e:
print("Exception when calling PasswordSyncGroupsApi->delete_password_sync_group: %s\n" % e)
```
@@ -204,22 +211,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.password_sync_groups_api import PasswordSyncGroupsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.password_sync_group import PasswordSyncGroup
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '6881f631-3bd5-4213-9c75-8e05cc3e35dd' # str | The ID of password sync group to retrieve. # str | The ID of password sync group to retrieve.
try:
# Get Password Sync Group by ID
api_response = api_instance.get_password_sync_group(id)
results =PasswordSyncGroupsApi(api_client).get_password_sync_group(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_password_sync_group(id)
# results = PasswordSyncGroupsApi(api_client).get_password_sync_group(id)
print("The response of PasswordSyncGroupsApi->get_password_sync_group:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordSyncGroupsApi->get_password_sync_group: %s\n" % e)
```
@@ -262,10 +272,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.password_sync_groups_api import PasswordSyncGroupsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.password_sync_group import PasswordSyncGroup
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
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)
@@ -273,13 +287,12 @@ from pprint import pprint
try:
# Get Password Sync Group List
api_response = api_instance.get_password_sync_groups()
results =PasswordSyncGroupsApi(api_client).get_password_sync_groups()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_password_sync_groups(limit, offset, count)
# results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count)
print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordSyncGroupsApi->get_password_sync_groups: %s\n" % e)
```
@@ -322,10 +335,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.password_sync_groups_api import PasswordSyncGroupsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.password_sync_group import PasswordSyncGroup
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '6881f631-3bd5-4213-9c75-8e05cc3e35dd' # str | The ID of password sync group to update. # str | The ID of password sync group to update.
password_sync_group = {
"created" : "2023-03-16T04:00:00Z",
@@ -338,14 +355,14 @@ from pprint import pprint
try:
# Update Password Sync Group by ID
Result = password_sync_group.from_json(password_sync_group)
api_response = api_instance.update_password_sync_group(id, Result)
new_password_sync_group = PasswordSyncGroup()
new_password_sync_group.from_json(password_sync_group)
results =PasswordSyncGroupsApi(api_client).update_password_sync_group(id, new_password_sync_group)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_password_sync_group(id, Result)
# results = PasswordSyncGroupsApi(api_client).update_password_sync_group(id, new_password_sync_group)
print("The response of PasswordSyncGroupsApi->update_password_sync_group:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PasswordSyncGroupsApi->update_password_sync_group: %s\n" % e)
```

64
docs/tools/sdk/python/Reference/V3/Methods/PersonalAccessTokensApi.md
View File

@@ -65,11 +65,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.personal_access_tokens_api import PersonalAccessTokensApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.create_personal_access_token_request import CreatePersonalAccessTokenRequest
from sailpoint.v3.models.create_personal_access_token_response import CreatePersonalAccessTokenResponse
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
create_personal_access_token_request = {
"scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ],
"accessTokenValiditySeconds" : 36900,
@@ -78,14 +82,14 @@ from pprint import pprint
try:
# Create Personal Access Token
Result = create_personal_access_token_request.from_json(create_personal_access_token_request)
api_response = api_instance.create_personal_access_token(Result)
new_create_personal_access_token_request = CreatePersonalAccessTokenRequest()
new_create_personal_access_token_request.from_json(create_personal_access_token_request)
results =PersonalAccessTokensApi(api_client).create_personal_access_token(new_create_personal_access_token_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_personal_access_token(Result)
# results = PersonalAccessTokensApi(api_client).create_personal_access_token(new_create_personal_access_token_request)
print("The response of PersonalAccessTokensApi->create_personal_access_token:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PersonalAccessTokensApi->create_personal_access_token: %s\n" % e)
```
@@ -127,19 +131,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.personal_access_tokens_api import PersonalAccessTokensApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The personal access token id # str | The personal access token id
try:
# Delete Personal Access Token
api_instance.delete_personal_access_token(id)
PersonalAccessTokensApi(api_client).delete_personal_access_token(id)
# Below is a request that includes all optional parameters
# api_instance.delete_personal_access_token(id)
except Exception as e:
# PersonalAccessTokensApi(api_client).delete_personal_access_token(id)
except Exception as e:
print("Exception when calling PersonalAccessTokensApi->delete_personal_access_token: %s\n" % e)
```
@@ -181,23 +188,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.personal_access_tokens_api import PersonalAccessTokensApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.get_personal_access_token_response import GetPersonalAccessTokenResponse
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = '2c9180867b50d088017b554662fb281e' # str | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional) # str | The identity ID of the owner whose personal access tokens should be listed. If \"me\", the caller should have the following right: 'idn:my-personal-access-tokens:read' If an actual owner ID or if the `owner-id` parameter is omitted in the request, the caller should have the following right: 'idn:all-personal-access-tokens:read'. If the caller has the following right, then managed personal access tokens associated with `owner-id` will be retrieved: 'idn:managed-personal-access-tokens:read' (optional)
filters = 'lastUsed le 2023-02-05T10:59:27.214Z' # 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: **lastUsed**: *le, isnull* (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: **lastUsed**: *le, isnull* (optional)
try:
# List Personal Access Tokens
api_response = api_instance.list_personal_access_tokens()
results =PersonalAccessTokensApi(api_client).list_personal_access_tokens()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_personal_access_tokens(owner_id, filters)
# results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters)
print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PersonalAccessTokensApi->list_personal_access_tokens: %s\n" % e)
```
@@ -241,11 +251,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.personal_access_tokens_api import PersonalAccessTokensApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.get_personal_access_token_response import GetPersonalAccessTokenResponse
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Personal Access Token id # str | The Personal Access Token id
[{op=replace, path=/name, value=New name}, {op=replace, path=/scope, value=[sp:scopes:all]}] # List[JsonPatchOperation] | A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope
json_patch_operation = {
@@ -257,14 +271,14 @@ from pprint import pprint
try:
# Patch Personal Access Token
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_personal_access_token(id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =PersonalAccessTokensApi(api_client).patch_personal_access_token(id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_personal_access_token(id, Result)
# results = PersonalAccessTokensApi(api_client).patch_personal_access_token(id, new_json_patch_operation)
print("The response of PersonalAccessTokensApi->patch_personal_access_token:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PersonalAccessTokensApi->patch_personal_access_token: %s\n" % e)
```

15
docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesApi.md
View File

@@ -59,10 +59,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.public_identities_api import PublicIdentitiesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.public_identity import PublicIdentity
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
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)
@@ -73,13 +77,12 @@ from pprint import pprint
try:
# Get list of public identities
api_response = api_instance.get_public_identities()
results =PublicIdentitiesApi(api_client).get_public_identities()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_public_identities(limit, offset, count, filters, add_core_filters, sorters)
# results = PublicIdentitiesApi(api_client).get_public_identities(limit, offset, count, filters, add_core_filters, sorters)
print("The response of PublicIdentitiesApi->get_public_identities:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PublicIdentitiesApi->get_public_identities: %s\n" % e)
```

33
docs/tools/sdk/python/Reference/V3/Methods/PublicIdentitiesConfigApi.md
View File

@@ -59,21 +59,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.public_identities_config_api import PublicIdentitiesConfigApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.public_identity_config import PublicIdentityConfig
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get the Public Identities Configuration
api_response = api_instance.get_public_identity_config()
results =PublicIdentitiesConfigApi(api_client).get_public_identity_config()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_public_identity_config()
# results = PublicIdentitiesConfigApi(api_client).get_public_identity_config()
print("The response of PublicIdentitiesConfigApi->get_public_identity_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PublicIdentitiesConfigApi->get_public_identity_config: %s\n" % e)
```
@@ -114,10 +117,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.public_identities_config_api import PublicIdentitiesConfigApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.public_identity_config import PublicIdentityConfig
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
public_identity_config = {
"modified" : "2018-06-25T20:22:28.104Z",
"attributes" : [ {
@@ -136,14 +143,14 @@ from pprint import pprint
try:
# Update the Public Identities Configuration
Result = public_identity_config.from_json(public_identity_config)
api_response = api_instance.update_public_identity_config(Result)
new_public_identity_config = PublicIdentityConfig()
new_public_identity_config.from_json(public_identity_config)
results =PublicIdentitiesConfigApi(api_client).update_public_identity_config(new_public_identity_config)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_public_identity_config(Result)
# results = PublicIdentitiesConfigApi(api_client).update_public_identity_config(new_public_identity_config)
print("The response of PublicIdentitiesConfigApi->update_public_identity_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling PublicIdentitiesConfigApi->update_public_identity_config: %s\n" % e)
```

61
docs/tools/sdk/python/Reference/V3/Methods/ReportsDataExtractionApi.md
View File

@@ -57,19 +57,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.reports_data_extraction_api import ReportsDataExtractionApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'a1ed223247144cc29d23c632624b4767' # str | ID of the running Report to cancel # str | ID of the running Report to cancel
try:
# Cancel Report
api_instance.cancel_report(id)
ReportsDataExtractionApi(api_client).cancel_report(id)
# Below is a request that includes all optional parameters
# api_instance.cancel_report(id)
except Exception as e:
# ReportsDataExtractionApi(api_client).cancel_report(id)
except Exception as e:
print("Exception when calling ReportsDataExtractionApi->cancel_report: %s\n" % e)
```
@@ -114,9 +117,13 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.reports_data_extraction_api import ReportsDataExtractionApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
task_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Unique identifier of the task result which handled report # str | Unique identifier of the task result which handled report
file_format = 'csv' # str | Output format of the requested report file # str | Output format of the requested report file
name = 'Identities Details Report' # str | preferred Report file name, by default will be used report name from task result. (optional) # str | preferred Report file name, by default will be used report name from task result. (optional)
@@ -125,13 +132,12 @@ from pprint import pprint
try:
# Get Report File
api_response = api_instance.get_report(task_result_id, file_format, )
results =ReportsDataExtractionApi(api_client).get_report(task_result_id, file_format, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_report(task_result_id, file_format, name, auditable)
# results = ReportsDataExtractionApi(api_client).get_report(task_result_id, file_format, name, auditable)
print("The response of ReportsDataExtractionApi->get_report:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ReportsDataExtractionApi->get_report: %s\n" % e)
```
@@ -173,23 +179,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.reports_data_extraction_api import ReportsDataExtractionApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.report_results import ReportResults
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
task_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Unique identifier of the task result which handled report # str | Unique identifier of the task result which handled report
completed = False # bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to False) # bool | state of task result to apply ordering when results are fetching from the DB (optional) (default to False)
try:
# Get Report Result
api_response = api_instance.get_report_result(task_result_id, )
results =ReportsDataExtractionApi(api_client).get_report_result(task_result_id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_report_result(task_result_id, completed)
# results = ReportsDataExtractionApi(api_client).get_report_result(task_result_id, completed)
print("The response of ReportsDataExtractionApi->get_report_result:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ReportsDataExtractionApi->get_report_result: %s\n" % e)
```
@@ -230,11 +239,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.reports_data_extraction_api import ReportsDataExtractionApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.report_details import ReportDetails
from sailpoint.v3.models.task_result_details import TaskResultDetails
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
report_details = {
"reportType" : "ACCOUNTS",
"arguments" : {
@@ -245,14 +258,14 @@ from pprint import pprint
try:
# Run Report
Result = report_details.from_json(report_details)
api_response = api_instance.start_report(Result)
new_report_details = ReportDetails()
new_report_details.from_json(report_details)
results =ReportsDataExtractionApi(api_client).start_report(new_report_details)
# Below is a request that includes all optional parameters
# api_response = api_instance.start_report(Result)
# results = ReportsDataExtractionApi(api_client).start_report(new_report_details)
print("The response of ReportsDataExtractionApi->start_report:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ReportsDataExtractionApi->start_report: %s\n" % e)
```

15
docs/tools/sdk/python/Reference/V3/Methods/RequestableObjectsApi.md
View File

@@ -63,12 +63,16 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.requestable_objects_api import RequestableObjectsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.requestable_object import RequestableObject
from sailpoint.v3.models.requestable_object_request_status import RequestableObjectRequestStatus
from sailpoint.v3.models.requestable_object_type import RequestableObjectType
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = 'e7eab60924f64aa284175b9fa3309599' # str | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional) # str | If present, the value returns only requestable objects for the specified identity. * Admin users can call this with any identity ID value. * Non-admin users can only specify *me* or pass their own identity ID value. * If absent, returns a list of all requestable objects for the tenant. Only admin users can make such a call. In this case, the available, pending, assigned accesses will not be annotated in the result. (optional)
types = [sailpoint.v3.RequestableObjectType()] # List[RequestableObjectType] | Filters the results to the specified type/types, where each type is one of ROLE or ACCESS_PROFILE. If absent, all types are returned. Support for additional types may be added in the future without notice. (optional)
@@ -86,13 +90,12 @@ from pprint import pprint
try:
# Requestable Objects List
api_response = api_instance.list_requestable_objects()
results =RequestableObjectsApi(api_client).list_requestable_objects()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters)
# results = RequestableObjectsApi(api_client).list_requestable_objects(identity_id, types, term, statuses, limit, offset, count, filters, sorters)
print("The response of RequestableObjectsApi->list_requestable_objects:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RequestableObjectsApi->list_requestable_objects: %s\n" % e)
```

112
docs/tools/sdk/python/Reference/V3/Methods/RolesApi.md
View File

@@ -97,10 +97,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.roles_api import RolesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.role import Role
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role = {
"owner" : {
"name" : "support",
@@ -262,14 +266,14 @@ from pprint import pprint
try:
# Create a Role
Result = role.from_json(role)
api_response = api_instance.create_role(Result)
new_role = Role()
new_role.from_json(role)
results =RolesApi(api_client).create_role(new_role)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_role(Result)
# results = RolesApi(api_client).create_role(new_role)
print("The response of RolesApi->create_role:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RolesApi->create_role: %s\n" % e)
```
@@ -313,25 +317,29 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.roles_api import RolesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.role_bulk_delete_request import RoleBulkDeleteRequest
from sailpoint.v3.models.task_result_dto import TaskResultDto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role_bulk_delete_request = {
"roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ]
} # RoleBulkDeleteRequest |
try:
# Delete Role(s)
Result = role_bulk_delete_request.from_json(role_bulk_delete_request)
api_response = api_instance.delete_bulk_roles(Result)
new_role_bulk_delete_request = RoleBulkDeleteRequest()
new_role_bulk_delete_request.from_json(role_bulk_delete_request)
results =RolesApi(api_client).delete_bulk_roles(new_role_bulk_delete_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_bulk_roles(Result)
# results = RolesApi(api_client).delete_bulk_roles(new_role_bulk_delete_request)
print("The response of RolesApi->delete_bulk_roles:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RolesApi->delete_bulk_roles: %s\n" % e)
```
@@ -374,19 +382,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.roles_api import RolesApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role
try:
# Delete a Role
api_instance.delete_role(id)
RolesApi(api_client).delete_role(id)
# Below is a request that includes all optional parameters
# api_instance.delete_role(id)
except Exception as e:
# RolesApi(api_client).delete_role(id)
except Exception as e:
print("Exception when calling RolesApi->delete_role: %s\n" % e)
```
@@ -428,22 +439,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.roles_api import RolesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.role import Role
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role
try:
# Get a Role
api_response = api_instance.get_role(id)
results =RolesApi(api_client).get_role(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_role(id)
# results = RolesApi(api_client).get_role(id)
print("The response of RolesApi->get_role:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RolesApi->get_role: %s\n" % e)
```
@@ -489,10 +503,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.roles_api import RolesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.role_identity import RoleIdentity
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the Role for which the assigned Identities are to be listed # str | ID of the Role for which the assigned Identities are to be listed
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)
@@ -503,13 +521,12 @@ from pprint import pprint
try:
# List Identities assigned a Role
api_response = api_instance.get_role_assigned_identities(id, )
results =RolesApi(api_client).get_role_assigned_identities(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_role_assigned_identities(id, limit, offset, count, filters, sorters)
# results = RolesApi(api_client).get_role_assigned_identities(id, limit, offset, count, filters, sorters)
print("The response of RolesApi->get_role_assigned_identities:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RolesApi->get_role_assigned_identities: %s\n" % e)
```
@@ -557,10 +574,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.roles_api import RolesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.role import Role
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
for_subadmin = '5168015d32f890ca15812c9180835d2e' # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional) # str | If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN Identity. The value of the parameter is either an Identity ID, or the special value **me**, which is shorthand for the calling Identity's ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an Identity that is not a subadmin. (optional)
limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50)
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)
@@ -573,13 +594,12 @@ from pprint import pprint
try:
# List Roles
api_response = api_instance.list_roles()
results =RolesApi(api_client).list_roles()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented)
# results = RolesApi(api_client).list_roles(for_subadmin, limit, offset, count, filters, sorters, for_segment_ids, include_unsegmented)
print("The response of RolesApi->list_roles:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RolesApi->list_roles: %s\n" % e)
```
@@ -640,11 +660,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.roles_api import RolesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
from sailpoint.v3.models.role import Role
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the Role to patch # str | ID of the Role to patch
[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}] # List[JsonPatchOperation] |
json_patch_operation = {
@@ -656,14 +680,14 @@ from pprint import pprint
try:
# Patch a specified Role
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_role(id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =RolesApi(api_client).patch_role(id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_role(id, Result)
# results = RolesApi(api_client).patch_role(id, new_json_patch_operation)
print("The response of RolesApi->patch_role:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling RolesApi->patch_role: %s\n" % e)
```

263
docs/tools/sdk/python/Reference/V3/Methods/SODPoliciesApi.md
View File

@@ -94,10 +94,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sod_policies_api import SODPoliciesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.sod_policy import SodPolicy
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
sod_policy = {
"conflictingAccessCriteria" : {
"leftCriteria" : {
@@ -157,14 +161,14 @@ from pprint import pprint
try:
# Create SOD policy
Result = sod_policy.from_json(sod_policy)
api_response = api_instance.create_sod_policy(Result)
new_sod_policy = SodPolicy()
new_sod_policy.from_json(sod_policy)
results =SODPoliciesApi(api_client).create_sod_policy(new_sod_policy)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_sod_policy(Result)
# results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy)
print("The response of SODPoliciesApi->create_sod_policy:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->create_sod_policy: %s\n" % e)
```
@@ -208,20 +212,23 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.sod_policies_api import SODPoliciesApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to delete. # str | The ID of the SOD Policy to delete.
logical = True # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. Soft delete marks the policy as deleted and just save it with this status. It could be fully deleted or recovered further. Hard delete vise versa permanently delete SOD request during this call. (optional) (default to True)
try:
# Delete SOD policy by ID
api_instance.delete_sod_policy(id, )
SODPoliciesApi(api_client).delete_sod_policy(id, )
# Below is a request that includes all optional parameters
# api_instance.delete_sod_policy(id, logical)
except Exception as e:
# SODPoliciesApi(api_client).delete_sod_policy(id, logical)
except Exception as e:
print("Exception when calling SODPoliciesApi->delete_sod_policy: %s\n" % e)
```
@@ -263,19 +270,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.sod_policies_api import SODPoliciesApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy the schedule must be deleted for. # str | The ID of the SOD policy the schedule must be deleted for.
try:
# Delete SOD policy schedule
api_instance.delete_sod_policy_schedule(id)
SODPoliciesApi(api_client).delete_sod_policy_schedule(id)
# Below is a request that includes all optional parameters
# api_instance.delete_sod_policy_schedule(id)
except Exception as e:
# SODPoliciesApi(api_client).delete_sod_policy_schedule(id)
except Exception as e:
print("Exception when calling SODPoliciesApi->delete_sod_policy_schedule: %s\n" % e)
```
@@ -318,22 +328,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.sod_policies_api import SODPoliciesApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download.
file_name = 'custom-name' # str | Custom Name for the file. # str | Custom Name for the file.
try:
# Download custom violation report
api_response = api_instance.get_custom_violation_report(report_result_id, file_name)
results =SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_custom_violation_report(report_result_id, file_name)
# results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name)
print("The response of SODPoliciesApi->get_custom_violation_report:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->get_custom_violation_report: %s\n" % e)
```
@@ -375,21 +388,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.sod_policies_api import SODPoliciesApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
report_result_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the report reference to download. # str | The ID of the report reference to download.
try:
# Download violation report
api_response = api_instance.get_default_violation_report(report_result_id)
results =SODPoliciesApi(api_client).get_default_violation_report(report_result_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_default_violation_report(report_result_id)
# results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id)
print("The response of SODPoliciesApi->get_default_violation_report:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->get_default_violation_report: %s\n" % e)
```
@@ -427,21 +443,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sod_policies_api import SODPoliciesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.report_result_reference import ReportResultReference
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get multi-report run task status
api_response = api_instance.get_sod_all_report_run_status()
results =SODPoliciesApi(api_client).get_sod_all_report_run_status()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sod_all_report_run_status()
# results = SODPoliciesApi(api_client).get_sod_all_report_run_status()
print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->get_sod_all_report_run_status: %s\n" % e)
```
@@ -484,22 +503,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sod_policies_api import SODPoliciesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.sod_policy import SodPolicy
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD Policy to retrieve. # str | The ID of the SOD Policy to retrieve.
try:
# Get SOD policy by ID
api_response = api_instance.get_sod_policy(id)
results =SODPoliciesApi(api_client).get_sod_policy(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sod_policy(id)
# results = SODPoliciesApi(api_client).get_sod_policy(id)
print("The response of SODPoliciesApi->get_sod_policy:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->get_sod_policy: %s\n" % e)
```
@@ -540,22 +562,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sod_policies_api import SODPoliciesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy schedule to retrieve. # str | The ID of the SOD policy schedule to retrieve.
try:
# Get SOD policy schedule
api_response = api_instance.get_sod_policy_schedule(id)
results =SODPoliciesApi(api_client).get_sod_policy_schedule(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sod_policy_schedule(id)
# results = SODPoliciesApi(api_client).get_sod_policy_schedule(id)
print("The response of SODPoliciesApi->get_sod_policy_schedule:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->get_sod_policy_schedule: %s\n" % e)
```
@@ -597,22 +622,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sod_policies_api import SODPoliciesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.report_result_reference import ReportResultReference
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
report_result_id = '2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | The ID of the report reference to retrieve. # str | The ID of the report reference to retrieve.
try:
# Get violation report run status
api_response = api_instance.get_sod_violation_report_run_status(report_result_id)
results =SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sod_violation_report_run_status(report_result_id)
# results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id)
print("The response of SODPoliciesApi->get_sod_violation_report_run_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->get_sod_violation_report_run_status: %s\n" % e)
```
@@ -654,22 +682,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sod_policies_api import SODPoliciesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.report_result_reference import ReportResultReference
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the violation report to retrieve status for. # str | The ID of the violation report to retrieve status for.
try:
# Get SOD violation report status
api_response = api_instance.get_sod_violation_report_status(id)
results =SODPoliciesApi(api_client).get_sod_violation_report_status(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_sod_violation_report_status(id)
# results = SODPoliciesApi(api_client).get_sod_violation_report_status(id)
print("The response of SODPoliciesApi->get_sod_violation_report_status:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->get_sod_violation_report_status: %s\n" % e)
```
@@ -715,10 +746,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sod_policies_api import SODPoliciesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.sod_policy import SodPolicy
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
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)
@@ -728,13 +763,12 @@ from pprint import pprint
try:
# List SOD policies
api_response = api_instance.list_sod_policies()
results =SODPoliciesApi(api_client).list_sod_policies()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_sod_policies(limit, offset, count, filters, sorters)
# results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters)
print("The response of SODPoliciesApi->list_sod_policies:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->list_sod_policies: %s\n" % e)
```
@@ -779,11 +813,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sod_policies_api import SODPoliciesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
from sailpoint.v3.models.sod_policy import SodPolicy
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c918083-5d19-1a86-015d-28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified.
[{op=replace, path=/description, value=Modified description}, {op=replace, path=/conflictingAccessCriteria/leftCriteria/name, value=money-in-modified}, {op=replace, path=/conflictingAccessCriteria/rightCriteria, value={name=money-out-modified, criteriaList=[{type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2}]}}] # List[JsonPatchOperation] | A list of SOD Policy update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * ownerRef * externalPolicyReference * compensatingControls * correctionAdvice * state * tags * violationOwnerAssignmentConfig * scheduled * conflictingAccessCriteria
json_patch_operation = {
@@ -795,14 +833,14 @@ from pprint import pprint
try:
# Patch SOD policy by ID
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_sod_policy(id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_sod_policy(id, Result)
# results = SODPoliciesApi(api_client).patch_sod_policy(id, new_json_patch_operation)
print("The response of SODPoliciesApi->patch_sod_policy:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->patch_sod_policy: %s\n" % e)
```
@@ -844,10 +882,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sod_policies_api import SODPoliciesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.sod_policy_schedule import SodPolicySchedule
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update its schedule. # str | The ID of the SOD policy to update its schedule.
sod_policy_schedule = {
"schedule" : {
@@ -890,14 +932,14 @@ from pprint import pprint
try:
# Update SOD Policy schedule
Result = sod_policy_schedule.from_json(sod_policy_schedule)
api_response = api_instance.put_policy_schedule(id, Result)
new_sod_policy_schedule = SodPolicySchedule()
new_sod_policy_schedule.from_json(sod_policy_schedule)
results =SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_policy_schedule(id, Result)
# results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule)
print("The response of SODPoliciesApi->put_policy_schedule:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->put_policy_schedule: %s\n" % e)
```
@@ -941,10 +983,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sod_policies_api import SODPoliciesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.sod_policy import SodPolicy
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update.
sod_policy = {
"conflictingAccessCriteria" : {
@@ -1005,14 +1051,14 @@ from pprint import pprint
try:
# Update SOD policy by ID
Result = sod_policy.from_json(sod_policy)
api_response = api_instance.put_sod_policy(id, Result)
new_sod_policy = SodPolicy()
new_sod_policy.from_json(sod_policy)
results =SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_sod_policy(id, Result)
# results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy)
print("The response of SODPoliciesApi->put_sod_policy:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->put_sod_policy: %s\n" % e)
```
@@ -1053,22 +1099,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sod_policies_api import SODPoliciesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.report_result_reference import ReportResultReference
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run.
try:
# Evaluate one policy by ID
api_response = api_instance.start_evaluate_sod_policy(id)
results =SODPoliciesApi(api_client).start_evaluate_sod_policy(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.start_evaluate_sod_policy(id)
# results = SODPoliciesApi(api_client).start_evaluate_sod_policy(id)
print("The response of SODPoliciesApi->start_evaluate_sod_policy:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->start_evaluate_sod_policy: %s\n" % e)
```
@@ -1109,11 +1158,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sod_policies_api import SODPoliciesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.multi_policy_request import MultiPolicyRequest
from sailpoint.v3.models.report_result_reference import ReportResultReference
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
multi_policy_request = {
"filteredPolicyList" : [ "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]", "[b868cd40-ffa4-4337-9c07-1a51846cfa94, 63a07a7b-39a4-48aa-956d-50c827deba2a]" ]
} # MultiPolicyRequest | (optional)
@@ -1121,13 +1174,12 @@ from pprint import pprint
try:
# Runs all policies for org
api_response = api_instance.start_sod_all_policies_for_org()
results =SODPoliciesApi(api_client).start_sod_all_policies_for_org()
# Below is a request that includes all optional parameters
# api_response = api_instance.start_sod_all_policies_for_org(Result)
# results = SODPoliciesApi(api_client).start_sod_all_policies_for_org(new_multi_policy_request)
print("The response of SODPoliciesApi->start_sod_all_policies_for_org:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->start_sod_all_policies_for_org: %s\n" % e)
```
@@ -1169,22 +1221,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sod_policies_api import SODPoliciesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.report_result_reference import ReportResultReference
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f943-47e9-4562-b5bb-8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run.
try:
# Runs SOD policy violation report
api_response = api_instance.start_sod_policy(id)
results =SODPoliciesApi(api_client).start_sod_policy(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.start_sod_policy(id)
# results = SODPoliciesApi(api_client).start_sod_policy(id)
print("The response of SODPoliciesApi->start_sod_policy:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODPoliciesApi->start_sod_policy: %s\n" % e)
```

36
docs/tools/sdk/python/Reference/V3/Methods/SODViolationsApi.md
View File

@@ -71,11 +71,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sod_violations_api import SODViolationsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.identity_with_new_access import IdentityWithNewAccess
from sailpoint.v3.models.violation_prediction import ViolationPrediction
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_with_new_access = {
"identityId" : "2c91808568c529c60168cca6f90c1313",
"accessRefs" : [ {
@@ -91,14 +95,14 @@ from pprint import pprint
try:
# Predict SOD violations for identity.
Result = identity_with_new_access.from_json(identity_with_new_access)
api_response = api_instance.start_predict_sod_violations(Result)
new_identity_with_new_access = IdentityWithNewAccess()
new_identity_with_new_access.from_json(identity_with_new_access)
results =SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access)
# Below is a request that includes all optional parameters
# api_response = api_instance.start_predict_sod_violations(Result)
# results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access)
print("The response of SODViolationsApi->start_predict_sod_violations:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODViolationsApi->start_predict_sod_violations: %s\n" % e)
```
@@ -140,23 +144,27 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sod_violations_api import SODViolationsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.identity_with_new_access1 import IdentityWithNewAccess1
from sailpoint.v3.models.sod_violation_check import SodViolationCheck
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_with_new_access1 = {identityId=2c91808568c529c60168cca6f90c1313, accessRefs=[{type=ENTITLEMENT, id=2c918087682f9a86016839c050861ab1, name=CN=Information Access,OU=test,OU=test-service,DC=TestAD,DC=local}, {type=ENTITLEMENT, id=2c918087682f9a86016839c0509c1ab2, name=CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local}], clientMetadata={additionalProp1=string, additionalProp2=string, additionalProp3=string}} # IdentityWithNewAccess1 |
try:
# Check SOD violations
Result = identity_with_new_access1.from_json(identity_with_new_access1)
api_response = api_instance.start_violation_check(Result)
new_identity_with_new_access1 = IdentityWithNewAccess1()
new_identity_with_new_access1.from_json(identity_with_new_access1)
results =SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1)
# Below is a request that includes all optional parameters
# api_response = api_instance.start_violation_check(Result)
# results = SODViolationsApi(api_client).start_violation_check(new_identity_with_new_access1)
print("The response of SODViolationsApi->start_violation_check:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SODViolationsApi->start_violation_check: %s\n" % e)
```

95
docs/tools/sdk/python/Reference/V3/Methods/SavedSearchApi.md
View File

@@ -67,23 +67,27 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.saved_search_api import SavedSearchApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.create_saved_search_request import CreateSavedSearchRequest
from sailpoint.v3.models.saved_search import SavedSearch
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
create_saved_search_request = sailpoint.v3.CreateSavedSearchRequest() # CreateSavedSearchRequest | The saved search to persist.
try:
# Create a saved search
Result = create_saved_search_request.from_json(create_saved_search_request)
api_response = api_instance.create_saved_search(Result)
new_create_saved_search_request = CreateSavedSearchRequest()
new_create_saved_search_request.from_json(create_saved_search_request)
results =SavedSearchApi(api_client).create_saved_search(new_create_saved_search_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_saved_search(Result)
# results = SavedSearchApi(api_client).create_saved_search(new_create_saved_search_request)
print("The response of SavedSearchApi->create_saved_search:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SavedSearchApi->create_saved_search: %s\n" % e)
```
@@ -126,19 +130,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.saved_search_api import SavedSearchApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
try:
# Delete document by ID
api_instance.delete_saved_search(id)
SavedSearchApi(api_client).delete_saved_search(id)
# Below is a request that includes all optional parameters
# api_instance.delete_saved_search(id)
except Exception as e:
# SavedSearchApi(api_client).delete_saved_search(id)
except Exception as e:
print("Exception when calling SavedSearchApi->delete_saved_search: %s\n" % e)
```
@@ -182,10 +189,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.saved_search_api import SavedSearchApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.search_arguments import SearchArguments
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
search_arguments = {
"owner" : "",
@@ -201,12 +212,12 @@ from pprint import pprint
try:
# Execute a saved search by ID
Result = search_arguments.from_json(search_arguments)
api_instance.execute_saved_search(id, Result)
new_search_arguments = SearchArguments()
new_search_arguments.from_json(search_arguments)
SavedSearchApi(api_client).execute_saved_search(id, new_search_arguments)
# Below is a request that includes all optional parameters
# api_instance.execute_saved_search(id, Result)
except Exception as e:
# SavedSearchApi(api_client).execute_saved_search(id, new_search_arguments)
except Exception as e:
print("Exception when calling SavedSearchApi->execute_saved_search: %s\n" % e)
```
@@ -249,22 +260,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.saved_search_api import SavedSearchApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.saved_search import SavedSearch
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
try:
# Return saved search by ID
api_response = api_instance.get_saved_search(id)
results =SavedSearchApi(api_client).get_saved_search(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_saved_search(id)
# results = SavedSearchApi(api_client).get_saved_search(id)
print("The response of SavedSearchApi->get_saved_search:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SavedSearchApi->get_saved_search: %s\n" % e)
```
@@ -309,10 +323,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.saved_search_api import SavedSearchApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.saved_search import SavedSearch
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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)
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)
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)
@@ -321,13 +339,12 @@ from pprint import pprint
try:
# A list of Saved Searches
api_response = api_instance.list_saved_searches()
results =SavedSearchApi(api_client).list_saved_searches()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_saved_searches(offset, limit, count, filters)
# results = SavedSearchApi(api_client).list_saved_searches(offset, limit, count, filters)
print("The response of SavedSearchApi->list_saved_searches:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SavedSearchApi->list_saved_searches: %s\n" % e)
```
@@ -372,10 +389,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.saved_search_api import SavedSearchApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.saved_search import SavedSearch
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
saved_search = {
"owner" : {
@@ -425,14 +446,14 @@ from pprint import pprint
try:
# Updates an existing saved search
Result = saved_search.from_json(saved_search)
api_response = api_instance.put_saved_search(id, Result)
new_saved_search = SavedSearch()
new_saved_search.from_json(saved_search)
results =SavedSearchApi(api_client).put_saved_search(id, new_saved_search)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_saved_search(id, Result)
# results = SavedSearchApi(api_client).put_saved_search(id, new_saved_search)
print("The response of SavedSearchApi->put_saved_search:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SavedSearchApi->put_saved_search: %s\n" % e)
```

95
docs/tools/sdk/python/Reference/V3/Methods/ScheduledSearchApi.md
View File

@@ -84,23 +84,27 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.scheduled_search_api import ScheduledSearchApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.create_scheduled_search_request import CreateScheduledSearchRequest
from sailpoint.v3.models.scheduled_search import ScheduledSearch
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
create_scheduled_search_request = {savedSearchId=9c620e13-cd33-4804-a13d-403bd7bcdbad, schedule={type=DAILY, hours={type=LIST, values=[9]}}, recipients=[{type=IDENTITY, id=2c9180867624cbd7017642d8c8c81f67}]} # CreateScheduledSearchRequest | The scheduled search to persist.
try:
# Create a new scheduled search
Result = create_scheduled_search_request.from_json(create_scheduled_search_request)
api_response = api_instance.create_scheduled_search(Result)
new_create_scheduled_search_request = CreateScheduledSearchRequest()
new_create_scheduled_search_request.from_json(create_scheduled_search_request)
results =ScheduledSearchApi(api_client).create_scheduled_search(new_create_scheduled_search_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_scheduled_search(Result)
# results = ScheduledSearchApi(api_client).create_scheduled_search(new_create_scheduled_search_request)
print("The response of ScheduledSearchApi->create_scheduled_search:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ScheduledSearchApi->create_scheduled_search: %s\n" % e)
```
@@ -143,19 +147,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.scheduled_search_api import ScheduledSearchApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
try:
# Delete a Scheduled Search
api_instance.delete_scheduled_search(id)
ScheduledSearchApi(api_client).delete_scheduled_search(id)
# Below is a request that includes all optional parameters
# api_instance.delete_scheduled_search(id)
except Exception as e:
# ScheduledSearchApi(api_client).delete_scheduled_search(id)
except Exception as e:
print("Exception when calling ScheduledSearchApi->delete_scheduled_search: %s\n" % e)
```
@@ -197,22 +204,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.scheduled_search_api import ScheduledSearchApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.scheduled_search import ScheduledSearch
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
try:
# Get a Scheduled Search
api_response = api_instance.get_scheduled_search(id)
results =ScheduledSearchApi(api_client).get_scheduled_search(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_scheduled_search(id)
# results = ScheduledSearchApi(api_client).get_scheduled_search(id)
print("The response of ScheduledSearchApi->get_scheduled_search:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ScheduledSearchApi->get_scheduled_search: %s\n" % e)
```
@@ -258,10 +268,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.scheduled_search_api import ScheduledSearchApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.scheduled_search import ScheduledSearch
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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)
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)
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)
@@ -270,13 +284,12 @@ from pprint import pprint
try:
# List scheduled searches
api_response = api_instance.list_scheduled_search()
results =ScheduledSearchApi(api_client).list_scheduled_search()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_scheduled_search(offset, limit, count, filters)
# results = ScheduledSearchApi(api_client).list_scheduled_search(offset, limit, count, filters)
print("The response of ScheduledSearchApi->list_scheduled_search:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ScheduledSearchApi->list_scheduled_search: %s\n" % e)
```
@@ -317,10 +330,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.scheduled_search_api import ScheduledSearchApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.typed_reference import TypedReference
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
typed_reference = {
"id" : "2c91808568c529c60168cca6f90c1313",
@@ -329,12 +346,12 @@ from pprint import pprint
try:
# Unsubscribe a recipient from Scheduled Search
Result = typed_reference.from_json(typed_reference)
api_instance.unsubscribe_scheduled_search(id, Result)
new_typed_reference = TypedReference()
new_typed_reference.from_json(typed_reference)
ScheduledSearchApi(api_client).unsubscribe_scheduled_search(id, new_typed_reference)
# Below is a request that includes all optional parameters
# api_instance.unsubscribe_scheduled_search(id, Result)
except Exception as e:
# ScheduledSearchApi(api_client).unsubscribe_scheduled_search(id, new_typed_reference)
except Exception as e:
print("Exception when calling ScheduledSearchApi->unsubscribe_scheduled_search: %s\n" % e)
```
@@ -378,10 +395,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.scheduled_search_api import ScheduledSearchApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.scheduled_search import ScheduledSearch
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
scheduled_search = {
"owner" : {
@@ -429,14 +450,14 @@ from pprint import pprint
try:
# Update an existing Scheduled Search
Result = scheduled_search.from_json(scheduled_search)
api_response = api_instance.update_scheduled_search(id, Result)
new_scheduled_search = ScheduledSearch()
new_scheduled_search.from_json(scheduled_search)
results =ScheduledSearchApi(api_client).update_scheduled_search(id, new_scheduled_search)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_scheduled_search(id, Result)
# results = ScheduledSearchApi(api_client).update_scheduled_search(id, new_scheduled_search)
print("The response of ScheduledSearchApi->update_scheduled_search:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ScheduledSearchApi->update_scheduled_search: %s\n" % e)
```

67
docs/tools/sdk/python/Reference/V3/Methods/SearchApi.md
View File

@@ -80,11 +80,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.search_api import SearchApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.aggregation_result import AggregationResult
from sailpoint.v3.models.search import Search
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
search = {
"queryDsl" : {
"match" : {
@@ -208,14 +212,14 @@ from pprint import pprint
try:
# Perform a Search Query Aggregation
Result = search.from_json(search)
api_response = api_instance.search_aggregate(Result, )
new_search = Search()
new_search.from_json(search)
results =SearchApi(api_client).search_aggregate(new_search, )
# Below is a request that includes all optional parameters
# api_response = api_instance.search_aggregate(Result, offset, limit, count)
# results = SearchApi(api_client).search_aggregate(new_search, offset, limit, count)
print("The response of SearchApi->search_aggregate:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SearchApi->search_aggregate: %s\n" % e)
```
@@ -256,10 +260,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.search_api import SearchApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.search import Search
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
search = {
"queryDsl" : {
"match" : {
@@ -380,12 +388,12 @@ from pprint import pprint
try:
# Count Documents Satisfying a Query
Result = search.from_json(search)
api_instance.search_count(Result)
new_search = Search()
new_search.from_json(search)
SearchApi(api_client).search_count(new_search)
# Below is a request that includes all optional parameters
# api_instance.search_count(Result)
except Exception as e:
# SearchApi(api_client).search_count(new_search)
except Exception as e:
print("Exception when calling SearchApi->search_count: %s\n" % e)
```
@@ -428,22 +436,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.search_api import SearchApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
index = 'accounts' # str | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. # str | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*.
id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
try:
# Get a Document by ID
api_response = api_instance.search_get(index, id)
results =SearchApi(api_client).search_get(index, id)
# Below is a request that includes all optional parameters
# api_response = api_instance.search_get(index, id)
# results = SearchApi(api_client).search_get(index, id)
print("The response of SearchApi->search_get:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SearchApi->search_get: %s\n" % e)
```
@@ -487,10 +498,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.search_api import SearchApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.search import Search
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
search = {
"queryDsl" : {
"match" : {
@@ -614,14 +629,14 @@ from pprint import pprint
try:
# Perform Search
Result = search.from_json(search)
api_response = api_instance.search_post(Result, )
new_search = Search()
new_search.from_json(search)
results =SearchApi(api_client).search_post(new_search, )
# Below is a request that includes all optional parameters
# api_response = api_instance.search_post(Result, offset, limit, count)
# results = SearchApi(api_client).search_post(new_search, offset, limit, count)
print("The response of SearchApi->search_post:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SearchApi->search_post: %s\n" % e)
```

79
docs/tools/sdk/python/Reference/V3/Methods/SearchAttributeConfigurationApi.md
View File

@@ -74,10 +74,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.search_attribute_configuration_api import SearchAttributeConfigurationApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.search_attribute_config import SearchAttributeConfig
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
search_attribute_config = {
"displayName" : "New Mail Attribute",
"name" : "newMailAttribute",
@@ -89,14 +93,14 @@ from pprint import pprint
try:
# Create Extended Search Attributes
Result = search_attribute_config.from_json(search_attribute_config)
api_response = api_instance.create_search_attribute_config(Result)
new_search_attribute_config = SearchAttributeConfig()
new_search_attribute_config.from_json(search_attribute_config)
results =SearchAttributeConfigurationApi(api_client).create_search_attribute_config(new_search_attribute_config)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_search_attribute_config(Result)
# results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(new_search_attribute_config)
print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SearchAttributeConfigurationApi->create_search_attribute_config: %s\n" % e)
```
@@ -138,19 +142,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.search_attribute_configuration_api import SearchAttributeConfigurationApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete.
try:
# Delete Extended Search Attribute
api_instance.delete_search_attribute_config(name)
SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name)
# Below is a request that includes all optional parameters
# api_instance.delete_search_attribute_config(name)
except Exception as e:
# SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name)
except Exception as e:
print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e)
```
@@ -188,21 +195,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.search_attribute_configuration_api import SearchAttributeConfigurationApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.search_attribute_config import SearchAttributeConfig
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Extended Search Attributes
api_response = api_instance.get_search_attribute_config()
results =SearchAttributeConfigurationApi(api_client).get_search_attribute_config()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_search_attribute_config()
# results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config()
print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SearchAttributeConfigurationApi->get_search_attribute_config: %s\n" % e)
```
@@ -245,22 +255,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.search_attribute_configuration_api import SearchAttributeConfigurationApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.search_attribute_config import SearchAttributeConfig
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
name = 'newMailAttribute' # str | Name of the extended search attribute configuration to retrieve. # str | Name of the extended search attribute configuration to retrieve.
try:
# Get Extended Search Attribute
api_response = api_instance.get_single_search_attribute_config(name)
results =SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_single_search_attribute_config(name)
# results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name)
print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SearchAttributeConfigurationApi->get_single_search_attribute_config: %s\n" % e)
```
@@ -305,11 +318,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.search_attribute_configuration_api import SearchAttributeConfigurationApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
from sailpoint.v3.models.search_attribute_config import SearchAttributeConfig
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
name = 'promotedMailAttribute' # str | Name of the search attribute configuration to patch. # str | Name of the search attribute configuration to patch.
[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}] # List[JsonPatchOperation] |
json_patch_operation = {
@@ -321,14 +338,14 @@ from pprint import pprint
try:
# Update Extended Search Attribute
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_search_attribute_config(name, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_search_attribute_config(name, Result)
# results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, new_json_patch_operation)
print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SearchAttributeConfigurationApi->patch_search_attribute_config: %s\n" % e)
```

79
docs/tools/sdk/python/Reference/V3/Methods/SegmentsApi.md
View File

@@ -73,10 +73,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.segments_api import SegmentsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.segment import Segment
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
segment = {
"owner" : {
"name" : "support",
@@ -104,14 +108,14 @@ from pprint import pprint
try:
# Create Segment
Result = segment.from_json(segment)
api_response = api_instance.create_segment(Result)
new_segment = Segment()
new_segment.from_json(segment)
results =SegmentsApi(api_client).create_segment(new_segment)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_segment(Result)
# results = SegmentsApi(api_client).create_segment(new_segment)
print("The response of SegmentsApi->create_segment:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SegmentsApi->create_segment: %s\n" % e)
```
@@ -154,19 +158,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.segments_api import SegmentsApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete.
try:
# Delete Segment by ID
api_instance.delete_segment(id)
SegmentsApi(api_client).delete_segment(id)
# Below is a request that includes all optional parameters
# api_instance.delete_segment(id)
except Exception as e:
# SegmentsApi(api_client).delete_segment(id)
except Exception as e:
print("Exception when calling SegmentsApi->delete_segment: %s\n" % e)
```
@@ -208,22 +215,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.segments_api import SegmentsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.segment import Segment
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to retrieve. # str | The segment ID to retrieve.
try:
# Get Segment by ID
api_response = api_instance.get_segment(id)
results =SegmentsApi(api_client).get_segment(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_segment(id)
# results = SegmentsApi(api_client).get_segment(id)
print("The response of SegmentsApi->get_segment:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SegmentsApi->get_segment: %s\n" % e)
```
@@ -266,10 +276,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.segments_api import SegmentsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.segment import Segment
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
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)
@@ -277,13 +291,12 @@ from pprint import pprint
try:
# List Segments
api_response = api_instance.list_segments()
results =SegmentsApi(api_client).list_segments()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_segments(limit, offset, count)
# results = SegmentsApi(api_client).list_segments(limit, offset, count)
print("The response of SegmentsApi->list_segments:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SegmentsApi->list_segments: %s\n" % e)
```
@@ -327,10 +340,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.segments_api import SegmentsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.segment import Segment
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to modify. # str | The segment ID to modify.
request_body = [{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}] # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active
request_body = [{op=replace, path=/visibilityCriteria, value={expression={operator=AND, children=[{operator=EQUALS, attribute=location, value={type=STRING, value=Philadelphia}}, {operator=EQUALS, attribute=department, value={type=STRING, value=HR}}]}}}] # List[object] | A list of segment update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * owner * visibilityCriteria * active
@@ -338,14 +355,14 @@ from pprint import pprint
try:
# Update Segment
Result = request_body.from_json(request_body)
api_response = api_instance.patch_segment(id, Result)
new_request_body = RequestBody()
new_request_body.from_json(request_body)
results =SegmentsApi(api_client).patch_segment(id, new_request_body)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_segment(id, Result)
# results = SegmentsApi(api_client).patch_segment(id, new_request_body)
print("The response of SegmentsApi->patch_segment:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SegmentsApi->patch_segment: %s\n" % e)
```

160
docs/tools/sdk/python/Reference/V3/Methods/ServiceDeskIntegrationApi.md
View File

@@ -85,10 +85,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.service_desk_integration_dto import ServiceDeskIntegrationDto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
service_desk_integration_dto = {
"ownerRef" : "",
"cluster" : "xyzzy999",
@@ -126,14 +130,14 @@ from pprint import pprint
try:
# Create new Service Desk integration
Result = service_desk_integration_dto.from_json(service_desk_integration_dto)
api_response = api_instance.create_service_desk_integration(Result)
new_service_desk_integration_dto = ServiceDeskIntegrationDto()
new_service_desk_integration_dto.from_json(service_desk_integration_dto)
results =ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_service_desk_integration(Result)
# results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto)
print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ServiceDeskIntegrationApi->create_service_desk_integration: %s\n" % e)
```
@@ -175,19 +179,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete
try:
# Delete a Service Desk integration
api_instance.delete_service_desk_integration(id)
ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id)
# Below is a request that includes all optional parameters
# api_instance.delete_service_desk_integration(id)
except Exception as e:
# ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id)
except Exception as e:
print("Exception when calling ServiceDeskIntegrationApi->delete_service_desk_integration: %s\n" % e)
```
@@ -229,22 +236,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.service_desk_integration_dto import ServiceDeskIntegrationDto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'anId' # str | ID of the Service Desk integration to get # str | ID of the Service Desk integration to get
try:
# Get a Service Desk integration
api_response = api_instance.get_service_desk_integration(id)
results =ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_service_desk_integration(id)
# results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id)
print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration: %s\n" % e)
```
@@ -286,22 +296,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.service_desk_integration_template_dto import ServiceDeskIntegrationTemplateDto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
script_name = 'aScriptName' # str | The scriptName value of the Service Desk integration template to get # str | The scriptName value of the Service Desk integration template to get
try:
# Service Desk integration template by scriptName
api_response = api_instance.get_service_desk_integration_template(script_name)
results =ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_service_desk_integration_template(script_name)
# results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name)
print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_template: %s\n" % e)
```
@@ -340,21 +353,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.service_desk_integration_template_type import ServiceDeskIntegrationTemplateType
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Service Desk integration types
api_response = api_instance.get_service_desk_integration_types()
results =ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_service_desk_integration_types()
# results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types()
print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integration_types: %s\n" % e)
```
@@ -400,10 +416,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.service_desk_integration_dto import ServiceDeskIntegrationDto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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)
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)
sorters = 'name' # 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** (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** (optional)
@@ -413,13 +433,12 @@ from pprint import pprint
try:
# List existing Service Desk integrations
api_response = api_instance.get_service_desk_integrations()
results =ServiceDeskIntegrationApi(api_client).get_service_desk_integrations()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_service_desk_integrations(offset, limit, sorters, filters, count)
# results = ServiceDeskIntegrationApi(api_client).get_service_desk_integrations(offset, limit, sorters, filters, count)
print("The response of ServiceDeskIntegrationApi->get_service_desk_integrations:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ServiceDeskIntegrationApi->get_service_desk_integrations: %s\n" % e)
```
@@ -458,21 +477,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.queued_check_config_details import QueuedCheckConfigDetails
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get the time check configuration
api_response = api_instance.get_status_check_details()
results =ServiceDeskIntegrationApi(api_client).get_status_check_details()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_status_check_details()
# results = ServiceDeskIntegrationApi(api_client).get_status_check_details()
print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ServiceDeskIntegrationApi->get_status_check_details: %s\n" % e)
```
@@ -515,24 +537,28 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest
from sailpoint.v3.models.service_desk_integration_dto import ServiceDeskIntegrationDto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update
patch_service_desk_integration_request = sailpoint.v3.PatchServiceDeskIntegrationRequest() # PatchServiceDeskIntegrationRequest | A list of SDIM update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Only `replace` operations are accepted by this endpoint. A 403 Forbidden Error indicates that a PATCH operation was attempted that is not allowed.
try:
# Patch a Service Desk Integration
Result = patch_service_desk_integration_request.from_json(patch_service_desk_integration_request)
api_response = api_instance.patch_service_desk_integration(id, Result)
new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest()
new_patch_service_desk_integration_request.from_json(patch_service_desk_integration_request)
results =ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_service_desk_integration(id, Result)
# results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id, new_patch_service_desk_integration_request)
print("The response of ServiceDeskIntegrationApi->patch_service_desk_integration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ServiceDeskIntegrationApi->patch_service_desk_integration: %s\n" % e)
```
@@ -575,10 +601,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.service_desk_integration_dto import ServiceDeskIntegrationDto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'anId' # str | ID of the Service Desk integration to update # str | ID of the Service Desk integration to update
service_desk_integration_dto = {
"ownerRef" : "",
@@ -617,14 +647,14 @@ from pprint import pprint
try:
# Update a Service Desk integration
Result = service_desk_integration_dto.from_json(service_desk_integration_dto)
api_response = api_instance.put_service_desk_integration(id, Result)
new_service_desk_integration_dto = ServiceDeskIntegrationDto()
new_service_desk_integration_dto.from_json(service_desk_integration_dto)
results =ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id, new_service_desk_integration_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_service_desk_integration(id, Result)
# results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id, new_service_desk_integration_dto)
print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ServiceDeskIntegrationApi->put_service_desk_integration: %s\n" % e)
```
@@ -666,10 +696,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.queued_check_config_details import QueuedCheckConfigDetails
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
queued_check_config_details = {
"provisioningStatusCheckIntervalMinutes" : "30",
"provisioningMaxStatusCheckDays" : "2"
@@ -677,14 +711,14 @@ from pprint import pprint
try:
# Update the time check configuration
Result = queued_check_config_details.from_json(queued_check_config_details)
api_response = api_instance.update_status_check_details(Result)
new_queued_check_config_details = QueuedCheckConfigDetails()
new_queued_check_config_details.from_json(queued_check_config_details)
results =ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_status_check_details(Result)
# results = ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details)
print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling ServiceDeskIntegrationApi->update_status_check_details: %s\n" % e)
```

30
docs/tools/sdk/python/Reference/V3/Methods/SourceUsagesApi.md
View File

@@ -55,22 +55,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.source_usages_api import SourceUsagesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.source_usage_status import SourceUsageStatus
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source
try:
# Finds status of source usage
api_response = api_instance.get_status_by_source_id(source_id)
results =SourceUsagesApi(api_client).get_status_by_source_id(source_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_status_by_source_id(source_id)
# results = SourceUsagesApi(api_client).get_status_by_source_id(source_id)
print("The response of SourceUsagesApi->get_status_by_source_id:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourceUsagesApi->get_status_by_source_id: %s\n" % e)
```
@@ -115,10 +118,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.source_usages_api import SourceUsagesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.source_usage import SourceUsage
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | ID of IDN source # str | ID of IDN source
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)
@@ -128,13 +135,12 @@ from pprint import pprint
try:
# Returns source usage insights
api_response = api_instance.get_usages_by_source_id(source_id, )
results =SourceUsagesApi(api_client).get_usages_by_source_id(source_id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_usages_by_source_id(source_id, limit, offset, count, sorters)
# results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id, limit, offset, count, sorters)
print("The response of SourceUsagesApi->get_usages_by_source_id:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourceUsagesApi->get_usages_by_source_id: %s\n" % e)
```

412
docs/tools/sdk/python/Reference/V3/Methods/SourcesApi.md
View File

@@ -137,10 +137,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.provisioning_policy_dto import ProvisioningPolicyDto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id
provisioning_policy_dto = {
"name" : "example provisioning policy for inactive identities",
@@ -185,14 +189,14 @@ from pprint import pprint
try:
# Create Provisioning Policy
Result = provisioning_policy_dto.from_json(provisioning_policy_dto)
api_response = api_instance.create_provisioning_policy(source_id, Result)
new_provisioning_policy_dto = ProvisioningPolicyDto()
new_provisioning_policy_dto.from_json(provisioning_policy_dto)
results =SourcesApi(api_client).create_provisioning_policy(source_id, new_provisioning_policy_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_provisioning_policy(source_id, Result)
# results = SourcesApi(api_client).create_provisioning_policy(source_id, new_provisioning_policy_dto)
print("The response of SourcesApi->create_provisioning_policy:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourcesApi->create_provisioning_policy: %s\n" % e)
```
@@ -234,10 +238,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.source import Source
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source = {
"cluster" : {
"name" : "Corporate Cluster",
@@ -325,14 +333,14 @@ from pprint import pprint
try:
# Creates a source in IdentityNow.
Result = source.from_json(source)
api_response = api_instance.create_source(Result, )
new_source = Source()
new_source.from_json(source)
results =SourcesApi(api_client).create_source(new_source, )
# Below is a request that includes all optional parameters
# api_response = api_instance.create_source(Result, provision_as_csv)
# results = SourcesApi(api_client).create_source(new_source, provision_as_csv)
print("The response of SourcesApi->create_source:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourcesApi->create_source: %s\n" % e)
```
@@ -375,23 +383,27 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.model_schema import ModelSchema
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID.
model_schema = sailpoint.v3.ModelSchema() # ModelSchema |
try:
# Create Schema on Source
Result = model_schema.from_json(model_schema)
api_response = api_instance.create_source_schema(source_id, Result)
new_model_schema = ModelSchema()
new_model_schema.from_json(model_schema)
results =SourcesApi(api_client).create_source_schema(source_id, new_model_schema)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_source_schema(source_id, Result)
# results = SourcesApi(api_client).create_source_schema(source_id, new_model_schema)
print("The response of SourcesApi->create_source_schema:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourcesApi->create_source_schema: %s\n" % e)
```
@@ -434,21 +446,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.usage_type import UsageType
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID.
usage_type = sailpoint.v3.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
try:
# Delete Provisioning Policy by UsageType
api_instance.delete_provisioning_policy(source_id, usage_type)
SourcesApi(api_client).delete_provisioning_policy(source_id, usage_type)
# Below is a request that includes all optional parameters
# api_instance.delete_provisioning_policy(source_id, usage_type)
except Exception as e:
# SourcesApi(api_client).delete_provisioning_policy(source_id, usage_type)
except Exception as e:
print("Exception when calling SourcesApi->delete_provisioning_policy: %s\n" % e)
```
@@ -491,22 +506,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.delete_source202_response import DeleteSource202Response
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID.
try:
# Delete Source by ID
api_response = api_instance.delete_source(id)
results =SourcesApi(api_client).delete_source(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_source(id)
# results = SourcesApi(api_client).delete_source(id)
print("The response of SourcesApi->delete_source:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourcesApi->delete_source: %s\n" % e)
```
@@ -549,20 +567,23 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id.
schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id.
try:
# Delete Source Schema by ID
api_instance.delete_source_schema(source_id, schema_id)
SourcesApi(api_client).delete_source_schema(source_id, schema_id)
# Below is a request that includes all optional parameters
# api_instance.delete_source_schema(source_id, schema_id)
except Exception as e:
# SourcesApi(api_client).delete_source_schema(source_id, schema_id)
except Exception as e:
print("Exception when calling SourcesApi->delete_source_schema: %s\n" % e)
```
@@ -605,19 +626,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id
try:
# Downloads source accounts schema template
api_instance.get_accounts_schema(id)
SourcesApi(api_client).get_accounts_schema(id)
# Below is a request that includes all optional parameters
# api_instance.get_accounts_schema(id)
except Exception as e:
# SourcesApi(api_client).get_accounts_schema(id)
except Exception as e:
print("Exception when calling SourcesApi->get_accounts_schema: %s\n" % e)
```
@@ -662,20 +686,23 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id
schema_name = '?schemaName=group' # str | Name of entitlement schema (optional) # str | Name of entitlement schema (optional)
try:
# Downloads source entitlements schema template
api_instance.get_entitlements_schema(id, )
SourcesApi(api_client).get_entitlements_schema(id, )
# Below is a request that includes all optional parameters
# api_instance.get_entitlements_schema(id, schema_name)
except Exception as e:
# SourcesApi(api_client).get_entitlements_schema(id, schema_name)
except Exception as e:
print("Exception when calling SourcesApi->get_entitlements_schema: %s\n" % e)
```
@@ -718,24 +745,27 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.provisioning_policy_dto import ProvisioningPolicyDto
from sailpoint.v3.models.usage_type import UsageType
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID.
usage_type = sailpoint.v3.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
try:
# Get Provisioning Policy by UsageType
api_response = api_instance.get_provisioning_policy(source_id, usage_type)
results =SourcesApi(api_client).get_provisioning_policy(source_id, usage_type)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_provisioning_policy(source_id, usage_type)
# results = SourcesApi(api_client).get_provisioning_policy(source_id, usage_type)
print("The response of SourcesApi->get_provisioning_policy:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourcesApi->get_provisioning_policy: %s\n" % e)
```
@@ -777,22 +807,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.source import Source
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID.
try:
# Get Source by ID
api_response = api_instance.get_source(id)
results =SourcesApi(api_client).get_source(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_source(id)
# results = SourcesApi(api_client).get_source(id)
print("The response of SourcesApi->get_source:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourcesApi->get_source: %s\n" % e)
```
@@ -834,22 +867,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.source_connections_dto import SourceConnectionsDto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID.
try:
# Get Source Connections by ID
api_response = api_instance.get_source_connections(id)
results =SourcesApi(api_client).get_source_connections(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_source_connections(id)
# results = SourcesApi(api_client).get_source_connections(id)
print("The response of SourcesApi->get_source_connections:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourcesApi->get_source_connections: %s\n" % e)
```
@@ -891,22 +927,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.source_health_dto import SourceHealthDto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id.
try:
# Fetches source health by id
api_response = api_instance.get_source_health(source_id)
results =SourcesApi(api_client).get_source_health(source_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_source_health(source_id)
# results = SourcesApi(api_client).get_source_health(source_id)
print("The response of SourcesApi->get_source_health:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourcesApi->get_source_health: %s\n" % e)
```
@@ -950,23 +989,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.model_schema import ModelSchema
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id.
schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id.
try:
# Get Source Schema by ID
api_response = api_instance.get_source_schema(source_id, schema_id)
results =SourcesApi(api_client).get_source_schema(source_id, schema_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_source_schema(source_id, schema_id)
# results = SourcesApi(api_client).get_source_schema(source_id, schema_id)
print("The response of SourcesApi->get_source_schema:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourcesApi->get_source_schema: %s\n" % e)
```
@@ -1010,10 +1052,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.model_schema import ModelSchema
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID.
include_types = 'group' # str | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional) # str | If set to 'group', then the account schema is filtered and only group schemas are returned. Only a value of 'group' is recognized presently. Note: The API will check whether include-types is group or not, if not, it will list schemas based on include-names, if include-names is not provided, it will list all schemas. (optional)
include_names = 'account' # str | A comma-separated list of schema names to filter result. (optional) # str | A comma-separated list of schema names to filter result. (optional)
@@ -1021,13 +1067,12 @@ from pprint import pprint
try:
# List Schemas on Source
api_response = api_instance.get_source_schemas(source_id, )
results =SourcesApi(api_client).get_source_schemas(source_id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_source_schemas(source_id, include_types, include_names)
# results = SourcesApi(api_client).get_source_schemas(source_id, include_types, include_names)
print("The response of SourcesApi->get_source_schemas:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourcesApi->get_source_schemas: %s\n" % e)
```
@@ -1075,23 +1120,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.model_schema import ModelSchema
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id
file = None # bytearray | (optional) # bytearray | (optional)
try:
# Uploads source accounts schema template
api_response = api_instance.import_accounts_schema(id, )
results =SourcesApi(api_client).import_accounts_schema(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.import_accounts_schema(id, file)
# results = SourcesApi(api_client).import_accounts_schema(id, file)
print("The response of SourcesApi->import_accounts_schema:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourcesApi->import_accounts_schema: %s\n" % e)
```
@@ -1133,23 +1181,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.source import Source
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id.
file = None # bytearray | (optional) # bytearray | (optional)
try:
# Upload connector file to source
api_response = api_instance.import_connector_file(source_id, )
results =SourcesApi(api_client).import_connector_file(source_id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.import_connector_file(source_id, file)
# results = SourcesApi(api_client).import_connector_file(source_id, file)
print("The response of SourcesApi->import_connector_file:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourcesApi->import_connector_file: %s\n" % e)
```
@@ -1198,10 +1249,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.model_schema import ModelSchema
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The Source id # str | The Source id
schema_name = '?schemaName=group' # str | Name of entitlement schema (optional) # str | Name of entitlement schema (optional)
file = None # bytearray | (optional) # bytearray | (optional)
@@ -1209,13 +1264,12 @@ from pprint import pprint
try:
# Uploads source entitlements schema template
api_response = api_instance.import_entitlements_schema(id, )
results =SourcesApi(api_client).import_entitlements_schema(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.import_entitlements_schema(id, schema_name, file)
# results = SourcesApi(api_client).import_entitlements_schema(id, schema_name, file)
print("The response of SourcesApi->import_entitlements_schema:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourcesApi->import_entitlements_schema: %s\n" % e)
```
@@ -1257,22 +1311,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.provisioning_policy_dto import ProvisioningPolicyDto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id
try:
# Lists ProvisioningPolicies
api_response = api_instance.list_provisioning_policies(source_id)
results =SourcesApi(api_client).list_provisioning_policies(source_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.list_provisioning_policies(source_id)
# results = SourcesApi(api_client).list_provisioning_policies(source_id)
print("The response of SourcesApi->list_provisioning_policies:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourcesApi->list_provisioning_policies: %s\n" % e)
```
@@ -1320,10 +1377,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.source import Source
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
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)
@@ -1335,13 +1396,12 @@ from pprint import pprint
try:
# Lists all sources in IdentityNow.
api_response = api_instance.list_sources()
results =SourcesApi(api_client).list_sources()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source)
# results = SourcesApi(api_client).list_sources(limit, offset, count, filters, sorters, for_subadmin, include_idn_source)
print("The response of SourcesApi->list_sources:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourcesApi->list_sources: %s\n" % e)
```
@@ -1387,11 +1447,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.provisioning_policy_dto import ProvisioningPolicyDto
from sailpoint.v3.models.usage_type import UsageType
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source ID. # str | The Source ID.
usage_type = sailpoint.v3.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
provisioning_policy_dto = {
@@ -1437,14 +1501,14 @@ from pprint import pprint
try:
# Update Provisioning Policy by UsageType
Result = provisioning_policy_dto.from_json(provisioning_policy_dto)
api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result)
new_provisioning_policy_dto = ProvisioningPolicyDto()
new_provisioning_policy_dto.from_json(provisioning_policy_dto)
results =SourcesApi(api_client).put_provisioning_policy(source_id, usage_type, new_provisioning_policy_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_provisioning_policy(source_id, usage_type, Result)
# results = SourcesApi(api_client).put_provisioning_policy(source_id, usage_type, new_provisioning_policy_dto)
print("The response of SourcesApi->put_provisioning_policy:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourcesApi->put_provisioning_policy: %s\n" % e)
```
@@ -1499,10 +1563,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.source import Source
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID.
source = {
"cluster" : {
@@ -1590,14 +1658,14 @@ from pprint import pprint
try:
# Update Source (Full)
Result = source.from_json(source)
api_response = api_instance.put_source(id, Result)
new_source = Source()
new_source.from_json(source)
results =SourcesApi(api_client).put_source(id, new_source)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_source(id, Result)
# results = SourcesApi(api_client).put_source(id, new_source)
print("The response of SourcesApi->put_source:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourcesApi->put_source: %s\n" % e)
```
@@ -1651,24 +1719,28 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.model_schema import ModelSchema
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id.
schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id.
model_schema = sailpoint.v3.ModelSchema() # ModelSchema |
try:
# Update Source Schema (Full)
Result = model_schema.from_json(model_schema)
api_response = api_instance.put_source_schema(source_id, schema_id, Result)
new_model_schema = ModelSchema()
new_model_schema.from_json(model_schema)
results =SourcesApi(api_client).put_source_schema(source_id, schema_id, new_model_schema)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_source_schema(source_id, schema_id, Result)
# results = SourcesApi(api_client).put_source_schema(source_id, schema_id, new_model_schema)
print("The response of SourcesApi->put_source_schema:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourcesApi->put_source_schema: %s\n" % e)
```
@@ -1711,10 +1783,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.provisioning_policy_dto import ProvisioningPolicyDto
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id.
[sailpoint.v3.ProvisioningPolicyDto()] # List[ProvisioningPolicyDto] |
provisioning_policy_dto = {
@@ -1761,14 +1837,14 @@ from pprint import pprint
try:
# Bulk Update Provisioning Policies
Result = provisioning_policy_dto.from_json(provisioning_policy_dto)
api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result)
new_provisioning_policy_dto = ProvisioningPolicyDto()
new_provisioning_policy_dto.from_json(provisioning_policy_dto)
results =SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_provisioning_policies_in_bulk(source_id, Result)
# results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id, new_provisioning_policy_dto)
print("The response of SourcesApi->update_provisioning_policies_in_bulk:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourcesApi->update_provisioning_policies_in_bulk: %s\n" % e)
```
@@ -1814,12 +1890,16 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
from sailpoint.v3.models.provisioning_policy_dto import ProvisioningPolicyDto
from sailpoint.v3.models.usage_type import UsageType
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id.
usage_type = sailpoint.v3.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
[{op=add, path=/fields/0, value={name=email, transform={type=identityAttribute, attributes={name=email}}, attributes={}, isRequired=false, type=string, isMultiValued=false}}] # List[JsonPatchOperation] | The JSONPatch payload used to update the schema.
@@ -1832,14 +1912,14 @@ from pprint import pprint
try:
# Partial update of Provisioning Policy
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =SourcesApi(api_client).update_provisioning_policy(source_id, usage_type, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_provisioning_policy(source_id, usage_type, Result)
# results = SourcesApi(api_client).update_provisioning_policy(source_id, usage_type, new_json_patch_operation)
print("The response of SourcesApi->update_provisioning_policy:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourcesApi->update_provisioning_policy: %s\n" % e)
```
@@ -1897,11 +1977,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
from sailpoint.v3.models.source import Source
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID.
[{op=replace, path=/description, value=new description}] # List[JsonPatchOperation] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC).
json_patch_operation = {
@@ -1913,14 +1997,14 @@ from pprint import pprint
try:
# Update Source (Partial)
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.update_source(id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =SourcesApi(api_client).update_source(id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_source(id, Result)
# results = SourcesApi(api_client).update_source(id, new_json_patch_operation)
print("The response of SourcesApi->update_source:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourcesApi->update_source: %s\n" % e)
```
@@ -1993,11 +2077,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.sources_api import SourcesApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
from sailpoint.v3.models.model_schema import ModelSchema
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id. # str | The Source id.
schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id.
[{op=add, path=/attributes/-, value={name=location, type=STRING, schema=null, description=Employee location, isMulti=false, isEntitlement=false, isGroup=false}}] # List[JsonPatchOperation] | The JSONPatch payload used to update the schema.
@@ -2010,14 +2098,14 @@ from pprint import pprint
try:
# Update Source Schema (Partial)
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.update_source_schema(source_id, schema_id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =SourcesApi(api_client).update_source_schema(source_id, schema_id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.update_source_schema(source_id, schema_id, Result)
# results = SourcesApi(api_client).update_source_schema(source_id, schema_id, new_json_patch_operation)
print("The response of SourcesApi->update_source_schema:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling SourcesApi->update_source_schema: %s\n" % e)
```

126
docs/tools/sdk/python/Reference/V3/Methods/TaggedObjectsApi.md
View File

@@ -112,20 +112,23 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.tagged_objects_api import TaggedObjectsApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
type = 'ROLE' # str | The type of object to delete tags from. # str | The type of object to delete tags from.
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object to delete tags from. # str | The ID of the object to delete tags from.
try:
# Delete Object Tags
api_instance.delete_tagged_object(type, id)
TaggedObjectsApi(api_client).delete_tagged_object(type, id)
# Below is a request that includes all optional parameters
# api_instance.delete_tagged_object(type, id)
except Exception as e:
# TaggedObjectsApi(api_client).delete_tagged_object(type, id)
except Exception as e:
print("Exception when calling TaggedObjectsApi->delete_tagged_object: %s\n" % e)
```
@@ -166,10 +169,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.tagged_objects_api import TaggedObjectsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.bulk_remove_tagged_object import BulkRemoveTaggedObject
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
bulk_remove_tagged_object = {
"objectRefs" : [ {
"name" : "William Wilson",
@@ -185,12 +192,12 @@ from pprint import pprint
try:
# Remove Tags from Multiple Objects
Result = bulk_remove_tagged_object.from_json(bulk_remove_tagged_object)
api_instance.delete_tags_to_many_object(Result)
new_bulk_remove_tagged_object = BulkRemoveTaggedObject()
new_bulk_remove_tagged_object.from_json(bulk_remove_tagged_object)
TaggedObjectsApi(api_client).delete_tags_to_many_object(new_bulk_remove_tagged_object)
# Below is a request that includes all optional parameters
# api_instance.delete_tags_to_many_object(Result)
except Exception as e:
# TaggedObjectsApi(api_client).delete_tags_to_many_object(new_bulk_remove_tagged_object)
except Exception as e:
print("Exception when calling TaggedObjectsApi->delete_tags_to_many_object: %s\n" % e)
```
@@ -232,23 +239,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.tagged_objects_api import TaggedObjectsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.tagged_object import TaggedObject
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
type = 'ROLE' # str | The type of tagged object to retrieve. # str | The type of tagged object to retrieve.
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve.
try:
# Get Tagged Object
api_response = api_instance.get_tagged_object(type, id)
results =TaggedObjectsApi(api_client).get_tagged_object(type, id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_tagged_object(type, id)
# results = TaggedObjectsApi(api_client).get_tagged_object(type, id)
print("The response of TaggedObjectsApi->get_tagged_object:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TaggedObjectsApi->get_tagged_object: %s\n" % e)
```
@@ -294,10 +304,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.tagged_objects_api import TaggedObjectsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.tagged_object import TaggedObject
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
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)
@@ -306,13 +320,12 @@ from pprint import pprint
try:
# List Tagged Objects
api_response = api_instance.list_tagged_objects()
results =TaggedObjectsApi(api_client).list_tagged_objects()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_tagged_objects(limit, offset, count, filters)
# results = TaggedObjectsApi(api_client).list_tagged_objects(limit, offset, count, filters)
print("The response of TaggedObjectsApi->list_tagged_objects:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TaggedObjectsApi->list_tagged_objects: %s\n" % e)
```
@@ -359,10 +372,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.tagged_objects_api import TaggedObjectsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.tagged_object import TaggedObject
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
type = 'ROLE' # str | The type of tagged object to retrieve. # str | The type of tagged object to retrieve.
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)
@@ -372,13 +389,12 @@ from pprint import pprint
try:
# List Tagged Objects by Type
api_response = api_instance.list_tagged_objects_by_type(type, )
results =TaggedObjectsApi(api_client).list_tagged_objects_by_type(type, )
# Below is a request that includes all optional parameters
# api_response = api_instance.list_tagged_objects_by_type(type, limit, offset, count, filters)
# results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type, limit, offset, count, filters)
print("The response of TaggedObjectsApi->list_tagged_objects_by_type:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TaggedObjectsApi->list_tagged_objects_by_type: %s\n" % e)
```
@@ -421,10 +437,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.tagged_objects_api import TaggedObjectsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.tagged_object import TaggedObject
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
type = 'ROLE' # str | The type of tagged object to update. # str | The type of tagged object to update.
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to update. # str | The ID of the object reference to update.
tagged_object = {
@@ -438,14 +458,14 @@ from pprint import pprint
try:
# Update Tagged Object
Result = tagged_object.from_json(tagged_object)
api_response = api_instance.put_tagged_object(type, id, Result)
new_tagged_object = TaggedObject()
new_tagged_object.from_json(tagged_object)
results =TaggedObjectsApi(api_client).put_tagged_object(type, id, new_tagged_object)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_tagged_object(type, id, Result)
# results = TaggedObjectsApi(api_client).put_tagged_object(type, id, new_tagged_object)
print("The response of TaggedObjectsApi->put_tagged_object:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TaggedObjectsApi->put_tagged_object: %s\n" % e)
```
@@ -488,10 +508,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.tagged_objects_api import TaggedObjectsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.tagged_object import TaggedObject
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
tagged_object = {
"objectRef" : {
"name" : "William Wilson",
@@ -503,12 +527,12 @@ from pprint import pprint
try:
# Add Tag to Object
Result = tagged_object.from_json(tagged_object)
api_instance.set_tag_to_object(Result)
new_tagged_object = TaggedObject()
new_tagged_object.from_json(tagged_object)
TaggedObjectsApi(api_client).set_tag_to_object(new_tagged_object)
# Below is a request that includes all optional parameters
# api_instance.set_tag_to_object(Result)
except Exception as e:
# TaggedObjectsApi(api_client).set_tag_to_object(new_tagged_object)
except Exception as e:
print("Exception when calling TaggedObjectsApi->set_tag_to_object: %s\n" % e)
```
@@ -549,11 +573,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.tagged_objects_api import TaggedObjectsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.bulk_add_tagged_object import BulkAddTaggedObject
from sailpoint.v3.models.bulk_tagged_object_response import BulkTaggedObjectResponse
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
bulk_add_tagged_object = {
"objectRefs" : [ {
"name" : "William Wilson",
@@ -570,14 +598,14 @@ from pprint import pprint
try:
# Tag Multiple Objects
Result = bulk_add_tagged_object.from_json(bulk_add_tagged_object)
api_response = api_instance.set_tags_to_many_objects(Result)
new_bulk_add_tagged_object = BulkAddTaggedObject()
new_bulk_add_tagged_object.from_json(bulk_add_tagged_object)
results =TaggedObjectsApi(api_client).set_tags_to_many_objects(new_bulk_add_tagged_object)
# Below is a request that includes all optional parameters
# api_response = api_instance.set_tags_to_many_objects(Result)
# results = TaggedObjectsApi(api_client).set_tags_to_many_objects(new_bulk_add_tagged_object)
print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TaggedObjectsApi->set_tags_to_many_objects: %s\n" % e)
```

76
docs/tools/sdk/python/Reference/V3/Methods/TransformsApi.md
View File

@@ -62,11 +62,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.transforms_api import TransformsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.transform import Transform
from sailpoint.v3.models.transform_read import TransformRead
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
transform = {
"name" : "Timestamp To Date",
"attributes" : "{}",
@@ -75,14 +79,14 @@ from pprint import pprint
try:
# Create transform
Result = transform.from_json(transform)
api_response = api_instance.create_transform(Result)
new_transform = Transform()
new_transform.from_json(transform)
results =TransformsApi(api_client).create_transform(new_transform)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_transform(Result)
# results = TransformsApi(api_client).create_transform(new_transform)
print("The response of TransformsApi->create_transform:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TransformsApi->create_transform: %s\n" % e)
```
@@ -124,19 +128,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.transforms_api import TransformsApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to delete # str | ID of the transform to delete
try:
# Delete a transform
api_instance.delete_transform(id)
TransformsApi(api_client).delete_transform(id)
# Below is a request that includes all optional parameters
# api_instance.delete_transform(id)
except Exception as e:
# TransformsApi(api_client).delete_transform(id)
except Exception as e:
print("Exception when calling TransformsApi->delete_transform: %s\n" % e)
```
@@ -178,22 +185,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.transforms_api import TransformsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.transform_read import TransformRead
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to retrieve # str | ID of the transform to retrieve
try:
# Transform by ID
api_response = api_instance.get_transform(id)
results =TransformsApi(api_client).get_transform(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_transform(id)
# results = TransformsApi(api_client).get_transform(id)
print("The response of TransformsApi->get_transform:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TransformsApi->get_transform: %s\n" % e)
```
@@ -239,10 +249,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.transforms_api import TransformsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.transform_read import TransformRead
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
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)
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)
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)
@@ -252,13 +266,12 @@ from pprint import pprint
try:
# List transforms
api_response = api_instance.list_transforms()
results =TransformsApi(api_client).list_transforms()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_transforms(offset, limit, count, name, filters)
# results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters)
print("The response of TransformsApi->list_transforms:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TransformsApi->list_transforms: %s\n" % e)
```
@@ -301,11 +314,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.transforms_api import TransformsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.transform import Transform
from sailpoint.v3.models.transform_read import TransformRead
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to update # str | ID of the transform to update
transform = {
"name" : "Timestamp To Date",
@@ -316,13 +333,12 @@ from pprint import pprint
try:
# Update a transform
api_response = api_instance.update_transform(id, )
results =TransformsApi(api_client).update_transform(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.update_transform(id, Result)
# results = TransformsApi(api_client).update_transform(id, new_transform)
print("The response of TransformsApi->update_transform:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling TransformsApi->update_transform: %s\n" % e)
```

51
docs/tools/sdk/python/Reference/V3/Methods/VendorConnectorMappingsApi.md
View File

@@ -55,10 +55,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.vendor_connector_mappings_api import VendorConnectorMappingsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.vendor_connector_mapping import VendorConnectorMapping
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
vendor_connector_mapping = {
"createdAt" : "2024-03-13T12:56:19.391294Z",
"deletedAt" : {
@@ -85,14 +89,14 @@ from pprint import pprint
try:
# Create Vendor Connector Mapping
Result = vendor_connector_mapping.from_json(vendor_connector_mapping)
api_response = api_instance.create_vendor_connector_mapping(Result)
new_vendor_connector_mapping = VendorConnectorMapping()
new_vendor_connector_mapping.from_json(vendor_connector_mapping)
results =VendorConnectorMappingsApi(api_client).create_vendor_connector_mapping(new_vendor_connector_mapping)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_vendor_connector_mapping(Result)
# results = VendorConnectorMappingsApi(api_client).create_vendor_connector_mapping(new_vendor_connector_mapping)
print("The response of VendorConnectorMappingsApi->create_vendor_connector_mapping:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling VendorConnectorMappingsApi->create_vendor_connector_mapping: %s\n" % e)
```
@@ -135,11 +139,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.vendor_connector_mappings_api import VendorConnectorMappingsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.delete_vendor_connector_mapping200_response import DeleteVendorConnectorMapping200Response
from sailpoint.v3.models.vendor_connector_mapping import VendorConnectorMapping
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
vendor_connector_mapping = {
"createdAt" : "2024-03-13T12:56:19.391294Z",
"deletedAt" : {
@@ -166,14 +174,14 @@ from pprint import pprint
try:
# Delete Vendor Connector Mapping
Result = vendor_connector_mapping.from_json(vendor_connector_mapping)
api_response = api_instance.delete_vendor_connector_mapping(Result)
new_vendor_connector_mapping = VendorConnectorMapping()
new_vendor_connector_mapping.from_json(vendor_connector_mapping)
results =VendorConnectorMappingsApi(api_client).delete_vendor_connector_mapping(new_vendor_connector_mapping)
# Below is a request that includes all optional parameters
# api_response = api_instance.delete_vendor_connector_mapping(Result)
# results = VendorConnectorMappingsApi(api_client).delete_vendor_connector_mapping(new_vendor_connector_mapping)
print("The response of VendorConnectorMappingsApi->delete_vendor_connector_mapping:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling VendorConnectorMappingsApi->delete_vendor_connector_mapping: %s\n" % e)
```
@@ -213,21 +221,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.vendor_connector_mappings_api import VendorConnectorMappingsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.vendor_connector_mapping import VendorConnectorMapping
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Vendor Connector Mappings
api_response = api_instance.get_vendor_connector_mappings()
results =VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_vendor_connector_mappings()
# results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings()
print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling VendorConnectorMappingsApi->get_vendor_connector_mappings: %s\n" % e)
```

199
docs/tools/sdk/python/Reference/V3/Methods/WorkItemsApi.md
View File

@@ -79,23 +79,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_items import WorkItems
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item.
try:
# Approve an Approval Item
api_response = api_instance.approve_approval_item(id, approval_item_id)
results =WorkItemsApi(api_client).approve_approval_item(id, approval_item_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.approve_approval_item(id, approval_item_id)
# results = WorkItemsApi(api_client).approve_approval_item(id, approval_item_id)
print("The response of WorkItemsApi->approve_approval_item:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkItemsApi->approve_approval_item: %s\n" % e)
```
@@ -137,22 +140,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_items import WorkItems
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
try:
# Bulk approve Approval Items
api_response = api_instance.approve_approval_items_in_bulk(id)
results =WorkItemsApi(api_client).approve_approval_items_in_bulk(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.approve_approval_items_in_bulk(id)
# results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id)
print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkItemsApi->approve_approval_items_in_bulk: %s\n" % e)
```
@@ -194,22 +200,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_items import WorkItems
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
try:
# Complete a Work Item
api_response = api_instance.complete_work_item(id)
results =WorkItemsApi(api_client).complete_work_item(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.complete_work_item(id)
# results = WorkItemsApi(api_client).complete_work_item(id)
print("The response of WorkItemsApi->complete_work_item:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkItemsApi->complete_work_item: %s\n" % e)
```
@@ -253,10 +262,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_items import WorkItems
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional) # str | The id of the owner of the work item list being requested. Either an admin, or the owning/current user must make this request. (optional)
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)
@@ -265,13 +278,12 @@ from pprint import pprint
try:
# Completed Work Items
api_response = api_instance.get_completed_work_items()
results =WorkItemsApi(api_client).get_completed_work_items()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_completed_work_items(owner_id, limit, offset, count)
# results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count)
print("The response of WorkItemsApi->get_completed_work_items:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkItemsApi->get_completed_work_items: %s\n" % e)
```
@@ -312,22 +324,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_items_count import WorkItemsCount
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
try:
# Count Completed Work Items
api_response = api_instance.get_count_completed_work_items()
results =WorkItemsApi(api_client).get_count_completed_work_items()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_count_completed_work_items(owner_id)
# results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id)
print("The response of WorkItemsApi->get_count_completed_work_items:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkItemsApi->get_count_completed_work_items: %s\n" % e)
```
@@ -368,22 +383,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_items_count import WorkItemsCount
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = 'ef38f94347e94562b5bb8424a56397d8' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
try:
# Count Work Items
api_response = api_instance.get_count_work_items()
results =WorkItemsApi(api_client).get_count_work_items()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_count_work_items(owner_id)
# results = WorkItemsApi(api_client).get_count_work_items(owner_id)
print("The response of WorkItemsApi->get_count_work_items:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkItemsApi->get_count_work_items: %s\n" % e)
```
@@ -424,22 +442,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_items import WorkItems
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item.
try:
# Get a Work Item
api_response = api_instance.get_work_item(id)
results =WorkItemsApi(api_client).get_work_item(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_work_item(id)
# results = WorkItemsApi(api_client).get_work_item(id)
print("The response of WorkItemsApi->get_work_item:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkItemsApi->get_work_item: %s\n" % e)
```
@@ -480,22 +501,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_items_summary import WorkItemsSummary
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
try:
# Work Items Summary
api_response = api_instance.get_work_items_summary()
results =WorkItemsApi(api_client).get_work_items_summary()
# Below is a request that includes all optional parameters
# api_response = api_instance.get_work_items_summary(owner_id)
# results = WorkItemsApi(api_client).get_work_items_summary(owner_id)
print("The response of WorkItemsApi->get_work_items_summary:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkItemsApi->get_work_items_summary: %s\n" % e)
```
@@ -539,10 +563,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_items import WorkItems
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
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)
@@ -551,13 +579,12 @@ from pprint import pprint
try:
# List Work Items
api_response = api_instance.list_work_items()
results =WorkItemsApi(api_client).list_work_items()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_work_items(limit, offset, count, owner_id)
# results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id)
print("The response of WorkItemsApi->list_work_items:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkItemsApi->list_work_items: %s\n" % e)
```
@@ -600,23 +627,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_items import WorkItems
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
approval_item_id = '1211bcaa32112bcef6122adb21cef1ac' # str | The ID of the approval item. # str | The ID of the approval item.
try:
# Reject an Approval Item
api_response = api_instance.reject_approval_item(id, approval_item_id)
results =WorkItemsApi(api_client).reject_approval_item(id, approval_item_id)
# Below is a request that includes all optional parameters
# api_response = api_instance.reject_approval_item(id, approval_item_id)
# results = WorkItemsApi(api_client).reject_approval_item(id, approval_item_id)
print("The response of WorkItemsApi->reject_approval_item:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkItemsApi->reject_approval_item: %s\n" % e)
```
@@ -658,22 +688,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_items import WorkItems
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
try:
# Bulk reject Approval Items
api_response = api_instance.reject_approval_items_in_bulk(id)
results =WorkItemsApi(api_client).reject_approval_items_in_bulk(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.reject_approval_items_in_bulk(id)
# results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id)
print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkItemsApi->reject_approval_items_in_bulk: %s\n" % e)
```
@@ -715,10 +748,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_item_forward import WorkItemForward
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
work_item_forward = {
"targetOwnerId" : "2c9180835d2e5168015d32f890ca1581",
@@ -728,12 +765,12 @@ from pprint import pprint
try:
# Forward a Work Item
Result = work_item_forward.from_json(work_item_forward)
api_instance.send_work_item_forward(id, Result)
new_work_item_forward = WorkItemForward()
new_work_item_forward.from_json(work_item_forward)
WorkItemsApi(api_client).send_work_item_forward(id, new_work_item_forward)
# Below is a request that includes all optional parameters
# api_instance.send_work_item_forward(id, Result)
except Exception as e:
# WorkItemsApi(api_client).send_work_item_forward(id, new_work_item_forward)
except Exception as e:
print("Exception when calling WorkItemsApi->send_work_item_forward: %s\n" % e)
```
@@ -776,23 +813,27 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.work_items_api import WorkItemsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.work_items import WorkItems
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
request_body = {fieldName=fieldValue} # Dict[str, object] | Account Selection Data map, keyed on fieldName # Dict[str, object] | Account Selection Data map, keyed on fieldName
try:
# Submit Account Selections
Result = request_body.from_json(request_body)
api_response = api_instance.submit_account_selection(id, Result)
new_request_body = RequestBody()
new_request_body.from_json(request_body)
results =WorkItemsApi(api_client).submit_account_selection(id, new_request_body)
# Below is a request that includes all optional parameters
# api_response = api_instance.submit_account_selection(id, Result)
# results = WorkItemsApi(api_client).submit_account_selection(id, new_request_body)
print("The response of WorkItemsApi->submit_account_selection:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkItemsApi->submit_account_selection: %s\n" % e)
```

278
docs/tools/sdk/python/Reference/V3/Methods/WorkflowsApi.md
View File

@@ -70,19 +70,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID
try:
# Cancel Workflow Execution by ID
api_instance.cancel_workflow_execution(id)
WorkflowsApi(api_client).cancel_workflow_execution(id)
# Below is a request that includes all optional parameters
# api_instance.cancel_workflow_execution(id)
except Exception as e:
# WorkflowsApi(api_client).cancel_workflow_execution(id)
except Exception as e:
print("Exception when calling WorkflowsApi->cancel_workflow_execution: %s\n" % e)
```
@@ -124,24 +127,27 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.create_external_execute_workflow200_response import CreateExternalExecuteWorkflow200Response
from sailpoint.v3.models.create_external_execute_workflow_request import CreateExternalExecuteWorkflowRequest
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow
create_external_execute_workflow_request = sailpoint.v3.CreateExternalExecuteWorkflowRequest() # CreateExternalExecuteWorkflowRequest | (optional)
try:
# Execute Workflow via External Trigger
api_response = api_instance.create_external_execute_workflow(id, )
results =WorkflowsApi(api_client).create_external_execute_workflow(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.create_external_execute_workflow(id, Result)
# results = WorkflowsApi(api_client).create_external_execute_workflow(id, new_create_external_execute_workflow_request)
print("The response of WorkflowsApi->create_external_execute_workflow:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->create_external_execute_workflow: %s\n" % e)
```
@@ -182,23 +188,27 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.create_workflow_request import CreateWorkflowRequest
from sailpoint.v3.models.workflow import Workflow
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
create_workflow_request = {name=Send Email, owner={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}, description=Send an email to the identity who's attributes changed., definition={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}, enabled=false, trigger={type=EVENT, attributes={id=idn:identity-attributes-changed, filter=$.changes[?(@.attribute == 'manager')]}}} # CreateWorkflowRequest |
try:
# Create Workflow
Result = create_workflow_request.from_json(create_workflow_request)
api_response = api_instance.create_workflow(Result)
new_create_workflow_request = CreateWorkflowRequest()
new_create_workflow_request.from_json(create_workflow_request)
results =WorkflowsApi(api_client).create_workflow(new_create_workflow_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_workflow(Result)
# results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request)
print("The response of WorkflowsApi->create_workflow:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->create_workflow: %s\n" % e)
```
@@ -239,22 +249,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.workflow_o_auth_client import WorkflowOAuthClient
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow
try:
# Generate External Trigger OAuth Client
api_response = api_instance.create_workflow_external_trigger(id)
results =WorkflowsApi(api_client).create_workflow_external_trigger(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.create_workflow_external_trigger(id)
# results = WorkflowsApi(api_client).create_workflow_external_trigger(id)
print("The response of WorkflowsApi->create_workflow_external_trigger:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->create_workflow_external_trigger: %s\n" % e)
```
@@ -295,19 +308,22 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow
try:
# Delete Workflow By Id
api_instance.delete_workflow(id)
WorkflowsApi(api_client).delete_workflow(id)
# Below is a request that includes all optional parameters
# api_instance.delete_workflow(id)
except Exception as e:
# WorkflowsApi(api_client).delete_workflow(id)
except Exception as e:
print("Exception when calling WorkflowsApi->delete_workflow: %s\n" % e)
```
@@ -348,22 +364,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.workflow import Workflow
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow
try:
# Get Workflow By Id
api_response = api_instance.get_workflow(id)
results =WorkflowsApi(api_client).get_workflow(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_workflow(id)
# results = WorkflowsApi(api_client).get_workflow(id)
print("The response of WorkflowsApi->get_workflow:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->get_workflow: %s\n" % e)
```
@@ -405,21 +424,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.rest import ApiException
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID.
try:
# Get Workflow Execution
api_response = api_instance.get_workflow_execution(id)
results =WorkflowsApi(api_client).get_workflow_execution(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_workflow_execution(id)
# results = WorkflowsApi(api_client).get_workflow_execution(id)
print("The response of WorkflowsApi->get_workflow_execution:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->get_workflow_execution: %s\n" % e)
```
@@ -461,22 +483,25 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.workflow_execution_event import WorkflowExecutionEvent
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow execution # str | Id of the workflow execution
try:
# Get Workflow Execution History
api_response = api_instance.get_workflow_execution_history(id)
results =WorkflowsApi(api_client).get_workflow_execution_history(id)
# Below is a request that includes all optional parameters
# api_response = api_instance.get_workflow_execution_history(id)
# results = WorkflowsApi(api_client).get_workflow_execution_history(id)
print("The response of WorkflowsApi->get_workflow_execution_history:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->get_workflow_execution_history: %s\n" % e)
```
@@ -532,10 +557,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.workflow_execution import WorkflowExecution
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow ID. # str | Workflow 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)
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)
@@ -545,13 +574,12 @@ from pprint import pprint
try:
# List Workflow Executions
api_response = api_instance.get_workflow_executions(id, )
results =WorkflowsApi(api_client).get_workflow_executions(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.get_workflow_executions(id, limit, offset, count, filters)
# results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters)
print("The response of WorkflowsApi->get_workflow_executions:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->get_workflow_executions: %s\n" % e)
```
@@ -593,23 +621,26 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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 Complete Workflow Library
api_response = api_instance.list_complete_workflow_library()
results =WorkflowsApi(api_client).list_complete_workflow_library()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_complete_workflow_library(limit, offset)
# results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset)
print("The response of WorkflowsApi->list_complete_workflow_library:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->list_complete_workflow_library: %s\n" % e)
```
@@ -652,10 +683,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.workflow_library_action import WorkflowLibraryAction
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
filters = 'id eq \"sp:create-campaign\"' # 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* (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* (optional)
@@ -663,13 +698,12 @@ from pprint import pprint
try:
# List Workflow Library Actions
api_response = api_instance.list_workflow_library_actions()
results =WorkflowsApi(api_client).list_workflow_library_actions()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_workflow_library_actions(limit, offset, filters)
# results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters)
print("The response of WorkflowsApi->list_workflow_library_actions:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->list_workflow_library_actions: %s\n" % e)
```
@@ -707,21 +741,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.workflow_library_operator import WorkflowLibraryOperator
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Workflow Library Operators
api_response = api_instance.list_workflow_library_operators()
results =WorkflowsApi(api_client).list_workflow_library_operators()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_workflow_library_operators()
# results = WorkflowsApi(api_client).list_workflow_library_operators()
print("The response of WorkflowsApi->list_workflow_library_operators:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->list_workflow_library_operators: %s\n" % e)
```
@@ -764,10 +801,14 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.workflow_library_trigger import WorkflowLibraryTrigger
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
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)
filters = 'id eq \"idn:identity-attributes-changed\"' # 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* (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* (optional)
@@ -775,13 +816,12 @@ from pprint import pprint
try:
# List Workflow Library Triggers
api_response = api_instance.list_workflow_library_triggers()
results =WorkflowsApi(api_client).list_workflow_library_triggers()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_workflow_library_triggers(limit, offset, filters)
# results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters)
print("The response of WorkflowsApi->list_workflow_library_triggers:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->list_workflow_library_triggers: %s\n" % e)
```
@@ -819,21 +859,24 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.workflow import Workflow
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Workflows
api_response = api_instance.list_workflows()
results =WorkflowsApi(api_client).list_workflows()
# Below is a request that includes all optional parameters
# api_response = api_instance.list_workflows()
# results = WorkflowsApi(api_client).list_workflows()
print("The response of WorkflowsApi->list_workflows:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->list_workflows: %s\n" % e)
```
@@ -875,11 +918,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.json_patch_operation import JsonPatchOperation
from sailpoint.v3.models.workflow import Workflow
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow
[{op=replace, path=/name, value=Send Email}, {op=replace, path=/owner, value={type=IDENTITY, id=2c91808568c529c60168cca6f90c1313, name=William Wilson}}, {op=replace, path=/description, value=Send an email to the identity who's attributes changed.}, {op=replace, path=/enabled, value=false}, {op=replace, path=/definition, value={start=Send Email Test, steps={Send Email={actionId=sp:send-email, attributes={body=This is a test, from=sailpoint@sailpoint.com, recipientId.$=$.identity.id, subject=test}, nextStep=success, selectResult=null, type=action}, success={type=success}}}}, {op=replace, path=/trigger, value={type=EVENT, attributes={id=idn:identity-attributes-changed}}}] # List[JsonPatchOperation] |
json_patch_operation = {
@@ -891,14 +938,14 @@ from pprint import pprint
try:
# Patch Workflow
Result = json_patch_operation.from_json(json_patch_operation)
api_response = api_instance.patch_workflow(id, Result)
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation)
# Below is a request that includes all optional parameters
# api_response = api_instance.patch_workflow(id, Result)
# results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation)
print("The response of WorkflowsApi->patch_workflow:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->patch_workflow: %s\n" % e)
```
@@ -940,11 +987,15 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.workflow import Workflow
from sailpoint.v3.models.workflow_body import WorkflowBody
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow
workflow_body = {
"owner" : {
@@ -988,14 +1039,14 @@ from pprint import pprint
try:
# Update Workflow
Result = workflow_body.from_json(workflow_body)
api_response = api_instance.put_workflow(id, Result)
new_workflow_body = WorkflowBody()
new_workflow_body.from_json(workflow_body)
results =WorkflowsApi(api_client).put_workflow(id, new_workflow_body)
# Below is a request that includes all optional parameters
# api_response = api_instance.put_workflow(id, Result)
# results = WorkflowsApi(api_client).put_workflow(id, new_workflow_body)
print("The response of WorkflowsApi->put_workflow:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->put_workflow: %s\n" % e)
```
@@ -1037,24 +1088,27 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response
from sailpoint.v3.models.test_external_execute_workflow_request import TestExternalExecuteWorkflowRequest
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow
test_external_execute_workflow_request = sailpoint.v3.TestExternalExecuteWorkflowRequest() # TestExternalExecuteWorkflowRequest | (optional)
try:
# Test Workflow via External Trigger
api_response = api_instance.test_external_execute_workflow(id, )
results =WorkflowsApi(api_client).test_external_execute_workflow(id, )
# Below is a request that includes all optional parameters
# api_response = api_instance.test_external_execute_workflow(id, Result)
# results = WorkflowsApi(api_client).test_external_execute_workflow(id, new_test_external_execute_workflow_request)
print("The response of WorkflowsApi->test_external_execute_workflow:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->test_external_execute_workflow: %s\n" % e)
```
@@ -1098,24 +1152,28 @@ Code | Description | Data Type | Response headers |
```python
import sailpoint.v3
from sailpoint.v3.api.workflows_api import WorkflowsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.test_workflow200_response import TestWorkflow200Response
from sailpoint.v3.models.test_workflow_request import TestWorkflowRequest
from sailpoint.v3.rest import ApiException
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the workflow # str | Id of the workflow
test_workflow_request = {input={identity={id=ee769173319b41d19ccec6cea52f237b, name=john.doe, type=IDENTITY}, changes=[{attribute=department, oldValue=sales, newValue=marketing}, {attribute=manager, oldValue={id=ee769173319b41d19ccec6c235423237b, name=nice.guy, type=IDENTITY}, newValue={id=ee769173319b41d19ccec6c235423236c, name=mean.guy, type=IDENTITY}}, {attribute=email, oldValue=john.doe@hotmail.com, newValue=john.doe@gmail.com}]}} # TestWorkflowRequest |
try:
# Test Workflow By Id
Result = test_workflow_request.from_json(test_workflow_request)
api_response = api_instance.test_workflow(id, Result)
new_test_workflow_request = TestWorkflowRequest()
new_test_workflow_request.from_json(test_workflow_request)
results =WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request)
# Below is a request that includes all optional parameters
# api_response = api_instance.test_workflow(id, Result)
# results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request)
print("The response of WorkflowsApi->test_workflow:\n")
pprint(api_response)
except Exception as e:
pprint(results)
except Exception as e:
print("Exception when calling WorkflowsApi->test_workflow: %s\n" % e)
```