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

Update to python SDK docs: 13820107626

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

16
docs/tools/sdk/python/Reference/Beta/Methods/AccessModelMetadataApi.md
View File

@@ -63,7 +63,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_model_metadata_api import AccessModelMetadataApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.attribute_dto import AttributeDTO
@@ -71,13 +70,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
try:
# Get Access Model Metadata Attribute
results =AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key)
results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key=key)
# Below is a request that includes all optional parameters
# results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key)
print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute:\n")
@@ -123,7 +123,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_model_metadata_api import AccessModelMetadataApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.attribute_value_dto import AttributeValueDTO
@@ -131,6 +130,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
value = 'public' # str | Technical name of the Attribute value. # str | Technical name of the Attribute value.
@@ -138,7 +138,7 @@ with ApiClient(configuration) as api_client:
try:
# Get Access Model Metadata Value
results =AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key, value)
results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key=key, value=value)
# Below is a request that includes all optional parameters
# results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key, value)
print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute_value:\n")
@@ -183,7 +183,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_model_metadata_api import AccessModelMetadataApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.attribute_dto import AttributeDTO
@@ -191,13 +190,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
filters = 'name eq \"Privacy\"' # 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**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (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**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional)
try:
# List Access Model Metadata Attributes
results =AccessModelMetadataApi(api_client).list_access_model_metadata_attribute()
results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute()
# Below is a request that includes all optional parameters
# results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(filters)
print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n")
@@ -242,7 +242,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_model_metadata_api import AccessModelMetadataApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.attribute_value_dto import AttributeValueDTO
@@ -250,13 +249,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
try:
# List Access Model Metadata Values
results =AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key)
results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key=key)
# Below is a request that includes all optional parameters
# results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key)
print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n")

64
docs/tools/sdk/python/Reference/Beta/Methods/AccessProfilesApi.md
View File

@@ -93,7 +93,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_profiles_api import AccessProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.access_profile import AccessProfile
@@ -101,8 +100,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
access_profile = {
access_profile = '''{
"owner" : {
"name" : "support",
"id" : "2c9180a46faadee4016fb4e018c20639",
@@ -186,13 +186,12 @@ with ApiClient(configuration) as api_client:
"modified" : "2021-03-02T20:22:28.104Z",
"id" : "2c91808a7190d06e01719938fcd20792",
"requestable" : true
} # AccessProfile |
}''' # AccessProfile |
try:
# Create Access Profile
new_access_profile = AccessProfile()
new_access_profile.from_json(access_profile)
results =AccessProfilesApi(api_client).create_access_profile(new_access_profile)
new_access_profile = AccessProfile.from_json(access_profile)
results = AccessProfilesApi(api_client).create_access_profile(access_profile=new_access_profile)
# Below is a request that includes all optional parameters
# results = AccessProfilesApi(api_client).create_access_profile(new_access_profile)
print("The response of AccessProfilesApi->create_access_profile:\n")
@@ -241,20 +240,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_profiles_api import AccessProfilesApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to delete # str | ID of the Access Profile to delete
try:
# Delete the specified Access Profile
AccessProfilesApi(api_client).delete_access_profile(id)
AccessProfilesApi(api_client).delete_access_profile(id=id)
# Below is a request that includes all optional parameters
# AccessProfilesApi(api_client).delete_access_profile(id)
except Exception as e:
@@ -301,7 +300,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_profiles_api import AccessProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.access_profile_bulk_delete_request import AccessProfileBulkDeleteRequest
@@ -310,17 +308,17 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
access_profile_bulk_delete_request = {
access_profile_bulk_delete_request = '''{
"accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ],
"bestEffortOnly" : true
} # AccessProfileBulkDeleteRequest |
}''' # AccessProfileBulkDeleteRequest |
try:
# Delete Access Profile(s)
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)
new_access_profile_bulk_delete_request = AccessProfileBulkDeleteRequest.from_json(access_profile_bulk_delete_request)
results = AccessProfilesApi(api_client).delete_access_profiles_in_bulk(access_profile_bulk_delete_request=new_access_profile_bulk_delete_request)
# Below is a request that includes all optional parameters
# 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")
@@ -365,7 +363,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_profiles_api import AccessProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.access_profile import AccessProfile
@@ -373,13 +370,14 @@ 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
results =AccessProfilesApi(api_client).get_access_profile(id)
results = AccessProfilesApi(api_client).get_access_profile(id=id)
# Below is a request that includes all optional parameters
# results = AccessProfilesApi(api_client).get_access_profile(id)
print("The response of AccessProfilesApi->get_access_profile:\n")
@@ -430,7 +428,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_profiles_api import AccessProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.entitlement import Entitlement
@@ -438,6 +435,7 @@ 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)
@@ -449,7 +447,7 @@ with ApiClient(configuration) as api_client:
try:
# List Access Profile's Entitlements
results =AccessProfilesApi(api_client).get_access_profile_entitlements(id, )
results = AccessProfilesApi(api_client).get_access_profile_entitlements(id=id)
# Below is a request that includes all optional parameters
# results = AccessProfilesApi(api_client).get_access_profile_entitlements(id, limit, offset, count, filters, sorters)
print("The response of AccessProfilesApi->get_access_profile_entitlements:\n")
@@ -502,7 +500,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_profiles_api import AccessProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.access_profile import AccessProfile
@@ -510,6 +507,7 @@ 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)
@@ -523,7 +521,7 @@ with ApiClient(configuration) as api_client:
try:
# List Access Profiles
results =AccessProfilesApi(api_client).list_access_profiles()
results = AccessProfilesApi(api_client).list_access_profiles()
# Below is a request that includes all optional parameters
# 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")
@@ -574,7 +572,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_profiles_api import AccessProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.access_profile import AccessProfile
@@ -583,21 +580,15 @@ 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 = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] |
json_patch_operation = '''[{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}]''' # List[JsonPatchOperation] |
try:
# Patch a specified Access Profile
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)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = AccessProfilesApi(api_client).patch_access_profile(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = AccessProfilesApi(api_client).patch_access_profile(id, new_json_patch_operation)
print("The response of AccessProfilesApi->patch_access_profile:\n")
@@ -649,7 +640,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_profiles_api import AccessProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.access_profile_bulk_update_request_inner import AccessProfileBulkUpdateRequestInner
@@ -658,16 +648,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}] # List[AccessProfileBulkUpdateRequestInner] |
access_profile_bulk_update_request_inner = [{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}] # List[AccessProfileBulkUpdateRequestInner] |
with ApiClient(configuration) as api_client:
access_profile_bulk_update_request_inner = '''[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]''' # List[AccessProfileBulkUpdateRequestInner] |
try:
# Update Access Profile(s) requestable field.
new_access_profile_bulk_update_request_inner = AccessProfileBulkUpdateRequestInner()
new_access_profile_bulk_update_request_inner.from_json(access_profile_bulk_update_request_inner)
results =AccessProfilesApi(api_client).update_access_profiles_in_bulk(new_access_profile_bulk_update_request_inner)
new_access_profile_bulk_update_request_inner = AccessProfileBulkUpdateRequestInner.from_json(access_profile_bulk_update_request_inner)
results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(access_profile_bulk_update_request_inner=new_access_profile_bulk_update_request_inner)
# Below is a request that includes all optional parameters
# results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(new_access_profile_bulk_update_request_inner)
print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n")

45
docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestApprovalsApi.md
View File

@@ -74,7 +74,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.comment_dto import CommentDto
@@ -82,9 +81,10 @@ 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 = {
comment_dto = '''{
"author" : {
"name" : "Adam Kennedy",
"id" : "2c91808568c529c60168cca6f90c1313",
@@ -92,13 +92,12 @@ with ApiClient(configuration) as api_client:
},
"created" : "2017-07-11T18:45:37.098Z",
"comment" : "This is a comment."
} # CommentDto | Reviewer's comment.
}''' # CommentDto | Reviewer's comment.
try:
# Approve Access Request Approval
new_comment_dto = CommentDto()
new_comment_dto.from_json(comment_dto)
results =AccessRequestApprovalsApi(api_client).approve_access_request(approval_id, new_comment_dto)
new_comment_dto = CommentDto.from_json(comment_dto)
results = AccessRequestApprovalsApi(api_client).approve_access_request(approval_id=approval_id, comment_dto=new_comment_dto)
# Below is a request that includes all optional parameters
# results = AccessRequestApprovalsApi(api_client).approve_access_request(approval_id, new_comment_dto)
print("The response of AccessRequestApprovalsApi->approve_access_request:\n")
@@ -145,7 +144,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.forward_approval_dto import ForwardApprovalDto
@@ -153,18 +151,18 @@ 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 = {
forward_approval_dto = '''{
"newOwnerId" : "newOwnerId",
"comment" : "comment"
} # ForwardApprovalDto | Information about the forwarded approval.
}''' # ForwardApprovalDto | Information about the forwarded approval.
try:
# Forward Access Request Approval
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)
new_forward_approval_dto = ForwardApprovalDto.from_json(forward_approval_dto)
results = AccessRequestApprovalsApi(api_client).forward_access_request(approval_id=approval_id, forward_approval_dto=new_forward_approval_dto)
# Below is a request that includes all optional parameters
# results = AccessRequestApprovalsApi(api_client).forward_access_request(approval_id, new_forward_approval_dto)
print("The response of AccessRequestApprovalsApi->forward_access_request:\n")
@@ -210,7 +208,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.approval_summary import ApprovalSummary
@@ -218,6 +215,7 @@ 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)
@@ -225,7 +223,7 @@ with ApiClient(configuration) as api_client:
try:
# Get Access Requests Approvals Number
results =AccessRequestApprovalsApi(api_client).get_access_request_approval_summary()
results = AccessRequestApprovalsApi(api_client).get_access_request_approval_summary()
# Below is a request that includes all optional parameters
# results = AccessRequestApprovalsApi(api_client).get_access_request_approval_summary(owner_id, from_date)
print("The response of AccessRequestApprovalsApi->get_access_request_approval_summary:\n")
@@ -274,7 +272,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.completed_approval import CompletedApproval
@@ -282,6 +279,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = 'owner_id_example' # 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)
@@ -293,7 +291,7 @@ with ApiClient(configuration) as api_client:
try:
# Completed Access Request Approvals List
results =AccessRequestApprovalsApi(api_client).list_completed_approvals()
results = AccessRequestApprovalsApi(api_client).list_completed_approvals()
# Below is a request that includes all optional parameters
# results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters)
print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n")
@@ -342,7 +340,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.pending_approval import PendingApproval
@@ -350,6 +347,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = 'owner_id_example' # 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)
@@ -361,7 +359,7 @@ with ApiClient(configuration) as api_client:
try:
# Pending Access Request Approvals List
results =AccessRequestApprovalsApi(api_client).list_pending_approvals()
results = AccessRequestApprovalsApi(api_client).list_pending_approvals()
# Below is a request that includes all optional parameters
# results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters)
print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n")
@@ -408,7 +406,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.comment_dto import CommentDto
@@ -416,9 +413,10 @@ 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 = {
comment_dto = '''{
"author" : {
"name" : "Adam Kennedy",
"id" : "2c91808568c529c60168cca6f90c1313",
@@ -426,13 +424,12 @@ with ApiClient(configuration) as api_client:
},
"created" : "2017-07-11T18:45:37.098Z",
"comment" : "This is a comment."
} # CommentDto | Reviewer's comment.
}''' # CommentDto | Reviewer's comment.
try:
# Reject Access Request Approval
new_comment_dto = CommentDto()
new_comment_dto.from_json(comment_dto)
results =AccessRequestApprovalsApi(api_client).reject_access_request(approval_id, new_comment_dto)
new_comment_dto = CommentDto.from_json(comment_dto)
results = AccessRequestApprovalsApi(api_client).reject_access_request(approval_id=approval_id, comment_dto=new_comment_dto)
# Below is a request that includes all optional parameters
# results = AccessRequestApprovalsApi(api_client).reject_access_request(approval_id, new_comment_dto)
print("The response of AccessRequestApprovalsApi->reject_access_request:\n")

4
docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestIdentityMetricsApi.md
View File

@@ -56,13 +56,13 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_request_identity_metrics_api import AccessRequestIdentityMetricsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = '7025c863-c270-4ba6-beea-edf3cb091573' # str | Manager's identity ID. # str | Manager's identity ID.
requested_object_id = '2db501be-f0fb-4cc5-a695-334133c52891' # str | Requested access item's ID. # str | Requested access item's ID.
@@ -71,7 +71,7 @@ with ApiClient(configuration) as api_client:
try:
# Return access request identity metrics
results =AccessRequestIdentityMetricsApi(api_client).get_access_request_identity_metrics(identity_id, requested_object_id, type)
results = AccessRequestIdentityMetricsApi(api_client).get_access_request_identity_metrics(identity_id=identity_id, requested_object_id=requested_object_id, type=type)
# Below is a request that includes all optional parameters
# results = AccessRequestIdentityMetricsApi(api_client).get_access_request_identity_metrics(identity_id, requested_object_id, type)
print("The response of AccessRequestIdentityMetricsApi->get_access_request_identity_metrics:\n")

52
docs/tools/sdk/python/Reference/Beta/Methods/AccessRequestsApi.md
View File

@@ -72,7 +72,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_requests_api import AccessRequestsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.cancel_access_request import CancelAccessRequest
@@ -80,17 +79,17 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
cancel_access_request = {
cancel_access_request = '''{
"accountActivityId" : "2c9180835d2e5168015d32f890ca1581",
"comment" : "I requested this role by mistake."
} # CancelAccessRequest |
}''' # CancelAccessRequest |
try:
# Cancel Access Request
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)
new_cancel_access_request = CancelAccessRequest.from_json(cancel_access_request)
results = AccessRequestsApi(api_client).cancel_access_request(cancel_access_request=new_cancel_access_request)
# Below is a request that includes all optional parameters
# results = AccessRequestsApi(api_client).cancel_access_request(new_cancel_access_request)
print("The response of AccessRequestsApi->cancel_access_request:\n")
@@ -146,7 +145,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_requests_api import AccessRequestsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.close_access_request import CloseAccessRequest
@@ -154,19 +152,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
close_access_request = {
close_access_request = '''{
"executionStatus" : "Terminated",
"accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
"completionStatus" : "Failure",
"message" : "The IdentityNow Administrator manually closed this request."
} # CloseAccessRequest |
}''' # CloseAccessRequest |
try:
# Close Access Request
new_close_access_request = CloseAccessRequest()
new_close_access_request.from_json(close_access_request)
results =AccessRequestsApi(api_client).close_access_request(new_close_access_request)
new_close_access_request = CloseAccessRequest.from_json(close_access_request)
results = AccessRequestsApi(api_client).close_access_request(close_access_request=new_close_access_request)
# Below is a request that includes all optional parameters
# results = AccessRequestsApi(api_client).close_access_request(new_close_access_request)
print("The response of AccessRequestsApi->close_access_request:\n")
@@ -241,7 +239,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_requests_api import AccessRequestsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.access_request import AccessRequest
@@ -250,8 +247,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
access_request = {
access_request = '''{
"requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ],
"clientMetadata" : {
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1",
@@ -304,13 +302,12 @@ with ApiClient(configuration) as api_client:
"id" : "2c9180835d2e5168015d32f890ca1581",
"type" : "ACCESS_PROFILE"
} ]
} # AccessRequest |
}''' # AccessRequest |
try:
# Submit Access Request
new_access_request = AccessRequest()
new_access_request.from_json(access_request)
results =AccessRequestsApi(api_client).create_access_request(new_access_request)
new_access_request = AccessRequest.from_json(access_request)
results = AccessRequestsApi(api_client).create_access_request(access_request=new_access_request)
# Below is a request that includes all optional parameters
# results = AccessRequestsApi(api_client).create_access_request(new_access_request)
print("The response of AccessRequestsApi->create_access_request:\n")
@@ -352,7 +349,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_requests_api import AccessRequestsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.access_request_config import AccessRequestConfig
@@ -360,12 +356,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Access Request Configuration
results =AccessRequestsApi(api_client).get_access_request_config()
results = AccessRequestsApi(api_client).get_access_request_config()
# Below is a request that includes all optional parameters
# results = AccessRequestsApi(api_client).get_access_request_config()
print("The response of AccessRequestsApi->get_access_request_config:\n")
@@ -421,7 +418,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_requests_api import AccessRequestsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.requested_item_status import RequestedItemStatus
@@ -429,6 +425,7 @@ 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)
@@ -444,7 +441,7 @@ with ApiClient(configuration) as api_client:
try:
# Access Request Status
results =AccessRequestsApi(api_client).list_access_request_status()
results = AccessRequestsApi(api_client).list_access_request_status()
# Below is a request that includes all optional parameters
# 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")
@@ -489,7 +486,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.access_requests_api import AccessRequestsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.access_request_config import AccessRequestConfig
@@ -497,8 +493,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
access_request_config = {
access_request_config = '''{
"requestOnBehalfOfConfig" : {
"allowRequestOnBehalfOfEmployeeByManager" : true,
"allowRequestOnBehalfOfAnyoneByAnyone" : true
@@ -523,13 +520,12 @@ with ApiClient(configuration) as api_client:
},
"reauthorizationEnabled" : true,
"approvalsMustBeExternal" : true
} # AccessRequestConfig |
}''' # AccessRequestConfig |
try:
# Update Access Request Configuration
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)
new_access_request_config = AccessRequestConfig.from_json(access_request_config)
results = AccessRequestsApi(api_client).set_access_request_config(access_request_config=new_access_request_config)
# Below is a request that includes all optional parameters
# results = AccessRequestsApi(api_client).set_access_request_config(new_access_request_config)
print("The response of AccessRequestsApi->set_access_request_config:\n")

8
docs/tools/sdk/python/Reference/Beta/Methods/AccountActivitiesApi.md
View File

@@ -85,7 +85,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.account_activities_api import AccountActivitiesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.cancelable_account_activity import CancelableAccountActivity
@@ -93,13 +92,14 @@ 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 Account Activity
results =AccountActivitiesApi(api_client).get_account_activity(id)
results = AccountActivitiesApi(api_client).get_account_activity(id=id)
# Below is a request that includes all optional parameters
# results = AccountActivitiesApi(api_client).get_account_activity(id)
print("The response of AccountActivitiesApi->get_account_activity:\n")
@@ -152,7 +152,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.account_activities_api import AccountActivitiesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.cancelable_account_activity import CancelableAccountActivity
@@ -160,6 +159,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
requested_for = 'requested_for_example' # 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 = 'requested_by_example' # 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)
@@ -174,7 +174,7 @@ with ApiClient(configuration) as api_client:
try:
# List Account Activities
results =AccountActivitiesApi(api_client).list_account_activities()
results = AccountActivitiesApi(api_client).list_account_activities()
# Below is a request that includes all optional parameters
# results = AccountActivitiesApi(api_client).list_account_activities(requested_for, requested_by, regarding_identity, type, limit, offset, count, filters, sorters)
print("The response of AccountActivitiesApi->list_account_activities:\n")

4
docs/tools/sdk/python/Reference/Beta/Methods/AccountAggregationsApi.md
View File

@@ -68,7 +68,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.account_aggregations_api import AccountAggregationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.account_aggregation_status import AccountAggregationStatus
@@ -76,13 +75,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808477a6b0c60177a81146b8110b' # str | The account aggregation id # str | The account aggregation id
try:
# In-progress Account Aggregation status
results =AccountAggregationsApi(api_client).get_account_aggregation_status(id)
results = AccountAggregationsApi(api_client).get_account_aggregation_status(id=id)
# Below is a request that includes all optional parameters
# results = AccountAggregationsApi(api_client).get_account_aggregation_status(id)
print("The response of AccountAggregationsApi->get_account_aggregation_status:\n")

4
docs/tools/sdk/python/Reference/Beta/Methods/AccountUsagesApi.md
View File

@@ -57,7 +57,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.account_usages_api import AccountUsagesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.account_usage import AccountUsage
@@ -65,6 +64,7 @@ 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)
@@ -75,7 +75,7 @@ with ApiClient(configuration) as api_client:
try:
# Returns account usage insights
results =AccountUsagesApi(api_client).get_usages_by_account_id(account_id, )
results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id)
# Below is a request that includes all optional parameters
# 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")

120
docs/tools/sdk/python/Reference/Beta/Methods/AccountsApi.md
View File

@@ -103,7 +103,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.accounts_api import AccountsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.account_attributes_create import AccountAttributesCreate
@@ -112,8 +111,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
account_attributes_create = {
account_attributes_create = '''{
"attributes" : {
"sourceId" : "34bfcbe116c9407464af37acbaf7a4dc",
"city" : "Austin",
@@ -122,13 +122,12 @@ with ApiClient(configuration) as api_client:
"sAMAccountName" : "jDoe",
"mail" : "john.doe@sailpoint.com"
}
} # AccountAttributesCreate |
}''' # AccountAttributesCreate |
try:
# Create Account
new_account_attributes_create = AccountAttributesCreate()
new_account_attributes_create.from_json(account_attributes_create)
results =AccountsApi(api_client).create_account(new_account_attributes_create)
new_account_attributes_create = AccountAttributesCreate.from_json(account_attributes_create)
results = AccountsApi(api_client).create_account(account_attributes_create=new_account_attributes_create)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).create_account(new_account_attributes_create)
print("The response of AccountsApi->create_account:\n")
@@ -178,7 +177,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.accounts_api import AccountsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.accounts_async_result import AccountsAsyncResult
@@ -186,13 +184,14 @@ 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
results =AccountsApi(api_client).delete_account(id)
results = AccountsApi(api_client).delete_account(id=id)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).delete_account(id)
print("The response of AccountsApi->delete_account:\n")
@@ -243,7 +242,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.accounts_api import AccountsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.task_result_dto import TaskResultDto
@@ -251,13 +249,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c350d6aa4f104c61b062cb632421ad10' # str | The account id # str | The account id
try:
# Remove Account
results =AccountsApi(api_client).delete_account_async(id)
results = AccountsApi(api_client).delete_account_async(id=id)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).delete_account_async(id)
print("The response of AccountsApi->delete_account_async:\n")
@@ -305,7 +304,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.accounts_api import AccountsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.account_toggle_request import AccountToggleRequest
@@ -314,18 +312,18 @@ 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 = {
account_toggle_request = '''{
"forceProvisioning" : false,
"externalVerificationId" : "3f9180835d2e5168015d32f890ca1581"
} # AccountToggleRequest |
}''' # AccountToggleRequest |
try:
# Disable Account
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)
new_account_toggle_request = AccountToggleRequest.from_json(account_toggle_request)
results = AccountsApi(api_client).disable_account(id=id, account_toggle_request=new_account_toggle_request)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).disable_account(id, new_account_toggle_request)
print("The response of AccountsApi->disable_account:\n")
@@ -371,20 +369,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.accounts_api import AccountsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id.
try:
# Disable IDN Account for Identity
results =AccountsApi(api_client).disable_account_for_identity(id)
results = AccountsApi(api_client).disable_account_for_identity(id=id)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).disable_account_for_identity(id)
print("The response of AccountsApi->disable_account_for_identity:\n")
@@ -429,7 +427,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.accounts_api import AccountsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.bulk_identities_accounts_response import BulkIdentitiesAccountsResponse
@@ -438,16 +435,16 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identities_accounts_bulk_request = {
identities_accounts_bulk_request = '''{
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
} # IdentitiesAccountsBulkRequest |
}''' # IdentitiesAccountsBulkRequest |
try:
# Disable IDN Accounts for Identities
new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest()
new_identities_accounts_bulk_request.from_json(identities_accounts_bulk_request)
results =AccountsApi(api_client).disable_accounts_for_identities(new_identities_accounts_bulk_request)
new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest.from_json(identities_accounts_bulk_request)
results = AccountsApi(api_client).disable_accounts_for_identities(identities_accounts_bulk_request=new_identities_accounts_bulk_request)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).disable_accounts_for_identities(new_identities_accounts_bulk_request)
print("The response of AccountsApi->disable_accounts_for_identities:\n")
@@ -495,7 +492,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.accounts_api import AccountsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.account_toggle_request import AccountToggleRequest
@@ -504,18 +500,18 @@ 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 = {
account_toggle_request = '''{
"forceProvisioning" : false,
"externalVerificationId" : "3f9180835d2e5168015d32f890ca1581"
} # AccountToggleRequest |
}''' # AccountToggleRequest |
try:
# Enable Account
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)
new_account_toggle_request = AccountToggleRequest.from_json(account_toggle_request)
results = AccountsApi(api_client).enable_account(id=id, account_toggle_request=new_account_toggle_request)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).enable_account(id, new_account_toggle_request)
print("The response of AccountsApi->enable_account:\n")
@@ -561,20 +557,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.accounts_api import AccountsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id.
try:
# Enable IDN Account for Identity
results =AccountsApi(api_client).enable_account_for_identity(id)
results = AccountsApi(api_client).enable_account_for_identity(id=id)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).enable_account_for_identity(id)
print("The response of AccountsApi->enable_account_for_identity:\n")
@@ -619,7 +615,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.accounts_api import AccountsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.bulk_identities_accounts_response import BulkIdentitiesAccountsResponse
@@ -628,16 +623,16 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identities_accounts_bulk_request = {
identities_accounts_bulk_request = '''{
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
} # IdentitiesAccountsBulkRequest |
}''' # IdentitiesAccountsBulkRequest |
try:
# Enable IDN Accounts for Identities
new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest()
new_identities_accounts_bulk_request.from_json(identities_accounts_bulk_request)
results =AccountsApi(api_client).enable_accounts_for_identities(new_identities_accounts_bulk_request)
new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest.from_json(identities_accounts_bulk_request)
results = AccountsApi(api_client).enable_accounts_for_identities(identities_accounts_bulk_request=new_identities_accounts_bulk_request)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).enable_accounts_for_identities(new_identities_accounts_bulk_request)
print("The response of AccountsApi->enable_accounts_for_identities:\n")
@@ -684,7 +679,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.accounts_api import AccountsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.account import Account
@@ -692,13 +686,14 @@ 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
results =AccountsApi(api_client).get_account(id)
results = AccountsApi(api_client).get_account(id=id)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).get_account(id)
print("The response of AccountsApi->get_account:\n")
@@ -748,7 +743,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.accounts_api import AccountsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.entitlement import Entitlement
@@ -756,6 +750,7 @@ 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
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)
@@ -765,7 +760,7 @@ with ApiClient(configuration) as api_client:
try:
# Account Entitlements
results =AccountsApi(api_client).get_account_entitlements(id, )
results = AccountsApi(api_client).get_account_entitlements(id=id)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).get_account_entitlements(id, offset, limit, count)
print("The response of AccountsApi->get_account_entitlements:\n")
@@ -815,7 +810,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.accounts_api import AccountsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.account import Account
@@ -823,6 +817,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
detail_level = 'FULL' # str | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) # str | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` 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)
@@ -834,7 +829,7 @@ with ApiClient(configuration) as api_client:
try:
# Accounts List
results =AccountsApi(api_client).list_accounts()
results = AccountsApi(api_client).list_accounts()
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).list_accounts(detail_level, limit, offset, count, filters, sorters)
print("The response of AccountsApi->list_accounts:\n")
@@ -888,7 +883,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.accounts_api import AccountsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.account_attributes import AccountAttributes
@@ -897,9 +891,10 @@ 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 = {
account_attributes = '''{
"attributes" : {
"city" : "Austin",
"displayName" : "John Doe",
@@ -907,13 +902,12 @@ with ApiClient(configuration) as api_client:
"sAMAccountName" : "jDoe",
"mail" : "john.doe@sailpoint.com"
}
} # AccountAttributes |
}''' # AccountAttributes |
try:
# Update Account
new_account_attributes = AccountAttributes()
new_account_attributes.from_json(account_attributes)
results =AccountsApi(api_client).put_account(id, new_account_attributes)
new_account_attributes = AccountAttributes.from_json(account_attributes)
results = AccountsApi(api_client).put_account(id=id, account_attributes=new_account_attributes)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).put_account(id, new_account_attributes)
print("The response of AccountsApi->put_account:\n")
@@ -960,7 +954,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.accounts_api import AccountsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.accounts_async_result import AccountsAsyncResult
@@ -968,13 +961,14 @@ 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
results =AccountsApi(api_client).submit_reload_account(id)
results = AccountsApi(api_client).submit_reload_account(id=id)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).submit_reload_account(id)
print("The response of AccountsApi->submit_reload_account:\n")
@@ -1023,7 +1017,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.accounts_api import AccountsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.account_unlock_request import AccountUnlockRequest
@@ -1032,19 +1025,19 @@ 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 = {
account_unlock_request = '''{
"forceProvisioning" : false,
"externalVerificationId" : "3f9180835d2e5168015d32f890ca1581",
"unlockIDNAccount" : false
} # AccountUnlockRequest |
}''' # AccountUnlockRequest |
try:
# Unlock Account
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)
new_account_unlock_request = AccountUnlockRequest.from_json(account_unlock_request)
results = AccountsApi(api_client).unlock_account(id=id, account_unlock_request=new_account_unlock_request)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).unlock_account(id, new_account_unlock_request)
print("The response of AccountsApi->unlock_account:\n")
@@ -1102,24 +1095,21 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.accounts_api import AccountsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Account ID. # str | Account ID.
request_body = {Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}} # List[object] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
request_body = {Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}} # List[object] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
request_body = '''{Uncorrelate account={description=Remove account from Identity, value=[{op=remove, path=/identityId}]}, Reassign account={description=Move account from one Identity to another Identity, value=[{op=replace, path=/identityId, value=2c9180857725c14301772a93bb77242d}]}, Add account attribute={description=Add flat file account's attribute, value=[{op=add, path=/attributes/familyName, value=Smith}]}, Replace account attribute={description=Replace flat file account's attribute, value=[{op=replace, path=/attributes/familyName, value=Smith}]}, Remove account attribute={description=Remove flat file account's attribute, value=[{op=remove, path=/attributes/familyName}]}}''' # List[object] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
try:
# Update Account
new_request_body = RequestBody()
new_request_body.from_json(request_body)
results =AccountsApi(api_client).update_account(id, new_request_body)
new_request_body = RequestBody.from_json(request_body)
results = AccountsApi(api_client).update_account(id=id, request_body=new_request_body)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).update_account(id, new_request_body)
print("The response of AccountsApi->update_account:\n")

28
docs/tools/sdk/python/Reference/Beta/Methods/ApplicationDiscoveryApi.md
View File

@@ -57,20 +57,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.application_discovery_api import ApplicationDiscoveryApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '123e4567-e89b-12d3-a456-426655440000' # str | Discovered application's ID. # str | Discovered application's ID.
try:
# Get Discovered Application by ID
ApplicationDiscoveryApi(api_client).get_discovered_application_by_id(id)
ApplicationDiscoveryApi(api_client).get_discovered_application_by_id(id=id)
# Below is a request that includes all optional parameters
# ApplicationDiscoveryApi(api_client).get_discovered_application_by_id(id)
except Exception as e:
@@ -118,7 +118,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.application_discovery_api import ApplicationDiscoveryApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.get_discovered_applications200_response_inner import GetDiscoveredApplications200ResponseInner
@@ -126,6 +125,7 @@ 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)
@@ -136,7 +136,7 @@ with ApiClient(configuration) as api_client:
try:
# Retrieve discovered applications for tenant
results =ApplicationDiscoveryApi(api_client).get_discovered_applications()
results = ApplicationDiscoveryApi(api_client).get_discovered_applications()
# Below is a request that includes all optional parameters
# results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters)
print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n")
@@ -181,7 +181,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.application_discovery_api import ApplicationDiscoveryApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.manual_discover_applications_template import ManualDiscoverApplicationsTemplate
@@ -189,12 +188,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Download CSV Template for Discovery
results =ApplicationDiscoveryApi(api_client).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
# results = ApplicationDiscoveryApi(api_client).get_manual_discover_applications_csv_template()
print("The response of ApplicationDiscoveryApi->get_manual_discover_applications_csv_template:\n")
@@ -241,7 +241,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.application_discovery_api import ApplicationDiscoveryApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.json_patch_operations import JsonPatchOperations
@@ -249,20 +248,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '123e4567-e89b-12d3-a456-426655440000' # str | Discovered application's ID. # str | Discovered application's ID.
[{op=replace, path=/dismissed, value=true}] # List[JsonPatchOperations] | (optional)
json_patch_operations = {
"op" : "replace",
"path" : "/dismissed",
"value" : true
} # List[JsonPatchOperations] | (optional)
json_patch_operations = '''[{op=replace, path=/dismissed, value=true}]''' # List[JsonPatchOperations] | (optional)
try:
# Patch Discovered Application by ID
ApplicationDiscoveryApi(api_client).patch_discovered_application_by_id(id, )
ApplicationDiscoveryApi(api_client).patch_discovered_application_by_id(id=id)
# Below is a request that includes all optional parameters
# ApplicationDiscoveryApi(api_client).patch_discovered_application_by_id(id, new_json_patch_operations)
except Exception as e:
@@ -306,20 +300,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.application_discovery_api import ApplicationDiscoveryApi
from sailpoint.beta.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
ApplicationDiscoveryApi(api_client).send_manual_discover_applications_csv_template(file)
ApplicationDiscoveryApi(api_client).send_manual_discover_applications_csv_template(file=file)
# Below is a request that includes all optional parameters
# ApplicationDiscoveryApi(api_client).send_manual_discover_applications_csv_template(file)
except Exception as e:

8
docs/tools/sdk/python/Reference/Beta/Methods/ApprovalsApi.md
View File

@@ -54,7 +54,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.approvals_api import ApprovalsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.approval import Approval
@@ -62,13 +61,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '38453251-6be2-5f8f-df93-5ce19e295837' # str | ID of the approval that to be returned. # str | ID of the approval that to be returned.
try:
# Get Approval
results =ApprovalsApi(api_client).get_approval(id)
results = ApprovalsApi(api_client).get_approval(id=id)
# Below is a request that includes all optional parameters
# results = ApprovalsApi(api_client).get_approval(id)
print("The response of ApprovalsApi->get_approval:\n")
@@ -116,7 +116,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.approvals_api import ApprovalsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.approval import Approval
@@ -124,6 +123,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
mine = true # bool | Returns the list of approvals for the current caller. (optional) # bool | Returns the list of approvals for the current caller. (optional)
requester_id = '17e633e7d57e481569df76323169deb6a' # str | Returns the list of approvals for a given requester ID. (optional) # str | Returns the list of approvals for a given requester ID. (optional)
@@ -132,7 +132,7 @@ with ApiClient(configuration) as api_client:
try:
# Get Approvals
results =ApprovalsApi(api_client).get_approvals()
results = ApprovalsApi(api_client).get_approvals()
# Below is a request that includes all optional parameters
# results = ApprovalsApi(api_client).get_approvals(mine, requester_id, filters)
print("The response of ApprovalsApi->get_approvals:\n")

88
docs/tools/sdk/python/Reference/Beta/Methods/AppsApi.md
View File

@@ -65,7 +65,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.source_app import SourceApp
@@ -74,8 +73,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_app_create_dto = {
source_app_create_dto = '''{
"name" : "my app",
"description" : "the source app for engineers",
"accountSource" : {
@@ -84,13 +84,12 @@ with ApiClient(configuration) as api_client:
"type" : "SOURCE"
},
"matchAllAccounts" : true
} # SourceAppCreateDto |
}''' # SourceAppCreateDto |
try:
# Create source app
new_source_app_create_dto = SourceAppCreateDto()
new_source_app_create_dto.from_json(source_app_create_dto)
results =AppsApi(api_client).create_source_app(new_source_app_create_dto)
new_source_app_create_dto = SourceAppCreateDto.from_json(source_app_create_dto)
results = AppsApi(api_client).create_source_app(source_app_create_dto=new_source_app_create_dto)
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).create_source_app(new_source_app_create_dto)
print("The response of AppsApi->create_source_app:\n")
@@ -137,7 +136,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.access_profile_details import AccessProfileDetails
@@ -145,18 +143,16 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app
request_body = ['request_body_example'] # List[str] |
request_body = ['request_body_example'] # List[str] |
request_body = '''['request_body_example']''' # List[str] |
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)
try:
# Bulk remove access profiles from the specified source app
new_request_body = RequestBody()
new_request_body.from_json(request_body)
results =AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id, new_request_body, )
new_request_body = RequestBody.from_json(request_body)
results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id=id, request_body=new_request_body)
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id, new_request_body, limit)
print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n")
@@ -201,7 +197,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.source_app import SourceApp
@@ -209,13 +204,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | source app ID. # str | source app ID.
try:
# Delete source app by ID
results =AppsApi(api_client).delete_source_app(id)
results = AppsApi(api_client).delete_source_app(id=id)
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).delete_source_app(id)
print("The response of AppsApi->delete_source_app:\n")
@@ -261,7 +257,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.source_app import SourceApp
@@ -269,13 +264,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app
try:
# Get source app by ID
results =AppsApi(api_client).get_source_app(id)
results = AppsApi(api_client).get_source_app(id=id)
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).get_source_app(id)
print("The response of AppsApi->get_source_app:\n")
@@ -323,7 +319,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.access_profile_details import AccessProfileDetails
@@ -331,6 +326,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app
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)
@@ -340,7 +336,7 @@ with ApiClient(configuration) as api_client:
try:
# List access profiles for the specified source app
results =AppsApi(api_client).list_access_profiles_for_source_app(id, )
results = AppsApi(api_client).list_access_profiles_for_source_app(id=id)
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).list_access_profiles_for_source_app(id, limit, offset, filters)
print("The response of AppsApi->list_access_profiles_for_source_app:\n")
@@ -391,7 +387,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.source_app import SourceApp
@@ -399,6 +394,7 @@ 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)
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)
@@ -409,7 +405,7 @@ with ApiClient(configuration) as api_client:
try:
# List all source apps
results =AppsApi(api_client).list_all_source_app()
results = AppsApi(api_client).list_all_source_app()
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).list_all_source_app(limit, count, offset, sorters, filters)
print("The response of AppsApi->list_all_source_app:\n")
@@ -458,7 +454,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.user_app import UserApp
@@ -466,6 +461,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
filters = 'name eq \"user app name\"' # 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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* # 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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq*
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)
@@ -475,7 +471,7 @@ with ApiClient(configuration) as api_client:
try:
# List all user apps
results =AppsApi(api_client).list_all_user_apps(filters, )
results = AppsApi(api_client).list_all_user_apps(filters=filters)
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).list_all_user_apps(filters, limit, count, offset)
print("The response of AppsApi->list_all_user_apps:\n")
@@ -524,7 +520,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.source_app import SourceApp
@@ -532,6 +527,7 @@ 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)
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)
@@ -542,7 +538,7 @@ with ApiClient(configuration) as api_client:
try:
# List assigned source apps
results =AppsApi(api_client).list_assigned_source_app()
results = AppsApi(api_client).list_assigned_source_app()
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).list_assigned_source_app(limit, count, offset, sorters, filters)
print("The response of AppsApi->list_assigned_source_app:\n")
@@ -590,7 +586,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.app_account_details import AppAccountDetails
@@ -598,6 +593,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the user app # str | ID of the user app
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)
@@ -607,7 +603,7 @@ with ApiClient(configuration) as api_client:
try:
# List available accounts for user app
results =AppsApi(api_client).list_available_accounts_for_user_app(id, )
results = AppsApi(api_client).list_available_accounts_for_user_app(id=id)
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).list_available_accounts_for_user_app(id, limit, count, offset)
print("The response of AppsApi->list_available_accounts_for_user_app:\n")
@@ -656,7 +652,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.source_app import SourceApp
@@ -664,6 +659,7 @@ 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)
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)
@@ -674,7 +670,7 @@ with ApiClient(configuration) as api_client:
try:
# List available source apps
results =AppsApi(api_client).list_available_source_apps()
results = AppsApi(api_client).list_available_source_apps()
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).list_available_source_apps(limit, count, offset, sorters, filters)
print("The response of AppsApi->list_available_source_apps:\n")
@@ -722,7 +718,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.user_app import UserApp
@@ -730,6 +725,7 @@ 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)
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)
@@ -739,7 +735,7 @@ with ApiClient(configuration) as api_client:
try:
# List owned user apps
results =AppsApi(api_client).list_owned_user_apps()
results = AppsApi(api_client).list_owned_user_apps()
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).list_owned_user_apps(limit, count, offset, filters)
print("The response of AppsApi->list_owned_user_apps:\n")
@@ -788,7 +784,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.json_patch_operation import JsonPatchOperation
@@ -797,20 +792,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the source app to patch # str | ID of the source app to patch
[{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}] # List[JsonPatchOperation] | (optional)
json_patch_operation = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] | (optional)
json_patch_operation = '''[{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}]''' # List[JsonPatchOperation] | (optional)
try:
# Patch source app by ID
results =AppsApi(api_client).patch_source_app(id, )
results = AppsApi(api_client).patch_source_app(id=id)
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).patch_source_app(id, new_json_patch_operation)
print("The response of AppsApi->patch_source_app:\n")
@@ -858,7 +848,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.json_patch_operation import JsonPatchOperation
@@ -867,20 +856,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the user app to patch # str | ID of the user app to patch
[sailpoint.beta.JsonPatchOperation()] # List[JsonPatchOperation] | (optional)
json_patch_operation = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] | (optional)
json_patch_operation = '''[sailpoint.beta.JsonPatchOperation()]''' # List[JsonPatchOperation] | (optional)
try:
# Patch user app by ID
results =AppsApi(api_client).patch_user_app(id, )
results = AppsApi(api_client).patch_user_app(id=id)
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).patch_user_app(id, new_json_patch_operation)
print("The response of AppsApi->patch_user_app:\n")
@@ -928,7 +912,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.apps_api import AppsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.source_app_bulk_update_request import SourceAppBulkUpdateRequest
@@ -936,8 +919,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_app_bulk_update_request = {
source_app_bulk_update_request = '''{
"appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ],
"jsonPatch" : [ {
"op" : "replace",
@@ -948,7 +932,7 @@ with ApiClient(configuration) as api_client:
"path" : "/matchAllAccounts",
"value" : false
} ]
} # SourceAppBulkUpdateRequest | (optional)
}''' # SourceAppBulkUpdateRequest | (optional)
try:
# Bulk update source apps

23
docs/tools/sdk/python/Reference/Beta/Methods/AuthProfileApi.md
View File

@@ -59,7 +59,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.auth_profile_api import AuthProfileApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.auth_profile import AuthProfile
@@ -67,13 +66,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to get. # str | ID of the Auth Profile to get.
try:
# Get Auth Profile.
results =AuthProfileApi(api_client).get_profile_config(id)
results = AuthProfileApi(api_client).get_profile_config(id=id)
# Below is a request that includes all optional parameters
# results = AuthProfileApi(api_client).get_profile_config(id)
print("The response of AuthProfileApi->get_profile_config:\n")
@@ -115,7 +115,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.auth_profile_api import AuthProfileApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.auth_profile_summary import AuthProfileSummary
@@ -123,12 +122,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get list of Auth Profiles.
results =AuthProfileApi(api_client).get_profile_config_list()
results = AuthProfileApi(api_client).get_profile_config_list()
# Below is a request that includes all optional parameters
# results = AuthProfileApi(api_client).get_profile_config_list()
print("The response of AuthProfileApi->get_profile_config_list:\n")
@@ -175,7 +175,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.auth_profile_api import AuthProfileApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.auth_profile import AuthProfile
@@ -184,21 +183,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch.
[sailpoint.beta.JsonPatchOperation()] # List[JsonPatchOperation] |
json_patch_operation = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] |
json_patch_operation = '''[sailpoint.beta.JsonPatchOperation()]''' # List[JsonPatchOperation] |
try:
# Patch a specified Auth Profile
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =AuthProfileApi(api_client).patch_profile_config(id, new_json_patch_operation)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = AuthProfileApi(api_client).patch_profile_config(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = AuthProfileApi(api_client).patch_profile_config(id, new_json_patch_operation)
print("The response of AuthProfileApi->patch_profile_config:\n")

153
docs/tools/sdk/python/Reference/Beta/Methods/CertificationCampaignsApi.md
View File

@@ -153,7 +153,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.complete_campaign_options import CompleteCampaignOptions
@@ -161,16 +160,17 @@ 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.
complete_campaign_options = {
complete_campaign_options = '''{
"autoCompleteAction" : "REVOKE"
} # CompleteCampaignOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional)
}''' # CompleteCampaignOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional)
try:
# Complete a Campaign
results =CertificationCampaignsApi(api_client).complete_campaign(id, )
results = CertificationCampaignsApi(api_client).complete_campaign(id=id)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).complete_campaign(id, new_complete_campaign_options)
print("The response of CertificationCampaignsApi->complete_campaign:\n")
@@ -221,7 +221,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.campaign import Campaign
@@ -229,8 +228,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
campaign = {
campaign = '''{
"totalCertifications" : 100,
"sourcesWithOrphanEntitlements" : [ {
"name" : "Source with orphan entitlements",
@@ -338,13 +338,12 @@ with ApiClient(configuration) as api_client:
"deadline" : "2020-03-15T10:00:01.456Z",
"status" : "ACTIVE",
"correlatedStatus" : "CORRELATED"
} # Campaign |
}''' # Campaign |
try:
# Create Campaign
new_campaign = Campaign()
new_campaign.from_json(campaign)
results =CertificationCampaignsApi(api_client).create_campaign(new_campaign)
new_campaign = Campaign.from_json(campaign)
results = CertificationCampaignsApi(api_client).create_campaign(campaign=new_campaign)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).create_campaign(new_campaign)
print("The response of CertificationCampaignsApi->create_campaign:\n")
@@ -395,7 +394,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.campaign_template import CampaignTemplate
@@ -403,8 +401,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
campaign_template = {
campaign_template = '''{
"ownerRef" : {
"name" : "Mister Manager",
"id" : "2c918086676d3e0601677611dbde220f",
@@ -527,13 +526,12 @@ with ApiClient(configuration) as api_client:
"correlatedStatus" : "CORRELATED"
},
"id" : "2c9079b270a266a60170a277bb960008"
} # CampaignTemplate |
}''' # CampaignTemplate |
try:
# Create a Campaign Template
new_campaign_template = CampaignTemplate()
new_campaign_template.from_json(campaign_template)
results =CertificationCampaignsApi(api_client).create_campaign_template(new_campaign_template)
new_campaign_template = CampaignTemplate.from_json(campaign_template)
results = CertificationCampaignsApi(api_client).create_campaign_template(campaign_template=new_campaign_template)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).create_campaign_template(new_campaign_template)
print("The response of CertificationCampaignsApi->create_campaign_template:\n")
@@ -585,20 +583,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | ID of the campaign template being deleted. # str | ID of the campaign template being deleted.
try:
# Delete a Campaign Template
CertificationCampaignsApi(api_client).delete_campaign_template(id)
CertificationCampaignsApi(api_client).delete_campaign_template(id=id)
# Below is a request that includes all optional parameters
# CertificationCampaignsApi(api_client).delete_campaign_template(id)
except Exception as e:
@@ -648,20 +646,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '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
CertificationCampaignsApi(api_client).delete_campaign_template_schedule(id)
CertificationCampaignsApi(api_client).delete_campaign_template_schedule(id=id)
# Below is a request that includes all optional parameters
# CertificationCampaignsApi(api_client).delete_campaign_template_schedule(id)
except Exception as e:
@@ -711,7 +709,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.delete_campaigns_request import DeleteCampaignsRequest
@@ -719,16 +716,16 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
delete_campaigns_request = {
delete_campaigns_request = '''{
"ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ]
} # DeleteCampaignsRequest | IDs of the campaigns to delete.
}''' # DeleteCampaignsRequest | IDs of the campaigns to delete.
try:
# Delete Campaigns
new_delete_campaigns_request = DeleteCampaignsRequest()
new_delete_campaigns_request.from_json(delete_campaigns_request)
results =CertificationCampaignsApi(api_client).delete_campaigns(new_delete_campaigns_request)
new_delete_campaigns_request = DeleteCampaignsRequest.from_json(delete_campaigns_request)
results = CertificationCampaignsApi(api_client).delete_campaigns(delete_campaigns_request=new_delete_campaigns_request)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).delete_campaigns(new_delete_campaigns_request)
print("The response of CertificationCampaignsApi->delete_campaigns:\n")
@@ -784,7 +781,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner
@@ -792,6 +788,7 @@ 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)
@@ -803,7 +800,7 @@ with ApiClient(configuration) as api_client:
try:
# List Campaigns
results =CertificationCampaignsApi(api_client).get_active_campaigns()
results = CertificationCampaignsApi(api_client).get_active_campaigns()
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters)
print("The response of CertificationCampaignsApi->get_active_campaigns:\n")
@@ -855,7 +852,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.slimcampaign import Slimcampaign
@@ -863,13 +859,14 @@ 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.
try:
# Get Campaign
results =CertificationCampaignsApi(api_client).get_campaign(id)
results = CertificationCampaignsApi(api_client).get_campaign(id=id)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).get_campaign(id)
print("The response of CertificationCampaignsApi->get_campaign:\n")
@@ -921,7 +918,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.campaign_report import CampaignReport
@@ -929,13 +925,14 @@ 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
results =CertificationCampaignsApi(api_client).get_campaign_reports(id)
results = CertificationCampaignsApi(api_client).get_campaign_reports(id=id)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).get_campaign_reports(id)
print("The response of CertificationCampaignsApi->get_campaign_reports:\n")
@@ -983,7 +980,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.campaign_reports_config import CampaignReportsConfig
@@ -991,12 +987,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Campaign Reports Configuration
results =CertificationCampaignsApi(api_client).get_campaign_reports_config()
results = CertificationCampaignsApi(api_client).get_campaign_reports_config()
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).get_campaign_reports_config()
print("The response of CertificationCampaignsApi->get_campaign_reports_config:\n")
@@ -1048,7 +1045,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.campaign_template import CampaignTemplate
@@ -1056,13 +1052,14 @@ 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
results =CertificationCampaignsApi(api_client).get_campaign_template(id)
results = CertificationCampaignsApi(api_client).get_campaign_template(id=id)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).get_campaign_template(id)
print("The response of CertificationCampaignsApi->get_campaign_template:\n")
@@ -1114,7 +1111,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.schedule import Schedule
@@ -1122,13 +1118,14 @@ 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
results =CertificationCampaignsApi(api_client).get_campaign_template_schedule(id)
results = CertificationCampaignsApi(api_client).get_campaign_template_schedule(id=id)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).get_campaign_template_schedule(id)
print("The response of CertificationCampaignsApi->get_campaign_template_schedule:\n")
@@ -1185,7 +1182,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.campaign_template import CampaignTemplate
@@ -1193,6 +1189,7 @@ 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)
@@ -1203,7 +1200,7 @@ with ApiClient(configuration) as api_client:
try:
# List Campaign Templates
results =CertificationCampaignsApi(api_client).get_campaign_templates()
results = CertificationCampaignsApi(api_client).get_campaign_templates()
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters)
print("The response of CertificationCampaignsApi->get_campaign_templates:\n")
@@ -1256,7 +1253,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.admin_review_reassign import AdminReviewReassign
@@ -1265,22 +1261,22 @@ 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 = {
admin_review_reassign = '''{
"certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ],
"reason" : "reassigned for some reason",
"reassignTo" : {
"id" : "ef38f94347e94562b5bb8424a56397d8",
"type" : "IDENTITY"
}
} # AdminReviewReassign |
}''' # AdminReviewReassign |
try:
# Reassign Certifications
new_admin_review_reassign = AdminReviewReassign()
new_admin_review_reassign.from_json(admin_review_reassign)
results =CertificationCampaignsApi(api_client).move(id, new_admin_review_reassign)
new_admin_review_reassign = AdminReviewReassign.from_json(admin_review_reassign)
results = CertificationCampaignsApi(api_client).move(id=id, admin_review_reassign=new_admin_review_reassign)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).move(id, new_admin_review_reassign)
print("The response of CertificationCampaignsApi->move:\n")
@@ -1333,7 +1329,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.campaign_template import CampaignTemplate
@@ -1342,21 +1337,15 @@ 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 = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # 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 = '''[{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)
try:
# Update a Campaign Template
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)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = CertificationCampaignsApi(api_client).patch_campaign_template(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).patch_campaign_template(id, new_json_patch_operation)
print("The response of CertificationCampaignsApi->patch_campaign_template:\n")
@@ -1407,7 +1396,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.campaign_reports_config import CampaignReportsConfig
@@ -1415,16 +1403,16 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
campaign_reports_config = {
campaign_reports_config = '''{
"identityAttributeColumns" : [ "firstname", "lastname" ]
} # CampaignReportsConfig | Campaign report configuration.
}''' # CampaignReportsConfig | Campaign report configuration.
try:
# Set Campaign Reports Configuration
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)
new_campaign_reports_config = CampaignReportsConfig.from_json(campaign_reports_config)
results = CertificationCampaignsApi(api_client).set_campaign_reports_config(campaign_reports_config=new_campaign_reports_config)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).set_campaign_reports_config(new_campaign_reports_config)
print("The response of CertificationCampaignsApi->set_campaign_reports_config:\n")
@@ -1478,7 +1466,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.schedule import Schedule
@@ -1486,9 +1473,10 @@ 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 = {
schedule = '''{
"hours" : {
"values" : [ "1" ],
"interval" : 2,
@@ -1507,12 +1495,12 @@ with ApiClient(configuration) as api_client:
},
"expiration" : "2000-01-23T04:56:07.000+00:00",
"type" : "WEEKLY"
} # Schedule | (optional)
}''' # Schedule | (optional)
try:
# Set Campaign Template Schedule
CertificationCampaignsApi(api_client).set_campaign_template_schedule(id, )
CertificationCampaignsApi(api_client).set_campaign_template_schedule(id=id)
# Below is a request that includes all optional parameters
# CertificationCampaignsApi(api_client).set_campaign_template_schedule(id, new_schedule)
except Exception as e:
@@ -1563,7 +1551,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.activate_campaign_options import ActivateCampaignOptions
@@ -1571,16 +1558,17 @@ 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 = {
activate_campaign_options = '''{
"timeZone" : "-05:00"
} # ActivateCampaignOptions | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. (optional)
}''' # ActivateCampaignOptions | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. (optional)
try:
# Activate a Campaign
results =CertificationCampaignsApi(api_client).start_campaign(id, )
results = CertificationCampaignsApi(api_client).start_campaign(id=id)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).start_campaign(id, new_activate_campaign_options)
print("The response of CertificationCampaignsApi->start_campaign:\n")
@@ -1632,20 +1620,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '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
results =CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id)
results = CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id=id)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id)
print("The response of CertificationCampaignsApi->start_campaign_remediation_scan:\n")
@@ -1698,7 +1686,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.report_type import ReportType
@@ -1706,6 +1693,7 @@ 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.beta.ReportType() # ReportType | Type of report to run. # ReportType | Type of report to run.
@@ -1713,7 +1701,7 @@ with ApiClient(configuration) as api_client:
try:
# Run Campaign Report
results =CertificationCampaignsApi(api_client).start_campaign_report(id, type)
results = CertificationCampaignsApi(api_client).start_campaign_report(id=id, type=type)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).start_campaign_report(id, type)
print("The response of CertificationCampaignsApi->start_campaign_report:\n")
@@ -1776,7 +1764,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.campaign_reference import CampaignReference
@@ -1784,13 +1771,14 @@ 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
results =CertificationCampaignsApi(api_client).start_generate_campaign_template(id)
results = CertificationCampaignsApi(api_client).start_generate_campaign_template(id=id)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).start_generate_campaign_template(id)
print("The response of CertificationCampaignsApi->start_generate_campaign_template:\n")
@@ -1843,7 +1831,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.slimcampaign import Slimcampaign
@@ -1851,17 +1838,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808571bcfcf80171c23e4b4221fc' # str | ID of the campaign being modified. # str | ID of the campaign being modified.
request_body = [{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}] # List[object] | 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
request_body = [{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}] # List[object] | 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
request_body = '''[{op=replace, path=/name, value=This field has been updated!}, {op=copy, from=/name, path=/description}]''' # List[object] | 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
try:
# Update a Campaign
new_request_body = RequestBody()
new_request_body.from_json(request_body)
results =CertificationCampaignsApi(api_client).update_campaign(id, new_request_body)
new_request_body = RequestBody.from_json(request_body)
results = CertificationCampaignsApi(api_client).update_campaign(id=id, request_body=new_request_body)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).update_campaign(id, new_request_body)
print("The response of CertificationCampaignsApi->update_campaign:\n")

31
docs/tools/sdk/python/Reference/Beta/Methods/CertificationsApi.md
View File

@@ -79,7 +79,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certifications_api import CertificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.permission_dto import PermissionDto
@@ -87,6 +86,7 @@ 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
@@ -98,7 +98,7 @@ with ApiClient(configuration) as api_client:
try:
# Permissions for Entitlement Certification Item
results =CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id, item_id, )
results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id=certification_id, item_id=item_id)
# Below is a request that includes all optional parameters
# 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")
@@ -144,7 +144,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certifications_api import CertificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_certification_task import IdentityCertificationTask
@@ -152,13 +151,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'id_example' # str | The identity campaign certification ID # str | The identity campaign certification ID
try:
# Pending Certification Tasks
results =CertificationsApi(api_client).get_identity_certification_pending_tasks(id)
results = CertificationsApi(api_client).get_identity_certification_pending_tasks(id=id)
# Below is a request that includes all optional parameters
# results = CertificationsApi(api_client).get_identity_certification_pending_tasks(id)
print("The response of CertificationsApi->get_identity_certification_pending_tasks:\n")
@@ -205,7 +205,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certifications_api import CertificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_certification_task import IdentityCertificationTask
@@ -213,6 +212,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'id_example' # str | The identity campaign certification ID # str | The identity campaign certification ID
task_id = 'task_id_example' # str | The certification task ID # str | The certification task ID
@@ -220,7 +220,7 @@ with ApiClient(configuration) as api_client:
try:
# Certification Task Status
results =CertificationsApi(api_client).get_identity_certification_task_status(id, task_id)
results = CertificationsApi(api_client).get_identity_certification_task_status(id=id, task_id=task_id)
# Below is a request that includes all optional parameters
# results = CertificationsApi(api_client).get_identity_certification_task_status(id, task_id)
print("The response of CertificationsApi->get_identity_certification_task_status:\n")
@@ -274,7 +274,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certifications_api import CertificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_reference_with_name_and_email import IdentityReferenceWithNameAndEmail
@@ -282,6 +281,7 @@ 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)
@@ -293,7 +293,7 @@ with ApiClient(configuration) as api_client:
try:
# List of Reviewers for certification
results =CertificationsApi(api_client).list_certification_reviewers(id, )
results = CertificationsApi(api_client).list_certification_reviewers(id=id)
# Below is a request that includes all optional parameters
# results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters)
print("The response of CertificationsApi->list_certification_reviewers:\n")
@@ -343,7 +343,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certifications_api import CertificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.certification_dto import CertificationDto
@@ -351,6 +350,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
reviewer_identitiy = 'reviewer_identitiy_example' # 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)
@@ -362,7 +362,7 @@ with ApiClient(configuration) as api_client:
try:
# Certifications by IDs
results =CertificationsApi(api_client).list_certifications()
results = CertificationsApi(api_client).list_certifications()
# Below is a request that includes all optional parameters
# results = CertificationsApi(api_client).list_certifications(reviewer_identitiy, limit, offset, count, filters, sorters)
print("The response of CertificationsApi->list_certifications:\n")
@@ -412,7 +412,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certifications_api import CertificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_certification_task import IdentityCertificationTask
@@ -421,9 +420,10 @@ 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 = {
review_reassign = '''{
"reason" : "reassigned for some reason",
"reassignTo" : "ef38f94347e94562b5bb8424a56397d8",
"reassign" : [ {
@@ -433,13 +433,12 @@ with ApiClient(configuration) as api_client:
"id" : "ef38f94347e94562b5bb8424a56397d8",
"type" : "ITEM"
} ]
} # ReviewReassign |
}''' # ReviewReassign |
try:
# Reassign Certifications Asynchronously
new_review_reassign = ReviewReassign()
new_review_reassign.from_json(review_reassign)
results =CertificationsApi(api_client).submit_reassign_certs_async(id, new_review_reassign)
new_review_reassign = ReviewReassign.from_json(review_reassign)
results = CertificationsApi(api_client).submit_reassign_certs_async(id=id, review_reassign=new_review_reassign)
# Below is a request that includes all optional parameters
# results = CertificationsApi(api_client).submit_reassign_certs_async(id, new_review_reassign)
print("The response of CertificationsApi->submit_reassign_certs_async:\n")

42
docs/tools/sdk/python/Reference/Beta/Methods/ConnectorRuleManagementApi.md
View File

@@ -62,7 +62,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.connector_rule_management_api import ConnectorRuleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.connector_rule_create_request import ConnectorRuleCreateRequest
@@ -71,8 +70,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
connector_rule_create_request = {
connector_rule_create_request = '''{
"sourceCode" : {
"version" : "1.0",
"script" : "return \"Mr. \" + firstName;"
@@ -97,13 +97,12 @@ with ApiClient(configuration) as api_client:
"description" : "This rule does that",
"attributes" : { },
"type" : "BuildMap"
} # ConnectorRuleCreateRequest | The connector rule to create
}''' # ConnectorRuleCreateRequest | The connector rule to create
try:
# Create Connector Rule
new_connector_rule_create_request = ConnectorRuleCreateRequest()
new_connector_rule_create_request.from_json(connector_rule_create_request)
results =ConnectorRuleManagementApi(api_client).create_connector_rule(new_connector_rule_create_request)
new_connector_rule_create_request = ConnectorRuleCreateRequest.from_json(connector_rule_create_request)
results = ConnectorRuleManagementApi(api_client).create_connector_rule(connector_rule_create_request=new_connector_rule_create_request)
# Below is a request that includes all optional parameters
# results = ConnectorRuleManagementApi(api_client).create_connector_rule(new_connector_rule_create_request)
print("The response of ConnectorRuleManagementApi->create_connector_rule:\n")
@@ -150,20 +149,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.connector_rule_management_api import ConnectorRuleManagementApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to delete # str | ID of the connector rule to delete
try:
# Delete a Connector-Rule
ConnectorRuleManagementApi(api_client).delete_connector_rule(id)
ConnectorRuleManagementApi(api_client).delete_connector_rule(id=id)
# Below is a request that includes all optional parameters
# ConnectorRuleManagementApi(api_client).delete_connector_rule(id)
except Exception as e:
@@ -208,7 +207,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.connector_rule_management_api import ConnectorRuleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.connector_rule_response import ConnectorRuleResponse
@@ -216,13 +214,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to retrieve # str | ID of the connector rule to retrieve
try:
# Connector-Rule by ID
results =ConnectorRuleManagementApi(api_client).get_connector_rule(id)
results = ConnectorRuleManagementApi(api_client).get_connector_rule(id=id)
# Below is a request that includes all optional parameters
# results = ConnectorRuleManagementApi(api_client).get_connector_rule(id)
print("The response of ConnectorRuleManagementApi->get_connector_rule:\n")
@@ -265,7 +264,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.connector_rule_management_api import ConnectorRuleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.connector_rule_response import ConnectorRuleResponse
@@ -273,12 +271,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Connector Rules
results =ConnectorRuleManagementApi(api_client).get_connector_rule_list()
results = ConnectorRuleManagementApi(api_client).get_connector_rule_list()
# Below is a request that includes all optional parameters
# results = ConnectorRuleManagementApi(api_client).get_connector_rule_list()
print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n")
@@ -326,7 +325,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.connector_rule_management_api import ConnectorRuleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.connector_rule_response import ConnectorRuleResponse
@@ -335,9 +333,10 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to update # str | ID of the connector rule to update
connector_rule_update_request = {
connector_rule_update_request = '''{
"sourceCode" : {
"version" : "1.0",
"script" : "return \"Mr. \" + firstName;"
@@ -363,12 +362,12 @@ with ApiClient(configuration) as api_client:
"attributes" : { },
"id" : "8113d48c0b914f17b4c6072d4dcb9dfe",
"type" : "BuildMap"
} # ConnectorRuleUpdateRequest | The connector rule with updated data (optional)
}''' # ConnectorRuleUpdateRequest | The connector rule with updated data (optional)
try:
# Update a Connector Rule
results =ConnectorRuleManagementApi(api_client).update_connector_rule(id, )
results = ConnectorRuleManagementApi(api_client).update_connector_rule(id=id)
# Below is a request that includes all optional parameters
# results = ConnectorRuleManagementApi(api_client).update_connector_rule(id, new_connector_rule_update_request)
print("The response of ConnectorRuleManagementApi->update_connector_rule:\n")
@@ -414,7 +413,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.connector_rule_management_api import ConnectorRuleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.connector_rule_validation_response import ConnectorRuleValidationResponse
@@ -423,17 +421,17 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_code = {
source_code = '''{
"version" : "1.0",
"script" : "return \"Mr. \" + firstName;"
} # SourceCode | The code to validate
}''' # SourceCode | The code to validate
try:
# Validate Connector Rule
new_source_code = SourceCode()
new_source_code.from_json(source_code)
results =ConnectorRuleManagementApi(api_client).validate_connector_rule(new_source_code)
new_source_code = SourceCode.from_json(source_code)
results = ConnectorRuleManagementApi(api_client).validate_connector_rule(source_code=new_source_code)
# Below is a request that includes all optional parameters
# results = ConnectorRuleManagementApi(api_client).validate_connector_rule(new_source_code)
print("The response of ConnectorRuleManagementApi->validate_connector_rule:\n")

4
docs/tools/sdk/python/Reference/Beta/Methods/ConnectorsApi.md
View File

@@ -69,7 +69,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.connectors_api import ConnectorsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.v3_connector_dto import V3ConnectorDto
@@ -77,6 +76,7 @@ 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* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *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* **type**: *eq* **directConnect**: *eq* **category**: *eq* **features**: *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)
@@ -87,7 +87,7 @@ with ApiClient(configuration) as api_client:
try:
# Get Connector List
results =ConnectorsApi(api_client).get_connector_list()
results = ConnectorsApi(api_client).get_connector_list()
# Below is a request that includes all optional parameters
# results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale)
print("The response of ConnectorsApi->get_connector_list:\n")

108
docs/tools/sdk/python/Reference/Beta/Methods/CustomFormsApi.md
View File

@@ -76,7 +76,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.create_form_definition_request import CreateFormDefinitionRequest
@@ -85,8 +84,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
create_form_definition_request = {
create_form_definition_request = '''{
"owner" : {
"name" : "Grant Smith",
"id" : "2c9180867624cbd7017642d8c8c81f67",
@@ -196,12 +196,12 @@ with ApiClient(configuration) as api_client:
},
"key" : "department"
} ]
} # CreateFormDefinitionRequest | Body is the request payload to create form definition request (optional)
}''' # CreateFormDefinitionRequest | Body is the request payload to create form definition request (optional)
try:
# Creates a form definition.
results =CustomFormsApi(api_client).create_form_definition()
results = CustomFormsApi(api_client).create_form_definition()
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).create_form_definition(new_create_form_definition_request)
print("The response of CustomFormsApi->create_form_definition:\n")
@@ -246,7 +246,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.create_form_definition_request import CreateFormDefinitionRequest
@@ -255,8 +254,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
create_form_definition_request = {
create_form_definition_request = '''{
"owner" : {
"name" : "Grant Smith",
"id" : "2c9180867624cbd7017642d8c8c81f67",
@@ -366,12 +366,12 @@ with ApiClient(configuration) as api_client:
},
"key" : "department"
} ]
} # CreateFormDefinitionRequest | Body is the request payload to create form definition request (optional)
}''' # CreateFormDefinitionRequest | Body is the request payload to create form definition request (optional)
try:
# Create a form definition by template.
results =CustomFormsApi(api_client).create_form_definition_by_template()
results = CustomFormsApi(api_client).create_form_definition_by_template()
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).create_form_definition_by_template(new_create_form_definition_request)
print("The response of CustomFormsApi->create_form_definition_by_template:\n")
@@ -417,7 +417,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.form_definition_dynamic_schema_request import FormDefinitionDynamicSchemaRequest
@@ -426,8 +425,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
body = {
body = '''{
"description" : "A description",
"attributes" : {
"formDefinitionId" : "00000000-0000-0000-0000-000000000000"
@@ -435,12 +435,12 @@ with ApiClient(configuration) as api_client:
"id" : "00000000-0000-0000-0000-000000000000",
"type" : "action",
"versionNumber" : 1
} # FormDefinitionDynamicSchemaRequest | Body is the request payload to create a form definition dynamic schema (optional)
}''' # FormDefinitionDynamicSchemaRequest | Body is the request payload to create a form definition dynamic schema (optional)
try:
# Generate JSON Schema dynamically.
results =CustomFormsApi(api_client).create_form_definition_dynamic_schema()
results = CustomFormsApi(api_client).create_form_definition_dynamic_schema()
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).create_form_definition_dynamic_schema(new_body)
print("The response of CustomFormsApi->create_form_definition_dynamic_schema:\n")
@@ -490,7 +490,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.form_definition_file_upload_response import FormDefinitionFileUploadResponse
@@ -498,6 +497,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_definition_id = '00000000-0000-0000-0000-000000000000' # str | FormDefinitionID String specifying FormDefinitionID # str | FormDefinitionID String specifying FormDefinitionID
file = None # bytearray | File specifying the multipart # bytearray | File specifying the multipart
@@ -505,7 +505,7 @@ with ApiClient(configuration) as api_client:
try:
# Upload new form definition file.
results =CustomFormsApi(api_client).create_form_definition_file_request(form_definition_id, file)
results = CustomFormsApi(api_client).create_form_definition_file_request(form_definition_id=form_definition_id, file=file)
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).create_form_definition_file_request(form_definition_id, file)
print("The response of CustomFormsApi->create_form_definition_file_request:\n")
@@ -550,7 +550,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.create_form_instance_request import CreateFormInstanceRequest
@@ -559,8 +558,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
body = {
body = '''{
"formInput" : {
"input1" : "Sales"
},
@@ -580,12 +580,12 @@ with ApiClient(configuration) as api_client:
"formDefinitionId" : "00000000-0000-0000-0000-000000000000",
"state" : "ASSIGNED",
"ttl" : 1571827560
} # CreateFormInstanceRequest | Body is the request payload to create a form instance (optional)
}''' # CreateFormInstanceRequest | Body is the request payload to create a form instance (optional)
try:
# Creates a form instance.
results =CustomFormsApi(api_client).create_form_instance()
results = CustomFormsApi(api_client).create_form_instance()
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).create_form_instance(new_body)
print("The response of CustomFormsApi->create_form_instance:\n")
@@ -631,20 +631,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID
try:
# Deletes a form definition.
results =CustomFormsApi(api_client).delete_form_definition(form_definition_id)
results = CustomFormsApi(api_client).delete_form_definition(form_definition_id=form_definition_id)
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).delete_form_definition(form_definition_id)
print("The response of CustomFormsApi->delete_form_definition:\n")
@@ -692,7 +692,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.export_form_definitions_by_tenant200_response_inner import ExportFormDefinitionsByTenant200ResponseInner
@@ -700,6 +699,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
offset = 0 # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0)
limit = 250 # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250)
@@ -709,7 +709,7 @@ with ApiClient(configuration) as api_client:
try:
# List form definitions by tenant.
results =CustomFormsApi(api_client).export_form_definitions_by_tenant()
results = CustomFormsApi(api_client).export_form_definitions_by_tenant()
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).export_form_definitions_by_tenant(offset, limit, filters, sorters)
print("The response of CustomFormsApi->export_form_definitions_by_tenant:\n")
@@ -757,13 +757,13 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_definition_id = '00000000-0000-0000-0000-000000000000' # str | FormDefinitionID Form definition ID # str | FormDefinitionID Form definition ID
file_id = '00000031N0J7R2B57M8YG73J7M.png' # str | FileID String specifying the hashed name of the uploaded file we are retrieving. # str | FileID String specifying the hashed name of the uploaded file we are retrieving.
@@ -771,7 +771,7 @@ with ApiClient(configuration) as api_client:
try:
# Download definition file by fileId.
results =CustomFormsApi(api_client).get_file_from_s3(form_definition_id, file_id)
results = CustomFormsApi(api_client).get_file_from_s3(form_definition_id=form_definition_id, file_id=file_id)
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).get_file_from_s3(form_definition_id, file_id)
print("The response of CustomFormsApi->get_file_from_s3:\n")
@@ -817,7 +817,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.form_definition_response import FormDefinitionResponse
@@ -825,13 +824,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID
try:
# Return a form definition.
results =CustomFormsApi(api_client).get_form_definition_by_key(form_definition_id)
results = CustomFormsApi(api_client).get_form_definition_by_key(form_definition_id=form_definition_id)
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).get_form_definition_by_key(form_definition_id)
print("The response of CustomFormsApi->get_form_definition_by_key:\n")
@@ -877,7 +877,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.form_instance_response import FormInstanceResponse
@@ -885,13 +884,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID
try:
# Returns a form instance.
results =CustomFormsApi(api_client).get_form_instance_by_key(form_instance_id)
results = CustomFormsApi(api_client).get_form_instance_by_key(form_instance_id=form_instance_id)
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).get_form_instance_by_key(form_instance_id)
print("The response of CustomFormsApi->get_form_instance_by_key:\n")
@@ -939,13 +939,13 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_instance_id = '00000000-0000-0000-0000-000000000000' # str | FormInstanceID Form instance ID # str | FormInstanceID Form instance ID
file_id = '00000031N0J7R2B57M8YG73J7M.png' # str | FileID String specifying the hashed name of the uploaded file we are retrieving. # str | FileID String specifying the hashed name of the uploaded file we are retrieving.
@@ -953,7 +953,7 @@ with ApiClient(configuration) as api_client:
try:
# Download instance file by fileId.
results =CustomFormsApi(api_client).get_form_instance_file(form_instance_id, file_id)
results = CustomFormsApi(api_client).get_form_instance_file(form_instance_id=form_instance_id, file_id=file_id)
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).get_form_instance_file(form_instance_id, file_id)
print("The response of CustomFormsApi->get_form_instance_file:\n")
@@ -998,7 +998,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.import_form_definitions202_response import ImportFormDefinitions202Response
@@ -1007,15 +1006,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}] # List[ImportFormDefinitionsRequestInner] | Body is the request payload to import form definitions (optional)
body = [{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}] # List[ImportFormDefinitionsRequestInner] | Body is the request payload to import form definitions (optional)
with ApiClient(configuration) as api_client:
body = '''[{version=1, self={name=All fields not required, id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, type=FORM_DEFINITION}, object={id=05ed4edb-d0a9-41d9-ad0c-2f6e486ec4aa, name=All fields not required, description=description, owner={type=IDENTITY, id=3447d8ec2602455ab6f1e8408a0f0150}, usedBy=[{type=WORKFLOW, id=5008594c-dacc-4295-8fee-41df60477304}, {type=WORKFLOW, id=97e75a75-c179-4fbc-a2da-b5fa4aaa8743}], formInput=[{type=STRING, label=input1, description=A single dynamic scalar value (i.e. number, string, date, etc) that can be passed into the form for use in conditional logic}], formElements=[{id=3069272797630701, elementType=SECTION, config={label=First Section, formElements=[{id=3069272797630700, elementType=TEXT, key=firstName, config={label=First Name}}, {id=3498415402897539, elementType=TEXT, key=lastName, config={label=Last Name}}]}}], formConditions=[{ruleOperator=AND, rules=[{sourceType=INPUT, source=Department, operator=EQ, valueType=STRING, value=Sales}], effects=[{effectType=HIDE, config={element=2614088730489570}}]}], created=2022-10-04T19:27:04.456Z, modified=2022-11-16T20:45:02.172Z}}]''' # List[ImportFormDefinitionsRequestInner] | Body is the request payload to import form definitions (optional)
try:
# Import form definitions from export.
results =CustomFormsApi(api_client).import_form_definitions()
results = CustomFormsApi(api_client).import_form_definitions()
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).import_form_definitions(new_body)
print("The response of CustomFormsApi->import_form_definitions:\n")
@@ -1062,7 +1060,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.form_definition_response import FormDefinitionResponse
@@ -1070,16 +1067,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID
body = [{op=replace, path=/description, value=test-description}] # List[Dict[str, object]] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional)
body = [{op=replace, path=/description, value=test-description}] # List[Dict[str, object]] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional)
body = '''[{op=replace, path=/description, value=test-description}]''' # List[Dict[str, object]] | Body is the request payload to patch a form definition, check: https://jsonpatch.com (optional)
try:
# Patch a form definition.
results =CustomFormsApi(api_client).patch_form_definition(form_definition_id, )
results = CustomFormsApi(api_client).patch_form_definition(form_definition_id=form_definition_id)
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).patch_form_definition(form_definition_id, new_body)
print("The response of CustomFormsApi->patch_form_definition:\n")
@@ -1127,7 +1123,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.form_instance_response import FormInstanceResponse
@@ -1135,16 +1130,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID
body = [{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}] # List[Dict[str, object]] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional)
body = [{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}] # List[Dict[str, object]] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional)
body = '''[{op=replace, path=/state, value=SUBMITTED}, {op=replace, path=/formData, value={a-key-1=a-value-1, a-key-2=true, a-key-3=1}}]''' # List[Dict[str, object]] | Body is the request payload to patch a form instance, check: https://jsonpatch.com (optional)
try:
# Patch a form instance.
results =CustomFormsApi(api_client).patch_form_instance(form_instance_id, )
results = CustomFormsApi(api_client).patch_form_instance(form_instance_id=form_instance_id)
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).patch_form_instance(form_instance_id, new_body)
print("The response of CustomFormsApi->patch_form_instance:\n")
@@ -1192,7 +1186,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.list_form_definitions_by_tenant_response import ListFormDefinitionsByTenantResponse
@@ -1200,6 +1193,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
offset = 0 # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0) # int | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional) (default to 0)
limit = 250 # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250) # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 250)
@@ -1209,7 +1203,7 @@ with ApiClient(configuration) as api_client:
try:
# Export form definitions by tenant.
results =CustomFormsApi(api_client).search_form_definitions_by_tenant()
results = CustomFormsApi(api_client).search_form_definitions_by_tenant()
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).search_form_definitions_by_tenant(offset, limit, filters, sorters)
print("The response of CustomFormsApi->search_form_definitions_by_tenant:\n")
@@ -1260,7 +1254,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.list_form_element_data_by_element_id_response import ListFormElementDataByElementIDResponse
@@ -1268,6 +1261,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_instance_id = '00000000-0000-0000-0000-000000000000' # str | Form instance ID # str | Form instance ID
form_element_id = '1' # str | Form element ID # str | Form element ID
@@ -1278,7 +1272,7 @@ with ApiClient(configuration) as api_client:
try:
# Retrieves dynamic data by element.
results =CustomFormsApi(api_client).search_form_element_data_by_element_id(form_instance_id, form_element_id, )
results = CustomFormsApi(api_client).search_form_element_data_by_element_id(form_instance_id=form_instance_id, form_element_id=form_element_id)
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).search_form_element_data_by_element_id(form_instance_id, form_element_id, limit, filters, query)
print("The response of CustomFormsApi->search_form_element_data_by_element_id:\n")
@@ -1320,7 +1314,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.form_instance_response import FormInstanceResponse
@@ -1328,12 +1321,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List form instances by tenant.
results =CustomFormsApi(api_client).search_form_instances_by_tenant()
results = CustomFormsApi(api_client).search_form_instances_by_tenant()
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).search_form_instances_by_tenant()
print("The response of CustomFormsApi->search_form_instances_by_tenant:\n")
@@ -1375,7 +1369,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.list_predefined_select_options_response import ListPredefinedSelectOptionsResponse
@@ -1383,12 +1376,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List predefined select options.
results =CustomFormsApi(api_client).search_pre_defined_select_options()
results = CustomFormsApi(api_client).search_pre_defined_select_options()
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).search_pre_defined_select_options()
print("The response of CustomFormsApi->search_pre_defined_select_options:\n")
@@ -1438,7 +1432,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.custom_forms_api import CustomFormsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.form_element_preview_request import FormElementPreviewRequest
@@ -1447,12 +1440,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
form_definition_id = '00000000-0000-0000-0000-000000000000' # str | Form definition ID # str | Form definition ID
limit = 10 # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10) # int | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) (default to 10)
filters = 'value eq \"ID01\"' # 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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (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: **value**: *eq, ne, in* Supported composite operators: *not* Only a single *not* may be used, and it can only be used with the `in` operator. The `not` composite operator must be used in front of the field. For example, the following is valid: `not value in (\"ID01\")` (optional)
query = 'ac' # str | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional) # str | String that is passed to the underlying API to filter other (non-ID) fields. For example, for access profile data sources, this string will be passed to the access profile api and used with a \"starts with\" filter against several fields. (optional)
form_element_preview_request = {
form_element_preview_request = '''{
"dataSource" : {
"config" : {
"indices" : [ "identities" ],
@@ -1462,12 +1456,12 @@ with ApiClient(configuration) as api_client:
},
"dataSourceType" : "STATIC"
}
} # FormElementPreviewRequest | Body is the request payload to create a form definition dynamic schema (optional)
}''' # FormElementPreviewRequest | Body is the request payload to create a form definition dynamic schema (optional)
try:
# Preview form definition data source.
results =CustomFormsApi(api_client).show_preview_data_source(form_definition_id, )
results = CustomFormsApi(api_client).show_preview_data_source(form_definition_id=form_definition_id)
# Below is a request that includes all optional parameters
# results = CustomFormsApi(api_client).show_preview_data_source(form_definition_id, limit, filters, query, new_form_element_preview_request)
print("The response of CustomFormsApi->show_preview_data_source:\n")

19
docs/tools/sdk/python/Reference/Beta/Methods/CustomPasswordInstructionsApi.md
View File

@@ -61,7 +61,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.custom_password_instructions_api import CustomPasswordInstructionsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.custom_password_instruction import CustomPasswordInstruction
@@ -69,18 +68,18 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
custom_password_instruction = {
custom_password_instruction = '''{
"pageContent" : "Please enter a new password. Your password must be at least 8 characters long and contain at least one number and one letter.",
"pageId" : "change-password:enter-password",
"locale" : "en"
} # CustomPasswordInstruction |
}''' # CustomPasswordInstruction |
try:
# Create Custom Password Instructions
new_custom_password_instruction = CustomPasswordInstruction()
new_custom_password_instruction.from_json(custom_password_instruction)
results =CustomPasswordInstructionsApi(api_client).create_custom_password_instructions(new_custom_password_instruction)
new_custom_password_instruction = CustomPasswordInstruction.from_json(custom_password_instruction)
results = CustomPasswordInstructionsApi(api_client).create_custom_password_instructions(custom_password_instruction=new_custom_password_instruction)
# Below is a request that includes all optional parameters
# results = CustomPasswordInstructionsApi(api_client).create_custom_password_instructions(new_custom_password_instruction)
print("The response of CustomPasswordInstructionsApi->create_custom_password_instructions:\n")
@@ -125,13 +124,13 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.custom_password_instructions_api import CustomPasswordInstructionsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
page_id = 'mfa:select' # str | The page ID of custom password instructions to delete. # str | The page ID of custom password instructions to delete.
locale = 'locale_example' # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional)
@@ -139,7 +138,7 @@ with ApiClient(configuration) as api_client:
try:
# Delete Custom Password Instructions by page ID
CustomPasswordInstructionsApi(api_client).delete_custom_password_instructions(page_id, )
CustomPasswordInstructionsApi(api_client).delete_custom_password_instructions(page_id=page_id)
# Below is a request that includes all optional parameters
# CustomPasswordInstructionsApi(api_client).delete_custom_password_instructions(page_id, locale)
except Exception as e:
@@ -182,7 +181,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.custom_password_instructions_api import CustomPasswordInstructionsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.custom_password_instruction import CustomPasswordInstruction
@@ -190,6 +188,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
page_id = 'mfa:select' # str | The page ID of custom password instructions to query. # str | The page ID of custom password instructions to query.
locale = 'locale_example' # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional) # str | The locale for the custom instructions, a BCP47 language tag. The default value is \\\"default\\\". (optional)
@@ -197,7 +196,7 @@ with ApiClient(configuration) as api_client:
try:
# Get Custom Password Instructions by Page ID
results =CustomPasswordInstructionsApi(api_client).get_custom_password_instructions(page_id, )
results = CustomPasswordInstructionsApi(api_client).get_custom_password_instructions(page_id=page_id)
# Below is a request that includes all optional parameters
# results = CustomPasswordInstructionsApi(api_client).get_custom_password_instructions(page_id, locale)
print("The response of CustomPasswordInstructionsApi->get_custom_password_instructions:\n")

70
docs/tools/sdk/python/Reference/Beta/Methods/EntitlementsApi.md
View File

@@ -112,7 +112,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.entitlements_api import EntitlementsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.entitlement import Entitlement
@@ -120,6 +119,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id.
attribute_key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
@@ -128,7 +128,7 @@ with ApiClient(configuration) as api_client:
try:
# Add metadata to an entitlement.
results =EntitlementsApi(api_client).create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value)
results = EntitlementsApi(api_client).create_access_model_metadata_for_entitlement(id=id, attribute_key=attribute_key, attribute_value=attribute_value)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value)
print("The response of EntitlementsApi->create_access_model_metadata_for_entitlement:\n")
@@ -175,13 +175,13 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.entitlements_api import EntitlementsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id.
attribute_key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
@@ -190,7 +190,7 @@ with ApiClient(configuration) as api_client:
try:
# Remove metadata from an entitlement.
EntitlementsApi(api_client).delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value)
EntitlementsApi(api_client).delete_access_model_metadata_from_entitlement(id=id, attribute_key=attribute_key, attribute_value=attribute_value)
# Below is a request that includes all optional parameters
# EntitlementsApi(api_client).delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value)
except Exception as e:
@@ -234,7 +234,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.entitlements_api import EntitlementsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.entitlement import Entitlement
@@ -242,13 +241,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808874ff91550175097daaec161c' # str | The entitlement ID # str | The entitlement ID
try:
# Get an entitlement
results =EntitlementsApi(api_client).get_entitlement(id)
results = EntitlementsApi(api_client).get_entitlement(id=id)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).get_entitlement(id)
print("The response of EntitlementsApi->get_entitlement:\n")
@@ -294,7 +294,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.entitlements_api import EntitlementsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.entitlement_request_config import EntitlementRequestConfig
@@ -302,13 +301,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id
try:
# Get Entitlement Request Config
results =EntitlementsApi(api_client).get_entitlement_request_config(id)
results = EntitlementsApi(api_client).get_entitlement_request_config(id=id)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).get_entitlement_request_config(id)
print("The response of EntitlementsApi->get_entitlement_request_config:\n")
@@ -361,7 +361,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.entitlements_api import EntitlementsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.load_entitlement_task import LoadEntitlementTask
@@ -369,6 +368,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id
csv_file = None # bytearray | The CSV file containing the source entitlements to aggregate. (optional) # bytearray | The CSV file containing the source entitlements to aggregate. (optional)
@@ -376,7 +376,7 @@ with ApiClient(configuration) as api_client:
try:
# Aggregate Entitlements
results =EntitlementsApi(api_client).import_entitlements_by_source(id, )
results = EntitlementsApi(api_client).import_entitlements_by_source(id=id)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).import_entitlements_by_source(id, csv_file)
print("The response of EntitlementsApi->import_entitlements_by_source:\n")
@@ -427,7 +427,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.entitlements_api import EntitlementsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.entitlement import Entitlement
@@ -435,6 +434,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement 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)
@@ -446,7 +446,7 @@ with ApiClient(configuration) as api_client:
try:
# List of entitlements children
results =EntitlementsApi(api_client).list_entitlement_children(id, )
results = EntitlementsApi(api_client).list_entitlement_children(id=id)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).list_entitlement_children(id, limit, offset, count, sorters, filters)
print("The response of EntitlementsApi->list_entitlement_children:\n")
@@ -497,7 +497,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.entitlements_api import EntitlementsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.entitlement import Entitlement
@@ -505,6 +504,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808c74ff913f0175097daa9d59cd' # str | Entitlement Id # str | Entitlement 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)
@@ -516,7 +516,7 @@ with ApiClient(configuration) as api_client:
try:
# List of entitlements parents
results =EntitlementsApi(api_client).list_entitlement_parents(id, )
results = EntitlementsApi(api_client).list_entitlement_parents(id=id)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).list_entitlement_parents(id, limit, offset, count, sorters, filters)
print("The response of EntitlementsApi->list_entitlement_parents:\n")
@@ -573,7 +573,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.entitlements_api import EntitlementsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.entitlement import Entitlement
@@ -581,6 +580,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (optional) # str | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). This parameter is deprecated. Please use [Account Entitlements API](https://developer.sailpoint.com/apis/beta/#operation/getAccountEntitlements) to get account entitlements. (optional)
segmented_for_identity = 'me' # str | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) # str | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value **me** can stand in for the current user's Identity ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional)
@@ -595,7 +595,7 @@ with ApiClient(configuration) as api_client:
try:
# Gets a list of entitlements.
results =EntitlementsApi(api_client).list_entitlements()
results = EntitlementsApi(api_client).list_entitlements()
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).list_entitlements(account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters)
print("The response of EntitlementsApi->list_entitlements:\n")
@@ -648,7 +648,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.entitlements_api import EntitlementsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.entitlement import Entitlement
@@ -657,20 +656,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the entitlement to patch # str | ID of the entitlement to patch
[{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}] # List[JsonPatchOperation] | (optional)
json_patch_operation = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] | (optional)
json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}]''' # List[JsonPatchOperation] | (optional)
try:
# Patch an entitlement
results =EntitlementsApi(api_client).patch_entitlement(id, )
results = EntitlementsApi(api_client).patch_entitlement(id=id)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).patch_entitlement(id, new_json_patch_operation)
print("The response of EntitlementsApi->patch_entitlement:\n")
@@ -717,7 +711,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.entitlements_api import EntitlementsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.entitlement_request_config import EntitlementRequestConfig
@@ -725,9 +718,10 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | Entitlement ID # str | Entitlement ID
entitlement_request_config = {
entitlement_request_config = '''{
"accessRequestConfig" : {
"denialCommentRequired" : false,
"approvalSchemes" : [ {
@@ -739,13 +733,12 @@ with ApiClient(configuration) as api_client:
} ],
"requestCommentRequired" : true
}
} # EntitlementRequestConfig |
}''' # EntitlementRequestConfig |
try:
# Replace Entitlement Request Config
new_entitlement_request_config = EntitlementRequestConfig()
new_entitlement_request_config.from_json(entitlement_request_config)
results =EntitlementsApi(api_client).put_entitlement_request_config(id, new_entitlement_request_config)
new_entitlement_request_config = EntitlementRequestConfig.from_json(entitlement_request_config)
results = EntitlementsApi(api_client).put_entitlement_request_config(id=id, entitlement_request_config=new_entitlement_request_config)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).put_entitlement_request_config(id, new_entitlement_request_config)
print("The response of EntitlementsApi->put_entitlement_request_config:\n")
@@ -791,7 +784,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.entitlements_api import EntitlementsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.entitlement_source_reset_base_reference_dto import EntitlementSourceResetBaseReferenceDto
@@ -799,13 +791,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c91808a7813090a017814121919ecca' # str | ID of source for the entitlement reset # str | ID of source for the entitlement reset
try:
# Reset Source Entitlements
results =EntitlementsApi(api_client).reset_source_entitlements(source_id)
results = EntitlementsApi(api_client).reset_source_entitlements(source_id=source_id)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).reset_source_entitlements(source_id)
print("The response of EntitlementsApi->reset_source_entitlements:\n")
@@ -863,7 +856,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.entitlements_api import EntitlementsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.entitlement_bulk_update_request import EntitlementBulkUpdateRequest
@@ -871,8 +863,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
entitlement_bulk_update_request = {
entitlement_bulk_update_request = '''{
"entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ],
"jsonPatch" : [ {
"op" : "replace",
@@ -883,13 +876,12 @@ with ApiClient(configuration) as api_client:
"path" : "/requestable",
"value" : false
} ]
} # EntitlementBulkUpdateRequest |
}''' # EntitlementBulkUpdateRequest |
try:
# Bulk update an entitlement list
new_entitlement_bulk_update_request = EntitlementBulkUpdateRequest()
new_entitlement_bulk_update_request.from_json(entitlement_bulk_update_request)
EntitlementsApi(api_client).update_entitlements_in_bulk(new_entitlement_bulk_update_request)
new_entitlement_bulk_update_request = EntitlementBulkUpdateRequest.from_json(entitlement_bulk_update_request)
EntitlementsApi(api_client).update_entitlements_in_bulk(entitlement_bulk_update_request=new_entitlement_bulk_update_request)
# Below is a request that includes all optional parameters
# EntitlementsApi(api_client).update_entitlements_in_bulk(new_entitlement_bulk_update_request)
except Exception as e:

76
docs/tools/sdk/python/Reference/Beta/Methods/GovernanceGroupsApi.md
View File

@@ -64,7 +64,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.workgroup_dto import WorkgroupDto
@@ -72,8 +71,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
workgroup_dto = {
workgroup_dto = '''{
"owner" : {
"emailAddress" : "support@sailpoint.com",
"displayName" : "Support",
@@ -88,13 +88,12 @@ with ApiClient(configuration) as api_client:
"description" : "Description of the Governance Group",
"modified" : "2022-01-06T19:51:13Z",
"id" : "2c91808568c529c60168cca6f90c1313"
} # WorkgroupDto |
}''' # WorkgroupDto |
try:
# Create a new Governance Group.
new_workgroup_dto = WorkgroupDto()
new_workgroup_dto.from_json(workgroup_dto)
results =GovernanceGroupsApi(api_client).create_workgroup(new_workgroup_dto)
new_workgroup_dto = WorkgroupDto.from_json(workgroup_dto)
results = GovernanceGroupsApi(api_client).create_workgroup(workgroup_dto=new_workgroup_dto)
# Below is a request that includes all optional parameters
# results = GovernanceGroupsApi(api_client).create_workgroup(new_workgroup_dto)
print("The response of GovernanceGroupsApi->create_workgroup:\n")
@@ -139,20 +138,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group
try:
# Delete a Governance Group
GovernanceGroupsApi(api_client).delete_workgroup(id)
GovernanceGroupsApi(api_client).delete_workgroup(id=id)
# Below is a request that includes all optional parameters
# GovernanceGroupsApi(api_client).delete_workgroup(id)
except Exception as e:
@@ -200,7 +199,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.bulk_workgroup_members_request_inner import BulkWorkgroupMembersRequestInner
@@ -209,17 +207,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group.
[sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be removed from a Governance Group members list.
bulk_workgroup_members_request_inner = [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be removed from a Governance Group members list.
bulk_workgroup_members_request_inner = '''[sailpoint.beta.BulkWorkgroupMembersRequestInner()]''' # List[BulkWorkgroupMembersRequestInner] | List of identities to be removed from a Governance Group members list.
try:
# Remove members from Governance Group
new_bulk_workgroup_members_request_inner = BulkWorkgroupMembersRequestInner()
new_bulk_workgroup_members_request_inner.from_json(bulk_workgroup_members_request_inner)
results =GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, new_bulk_workgroup_members_request_inner)
new_bulk_workgroup_members_request_inner = BulkWorkgroupMembersRequestInner.from_json(bulk_workgroup_members_request_inner)
results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id=workgroup_id, bulk_workgroup_members_request_inner=new_bulk_workgroup_members_request_inner)
# Below is a request that includes all optional parameters
# results = GovernanceGroupsApi(api_client).delete_workgroup_members(workgroup_id, new_bulk_workgroup_members_request_inner)
print("The response of GovernanceGroupsApi->delete_workgroup_members:\n")
@@ -275,7 +271,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.workgroup_bulk_delete_request import WorkgroupBulkDeleteRequest
@@ -284,16 +279,16 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
workgroup_bulk_delete_request = {
workgroup_bulk_delete_request = '''{
"ids" : [ "567a697e-885b-495a-afc5-d55e1c23a302", "c7b0f7b2-1e78-4063-b294-a555333dacd2" ]
} # WorkgroupBulkDeleteRequest |
}''' # WorkgroupBulkDeleteRequest |
try:
# Delete Governance Group(s)
new_workgroup_bulk_delete_request = WorkgroupBulkDeleteRequest()
new_workgroup_bulk_delete_request.from_json(workgroup_bulk_delete_request)
results =GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(new_workgroup_bulk_delete_request)
new_workgroup_bulk_delete_request = WorkgroupBulkDeleteRequest.from_json(workgroup_bulk_delete_request)
results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(workgroup_bulk_delete_request=new_workgroup_bulk_delete_request)
# Below is a request that includes all optional parameters
# results = GovernanceGroupsApi(api_client).delete_workgroups_in_bulk(new_workgroup_bulk_delete_request)
print("The response of GovernanceGroupsApi->delete_workgroups_in_bulk:\n")
@@ -338,7 +333,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.workgroup_dto import WorkgroupDto
@@ -346,13 +340,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group
try:
# Get Governance Group by Id
results =GovernanceGroupsApi(api_client).get_workgroup(id)
results = GovernanceGroupsApi(api_client).get_workgroup(id=id)
# Below is a request that includes all optional parameters
# results = GovernanceGroupsApi(api_client).get_workgroup(id)
print("The response of GovernanceGroupsApi->get_workgroup:\n")
@@ -401,7 +396,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.workgroup_connection_dto import WorkgroupConnectionDto
@@ -409,6 +403,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group.
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)
@@ -419,7 +414,7 @@ with ApiClient(configuration) as api_client:
try:
# List connections for Governance Group
results =GovernanceGroupsApi(api_client).list_connections(workgroup_id, )
results = GovernanceGroupsApi(api_client).list_connections(workgroup_id=workgroup_id)
# Below is a request that includes all optional parameters
# results = GovernanceGroupsApi(api_client).list_connections(workgroup_id, offset, limit, count, sorters)
print("The response of GovernanceGroupsApi->list_connections:\n")
@@ -468,7 +463,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.list_workgroup_members200_response_inner import ListWorkgroupMembers200ResponseInner
@@ -476,6 +470,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group.
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)
@@ -486,7 +481,7 @@ with ApiClient(configuration) as api_client:
try:
# List Governance Group Members
results =GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id, )
results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id=workgroup_id)
# Below is a request that includes all optional parameters
# results = GovernanceGroupsApi(api_client).list_workgroup_members(workgroup_id, offset, limit, count, sorters)
print("The response of GovernanceGroupsApi->list_workgroup_members:\n")
@@ -535,7 +530,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.workgroup_dto import WorkgroupDto
@@ -543,6 +537,7 @@ 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 = 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)
@@ -553,7 +548,7 @@ with ApiClient(configuration) as api_client:
try:
# List Governance Groups
results =GovernanceGroupsApi(api_client).list_workgroups()
results = GovernanceGroupsApi(api_client).list_workgroups()
# Below is a request that includes all optional parameters
# results = GovernanceGroupsApi(api_client).list_workgroups(offset, limit, count, filters, sorters)
print("The response of GovernanceGroupsApi->list_workgroups:\n")
@@ -605,7 +600,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.json_patch_operation import JsonPatchOperation
@@ -614,20 +608,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Governance Group # str | ID of the Governance Group
[{op=replace, path=/description, value=Governance Group new description.}] # List[JsonPatchOperation] | (optional)
json_patch_operation = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] | (optional)
json_patch_operation = '''[{op=replace, path=/description, value=Governance Group new description.}]''' # List[JsonPatchOperation] | (optional)
try:
# Patch a Governance Group
results =GovernanceGroupsApi(api_client).patch_workgroup(id, )
results = GovernanceGroupsApi(api_client).patch_workgroup(id=id)
# Below is a request that includes all optional parameters
# results = GovernanceGroupsApi(api_client).patch_workgroup(id, new_json_patch_operation)
print("The response of GovernanceGroupsApi->patch_workgroup:\n")
@@ -677,7 +666,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.governance_groups_api import GovernanceGroupsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.bulk_workgroup_members_request_inner import BulkWorkgroupMembersRequestInner
@@ -686,17 +674,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
workgroup_id = '2c91808a7813090a017814121919ecca' # str | ID of the Governance Group. # str | ID of the Governance Group.
[sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be added to a Governance Group members list.
bulk_workgroup_members_request_inner = [sailpoint.beta.BulkWorkgroupMembersRequestInner()] # List[BulkWorkgroupMembersRequestInner] | List of identities to be added to a Governance Group members list.
bulk_workgroup_members_request_inner = '''[sailpoint.beta.BulkWorkgroupMembersRequestInner()]''' # List[BulkWorkgroupMembersRequestInner] | List of identities to be added to a Governance Group members list.
try:
# Add members to Governance Group
new_bulk_workgroup_members_request_inner = BulkWorkgroupMembersRequestInner()
new_bulk_workgroup_members_request_inner.from_json(bulk_workgroup_members_request_inner)
results =GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, new_bulk_workgroup_members_request_inner)
new_bulk_workgroup_members_request_inner = BulkWorkgroupMembersRequestInner.from_json(bulk_workgroup_members_request_inner)
results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id=workgroup_id, bulk_workgroup_members_request_inner=new_bulk_workgroup_members_request_inner)
# Below is a request that includes all optional parameters
# results = GovernanceGroupsApi(api_client).update_workgroup_members(workgroup_id, new_bulk_workgroup_members_request_inner)
print("The response of GovernanceGroupsApi->update_workgroup_members:\n")

114
docs/tools/sdk/python/Reference/Beta/Methods/IAIAccessRequestRecommendationsApi.md
View File

@@ -15,18 +15,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**add-access-request-recommendations-ignored-item**](#add-access-request-recommendations-ignored-item) | **POST** `/ai-access-request-recommendations/ignored-items` | Notification of Ignored Access Request Recommendations
[**add-access-request-recommendations-requested-item**](#add-access-request-recommendations-requested-item) | **POST** `/ai-access-request-recommendations/requested-items` | Notification of Requested Access Request Recommendations
[**add-access-request-recommendations-viewed-item**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Notification of Viewed Access Request Recommendations
[**add-access-request-recommendations-viewed-items**](#add-access-request-recommendations-viewed-items) | **POST** `/ai-access-request-recommendations/viewed-items/bulk-create` | Notification of Viewed Access Request Recommendations in Bulk
[**add-access-request-recommendations-ignored-item**](#add-access-request-recommendations-ignored-item) | **POST** `/ai-access-request-recommendations/ignored-items` | Ignore Access Request Recommendation
[**add-access-request-recommendations-requested-item**](#add-access-request-recommendations-requested-item) | **POST** `/ai-access-request-recommendations/requested-items` | Accept Access Request Recommendation
[**add-access-request-recommendations-viewed-item**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Mark Viewed Access Request Recommendations
[**add-access-request-recommendations-viewed-items**](#add-access-request-recommendations-viewed-items) | **POST** `/ai-access-request-recommendations/viewed-items/bulk-create` | Bulk Mark Viewed Access Request Recommendations
[**get-access-request-recommendations**](#get-access-request-recommendations) | **GET** `/ai-access-request-recommendations` | Identity Access Request Recommendations
[**get-access-request-recommendations-ignored-items**](#get-access-request-recommendations-ignored-items) | **GET** `/ai-access-request-recommendations/ignored-items` | List of Ignored Access Request Recommendations
[**get-access-request-recommendations-requested-items**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List of Requested Access Request Recommendations
[**get-access-request-recommendations-viewed-items**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List of Viewed Access Request Recommendations
[**get-access-request-recommendations-ignored-items**](#get-access-request-recommendations-ignored-items) | **GET** `/ai-access-request-recommendations/ignored-items` | List Ignored Access Request Recommendations
[**get-access-request-recommendations-requested-items**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List Accepted Access Request Recommendations
[**get-access-request-recommendations-viewed-items**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List Viewed Access Request Recommendations
## add-access-request-recommendations-ignored-item
Notification of Ignored Access Request Recommendations
Ignore Access Request Recommendation
This API ignores a recommended access request item. Once an item is ignored, it will be marked as ignored=true if it is still a recommended item. The consumer can decide to hide ignored recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/beta/add-access-request-recommendations-ignored-item)
@@ -57,7 +57,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto
@@ -66,20 +65,20 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
access_request_recommendation_action_item_dto = {
access_request_recommendation_action_item_dto = '''{
"access" : {
"id" : "2c9180835d2e5168015d32f890ca1581",
"type" : "ACCESS_PROFILE"
},
"identityId" : "2c91808570313110017040b06f344ec9"
} # AccessRequestRecommendationActionItemDto | The recommended access item to ignore for an identity.
}''' # AccessRequestRecommendationActionItemDto | The recommended access item to ignore for an identity.
try:
# Notification of Ignored Access Request Recommendations
new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto()
new_access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto)
results =IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_ignored_item(new_access_request_recommendation_action_item_dto)
# Ignore Access Request Recommendation
new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto)
results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_ignored_item(access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto)
# Below is a request that includes all optional parameters
# results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_ignored_item(new_access_request_recommendation_action_item_dto)
print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_ignored_item:\n")
@@ -93,7 +92,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## add-access-request-recommendations-requested-item
Notification of Requested Access Request Recommendations
Accept Access Request Recommendation
This API consumes a notification that a recommended access request item was requested. This API does not actually make the request, it is just a notification. This will help provide feedback in order to improve our recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/beta/add-access-request-recommendations-requested-item)
@@ -124,7 +123,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto
@@ -133,20 +131,20 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
access_request_recommendation_action_item_dto = {
access_request_recommendation_action_item_dto = '''{
"access" : {
"id" : "2c9180835d2e5168015d32f890ca1581",
"type" : "ACCESS_PROFILE"
},
"identityId" : "2c91808570313110017040b06f344ec9"
} # AccessRequestRecommendationActionItemDto | The recommended access item that was requested for an identity.
}''' # AccessRequestRecommendationActionItemDto | The recommended access item that was requested for an identity.
try:
# Notification of Requested Access Request Recommendations
new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto()
new_access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto)
results =IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_requested_item(new_access_request_recommendation_action_item_dto)
# Accept Access Request Recommendation
new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto)
results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_requested_item(access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto)
# Below is a request that includes all optional parameters
# results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_requested_item(new_access_request_recommendation_action_item_dto)
print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_requested_item:\n")
@@ -160,7 +158,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## add-access-request-recommendations-viewed-item
Notification of Viewed Access Request Recommendations
Mark Viewed Access Request Recommendations
This API consumes a notification that a recommended access request item was viewed. Future recommendations with this item will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/beta/add-access-request-recommendations-viewed-item)
@@ -191,7 +189,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto
@@ -200,20 +197,20 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
access_request_recommendation_action_item_dto = {
access_request_recommendation_action_item_dto = '''{
"access" : {
"id" : "2c9180835d2e5168015d32f890ca1581",
"type" : "ACCESS_PROFILE"
},
"identityId" : "2c91808570313110017040b06f344ec9"
} # AccessRequestRecommendationActionItemDto | The recommended access that was viewed for an identity.
}''' # AccessRequestRecommendationActionItemDto | The recommended access that was viewed for an identity.
try:
# Notification of Viewed Access Request Recommendations
new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto()
new_access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto)
results =IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_item(new_access_request_recommendation_action_item_dto)
# Mark Viewed Access Request Recommendations
new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto)
results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_item(access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto)
# Below is a request that includes all optional parameters
# results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_item(new_access_request_recommendation_action_item_dto)
print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_item:\n")
@@ -227,7 +224,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## add-access-request-recommendations-viewed-items
Notification of Viewed Access Request Recommendations in Bulk
Bulk Mark Viewed Access Request Recommendations
This API consumes a notification that a set of recommended access request item were viewed. Future recommendations with these items will be marked with viewed=true. This can be useful for the consumer to determine if there are any new/unviewed recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/beta/add-access-request-recommendations-viewed-items)
@@ -258,7 +255,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.access_request_recommendation_action_item_dto import AccessRequestRecommendationActionItemDto
@@ -267,22 +263,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
[sailpoint.beta.AccessRequestRecommendationActionItemDto()] # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity.
access_request_recommendation_action_item_dto = {
"access" : {
"id" : "2c9180835d2e5168015d32f890ca1581",
"type" : "ACCESS_PROFILE"
},
"identityId" : "2c91808570313110017040b06f344ec9"
} # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity.
with ApiClient(configuration) as api_client:
access_request_recommendation_action_item_dto = '''[sailpoint.beta.AccessRequestRecommendationActionItemDto()]''' # List[AccessRequestRecommendationActionItemDto] | The recommended access items that were viewed for an identity.
try:
# Notification of Viewed Access Request Recommendations in Bulk
new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto()
new_access_request_recommendation_action_item_dto.from_json(access_request_recommendation_action_item_dto)
results =IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(new_access_request_recommendation_action_item_dto)
# Bulk Mark Viewed Access Request Recommendations
new_access_request_recommendation_action_item_dto = AccessRequestRecommendationActionItemDto.from_json(access_request_recommendation_action_item_dto)
results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(access_request_recommendation_action_item_dto=new_access_request_recommendation_action_item_dto)
# Below is a request that includes all optional parameters
# results = IAIAccessRequestRecommendationsApi(api_client).add_access_request_recommendations_viewed_items(new_access_request_recommendation_action_item_dto)
print("The response of IAIAccessRequestRecommendationsApi->add_access_request_recommendations_viewed_items:\n")
@@ -333,7 +321,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.access_request_recommendation_item_detail import AccessRequestRecommendationItemDetail
@@ -341,6 +328,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = 'me' # str | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to 'me') # str | Get access request recommendations for an identityId. *me* indicates the current user. (optional) (default to 'me')
limit = 15 # int | Max number of results to return. (optional) (default to 15) # int | Max number of results to return. (optional) (default to 15)
@@ -348,12 +336,12 @@ with ApiClient(configuration) as api_client:
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)
include_translation_messages = False # bool | If *true* it will populate a list of translation messages in the response. (optional) (default to False) # bool | If *true* it will populate a list of translation messages in the response. (optional) (default to False)
filters = 'access.name co \"admin\"' # 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, 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: **access.name**: *co* **access.type**: *eq, in* **access.description**: *co, eq, in* (optional)
sorters = 'sorters_example' # 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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional)
sorters = 'access.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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (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: **access.name, access.type** By default the recommendations are sorted by highest confidence first. (optional)
try:
# Identity Access Request Recommendations
results =IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations()
results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations()
# Below is a request that includes all optional parameters
# results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations(identity_id, limit, offset, count, include_translation_messages, filters, sorters)
print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations:\n")
@@ -367,7 +355,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-access-request-recommendations-ignored-items
List of Ignored Access Request Recommendations
List Ignored Access Request Recommendations
This API returns the list of ignored access request recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations-ignored-items)
@@ -402,7 +390,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto
@@ -410,6 +397,7 @@ 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)
@@ -418,9 +406,9 @@ with ApiClient(configuration) as api_client:
sorters = 'access.id' # 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional)
try:
# List of Ignored Access Request Recommendations
# List Ignored Access Request Recommendations
results =IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items()
results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items()
# Below is a request that includes all optional parameters
# results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_ignored_items(limit, offset, count, filters, sorters)
print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_ignored_items:\n")
@@ -434,7 +422,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-access-request-recommendations-requested-items
List of Requested Access Request Recommendations
List Accepted Access Request Recommendations
This API returns a list of requested access request recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations-requested-items)
@@ -469,7 +457,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto
@@ -477,17 +464,18 @@ 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)
filters = 'access.id eq \"2c9180846b0a0583016b299f210c1314\"' # 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
sorters = 'sorters_example' # 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional)
sorters = 'access.id' # 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional)
try:
# List of Requested Access Request Recommendations
# List Accepted Access Request Recommendations
results =IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items()
results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items()
# Below is a request that includes all optional parameters
# results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_requested_items(limit, offset, count, filters, sorters)
print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_requested_items:\n")
@@ -501,7 +489,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-access-request-recommendations-viewed-items
List of Viewed Access Request Recommendations
List Viewed Access Request Recommendations
This API returns the list of viewed access request recommendations.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-request-recommendations-viewed-items)
@@ -536,7 +524,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.access_request_recommendation_action_item_response_dto import AccessRequestRecommendationActionItemResponseDto
@@ -544,17 +531,18 @@ 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)
filters = 'access.id eq \"2c9180846b0a0583016b299f210c1314\"' # 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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *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: **access.id**: *eq, in* **access.type**: *eq, in* **identityId**: *eq, in* (optional)
sorters = 'sorters_example' # 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional)
sorters = 'access.id' # 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: **access.id, access.type, identityId, timestamp** (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: **access.id, access.type, identityId, timestamp** (optional)
try:
# List of Viewed Access Request Recommendations
# List Viewed Access Request Recommendations
results =IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items()
results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items()
# Below is a request that includes all optional parameters
# results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_viewed_items(limit, offset, count, filters, sorters)
print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_viewed_items:\n")

29
docs/tools/sdk/python/Reference/Beta/Methods/IAICommonAccessApi.md
View File

@@ -52,7 +52,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_common_access_api import IAICommonAccessApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.common_access_item_request import CommonAccessItemRequest
@@ -61,8 +60,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
common_access_item_request = {
common_access_item_request = '''{
"access" : {
"ownerName" : "ownerName",
"name" : "name",
@@ -72,13 +72,12 @@ with ApiClient(configuration) as api_client:
"ownerId" : "ownerId"
},
"status" : "CONFIRMED"
} # CommonAccessItemRequest |
}''' # CommonAccessItemRequest |
try:
# Create common access items
new_common_access_item_request = CommonAccessItemRequest()
new_common_access_item_request.from_json(common_access_item_request)
results =IAICommonAccessApi(api_client).create_common_access(new_common_access_item_request)
new_common_access_item_request = CommonAccessItemRequest.from_json(common_access_item_request)
results = IAICommonAccessApi(api_client).create_common_access(common_access_item_request=new_common_access_item_request)
# Below is a request that includes all optional parameters
# results = IAICommonAccessApi(api_client).create_common_access(new_common_access_item_request)
print("The response of IAICommonAccessApi->create_common_access:\n")
@@ -126,7 +125,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_common_access_api import IAICommonAccessApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.common_access_response import CommonAccessResponse
@@ -134,6 +132,7 @@ 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)
@@ -144,7 +143,7 @@ with ApiClient(configuration) as api_client:
try:
# Get a paginated list of common access
results =IAICommonAccessApi(api_client).get_common_access()
results = IAICommonAccessApi(api_client).get_common_access()
# Below is a request that includes all optional parameters
# results = IAICommonAccessApi(api_client).get_common_access(offset, limit, count, filters, sorters)
print("The response of IAICommonAccessApi->get_common_access:\n")
@@ -189,7 +188,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_common_access_api import IAICommonAccessApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.common_access_id_status import CommonAccessIDStatus
@@ -197,19 +195,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
[sailpoint.beta.CommonAccessIDStatus()] # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access
common_access_id_status = {
"confirmedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ],
"deniedIds" : [ "046b6c7f-0b8a-43b9-b35d-6489e6daee91", "046b6c7f-0b8a-43b9-b35d-6489e6daee91" ]
} # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access
with ApiClient(configuration) as api_client:
common_access_id_status = '''[sailpoint.beta.CommonAccessIDStatus()]''' # List[CommonAccessIDStatus] | Confirm or deny in bulk the common access ids that are (or aren't) common access
try:
# Bulk update common access status
new_common_access_id_status = CommonAccessIdStatus()
new_common_access_id_status.from_json(common_access_id_status)
results =IAICommonAccessApi(api_client).update_common_access_status_in_bulk(new_common_access_id_status)
new_common_access_id_status = CommonAccessIdStatus.from_json(common_access_id_status)
results = IAICommonAccessApi(api_client).update_common_access_status_in_bulk(common_access_id_status=new_common_access_id_status)
# Below is a request that includes all optional parameters
# results = IAICommonAccessApi(api_client).update_common_access_status_in_bulk(new_common_access_id_status)
print("The response of IAICommonAccessApi->update_common_access_status_in_bulk:\n")

4
docs/tools/sdk/python/Reference/Beta/Methods/IAIMessageCatalogsApi.md
View File

@@ -50,7 +50,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_message_catalogs_api import IAIMessageCatalogsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.message_catalog_dto import MessageCatalogDto
@@ -58,13 +57,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
catalog_id = 'recommender' # str | The ID of the message catalog. # str | The ID of the message catalog.
try:
# Get Message catalogs
results =IAIMessageCatalogsApi(api_client).get_message_catalogs(catalog_id)
results = IAIMessageCatalogsApi(api_client).get_message_catalogs(catalog_id=catalog_id)
# Below is a request that includes all optional parameters
# results = IAIMessageCatalogsApi(api_client).get_message_catalogs(catalog_id)
print("The response of IAIMessageCatalogsApi->get_message_catalogs:\n")

50
docs/tools/sdk/python/Reference/Beta/Methods/IAIOutliersApi.md
View File

@@ -61,20 +61,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
type = 'LOW_SIMILARITY' # str | Type of the identity outliers snapshot to filter on (optional) # str | Type of the identity outliers snapshot to filter on (optional)
try:
# IAI Identity Outliers Export
results =IAIOutliersApi(api_client).export_outliers_zip()
results = IAIOutliersApi(api_client).export_outliers_zip()
# Below is a request that includes all optional parameters
# results = IAIOutliersApi(api_client).export_outliers_zip(type)
print("The response of IAIOutliersApi->export_outliers_zip:\n")
@@ -124,7 +124,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.outlier_summary import OutlierSummary
@@ -132,6 +131,7 @@ 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)
@@ -142,7 +142,7 @@ with ApiClient(configuration) as api_client:
try:
# IAI Identity Outliers Summary
results =IAIOutliersApi(api_client).get_identity_outlier_snapshots()
results = IAIOutliersApi(api_client).get_identity_outlier_snapshots()
# Below is a request that includes all optional parameters
# results = IAIOutliersApi(api_client).get_identity_outlier_snapshots(limit, offset, type, filters, sorters)
print("The response of IAIOutliersApi->get_identity_outlier_snapshots:\n")
@@ -192,7 +192,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.outlier import Outlier
@@ -200,6 +199,7 @@ 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)
@@ -211,7 +211,7 @@ with ApiClient(configuration) as api_client:
try:
# IAI Get Identity Outliers
results =IAIOutliersApi(api_client).get_identity_outliers()
results = IAIOutliersApi(api_client).get_identity_outliers()
# Below is a request that includes all optional parameters
# results = IAIOutliersApi(api_client).get_identity_outliers(limit, offset, count, type, filters, sorters)
print("The response of IAIOutliersApi->get_identity_outliers:\n")
@@ -257,7 +257,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.latest_outlier_summary import LatestOutlierSummary
@@ -265,13 +264,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
type = 'LOW_SIMILARITY' # str | Type of the identity outliers snapshot to filter on (optional) # str | Type of the identity outliers snapshot to filter on (optional)
try:
# IAI Identity Outliers Latest Summary
results =IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots()
results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots()
# Below is a request that includes all optional parameters
# results = IAIOutliersApi(api_client).get_latest_identity_outlier_snapshots(type)
print("The response of IAIOutliersApi->get_latest_identity_outlier_snapshots:\n")
@@ -320,7 +320,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.outlier_feature_summary import OutlierFeatureSummary
@@ -328,13 +327,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
outlier_feature_id = '04654b66-7561-4090-94f9-abee0722a1af' # str | Contributing feature id # str | Contributing feature id
try:
# Get identity outlier contibuting feature summary
results =IAIOutliersApi(api_client).get_outlier_contributing_feature_summary(outlier_feature_id)
results = IAIOutliersApi(api_client).get_outlier_contributing_feature_summary(outlier_feature_id=outlier_feature_id)
# Below is a request that includes all optional parameters
# results = IAIOutliersApi(api_client).get_outlier_contributing_feature_summary(outlier_feature_id)
print("The response of IAIOutliersApi->get_outlier_contributing_feature_summary:\n")
@@ -388,7 +388,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.outlier_contributing_feature import OutlierContributingFeature
@@ -396,6 +395,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier 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)
@@ -407,7 +407,7 @@ with ApiClient(configuration) as api_client:
try:
# Get identity outlier's contibuting features
results =IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, )
results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id=outlier_id)
# Below is a request that includes all optional parameters
# results = IAIOutliersApi(api_client).get_peer_group_outliers_contributing_features(outlier_id, limit, offset, count, include_translation_messages, sorters)
print("The response of IAIOutliersApi->get_peer_group_outliers_contributing_features:\n")
@@ -452,23 +452,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi
from sailpoint.beta.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] |
request_body = ['request_body_example'] # List[str] |
with ApiClient(configuration) as api_client:
request_body = '''['request_body_example']''' # List[str] |
try:
# IAI Identity Outliers Ignore
new_request_body = RequestBody()
new_request_body.from_json(request_body)
IAIOutliersApi(api_client).ignore_identity_outliers(new_request_body)
new_request_body = RequestBody.from_json(request_body)
IAIOutliersApi(api_client).ignore_identity_outliers(request_body=new_request_body)
# Below is a request that includes all optional parameters
# IAIOutliersApi(api_client).ignore_identity_outliers(new_request_body)
except Exception as e:
@@ -521,7 +518,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.outliers_contributing_feature_access_items import OutliersContributingFeatureAccessItems
@@ -529,6 +525,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
outlier_id = '2c918085842e69ae018432d22ccb212f' # str | The outlier id # str | The outlier id
contributing_feature_name = 'entitlement_count' # str | The name of contributing feature # str | The name of contributing feature
@@ -541,7 +538,7 @@ with ApiClient(configuration) as api_client:
try:
# Gets a list of access items associated with each identity outlier contributing feature
results =IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, )
results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id=outlier_id, contributing_feature_name=contributing_feature_name)
# Below is a request that includes all optional parameters
# results = IAIOutliersApi(api_client).list_outliers_contributing_feature_access_items(outlier_id, contributing_feature_name, limit, offset, count, access_type, sorters)
print("The response of IAIOutliersApi->list_outliers_contributing_feature_access_items:\n")
@@ -586,23 +583,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_outliers_api import IAIOutliersApi
from sailpoint.beta.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] |
request_body = ['request_body_example'] # List[str] |
with ApiClient(configuration) as api_client:
request_body = '''['request_body_example']''' # List[str] |
try:
# IAI Identity Outliers Unignore
new_request_body = RequestBody()
new_request_body.from_json(request_body)
IAIOutliersApi(api_client).un_ignore_identity_outliers(new_request_body)
new_request_body = RequestBody.from_json(request_body)
IAIOutliersApi(api_client).un_ignore_identity_outliers(request_body=new_request_body)
# Below is a request that includes all optional parameters
# IAIOutliersApi(api_client).un_ignore_identity_outliers(new_request_body)
except Exception as e:

4
docs/tools/sdk/python/Reference/Beta/Methods/IAIPeerGroupStrategiesApi.md
View File

@@ -56,7 +56,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_peer_group_strategies_api import IAIPeerGroupStrategiesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.peer_group_member import PeerGroupMember
@@ -64,6 +63,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
strategy = 'entitlement' # str | The strategy used to create peer groups. Currently, 'entitlement' is supported. # str | The strategy used to create peer groups. Currently, 'entitlement' is supported.
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)
@@ -73,7 +73,7 @@ with ApiClient(configuration) as api_client:
try:
# Identity Outliers List
results =IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy, )
results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy=strategy)
# Below is a request that includes all optional parameters
# results = IAIPeerGroupStrategiesApi(api_client).get_peer_group_outliers(strategy, limit, offset, count)
print("The response of IAIPeerGroupStrategiesApi->get_peer_group_outliers:\n")

34
docs/tools/sdk/python/Reference/Beta/Methods/IAIRecommendationsApi.md
View File

@@ -15,13 +15,13 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description
------------- | ------------- | -------------
[**get-recommendations**](#get-recommendations) | **POST** `/recommendations/request` | Returns a Recommendation Based on Object
[**get-recommendations**](#get-recommendations) | **POST** `/recommendations/request` | Returns Recommendation Based on Object
[**get-recommendations-config**](#get-recommendations-config) | **GET** `/recommendations/config` | Get certification recommendation config values
[**update-recommendations-config**](#update-recommendations-config) | **PUT** `/recommendations/config` | Update certification recommendation config values
## get-recommendations
Returns a Recommendation Based on Object
Returns Recommendation Based on Object
The getRecommendations API returns recommendations based on the requested object. The recommendations are invoked by IdentityIQ and IdentityNow plug-ins that retrieve recommendations based on the performed calculations.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-recommendations)
@@ -52,7 +52,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_recommendations_api import IAIRecommendationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.recommendation_request_dto import RecommendationRequestDto
@@ -61,8 +60,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
recommendation_request_dto = {
recommendation_request_dto = '''{
"prescribeMode" : false,
"excludeInterpretations" : false,
"requests" : [ {
@@ -80,13 +80,12 @@ with ApiClient(configuration) as api_client:
} ],
"includeTranslationMessages" : false,
"includeDebugInformation" : true
} # RecommendationRequestDto |
}''' # RecommendationRequestDto |
try:
# Returns a Recommendation Based on Object
new_recommendation_request_dto = RecommendationRequestDto()
new_recommendation_request_dto.from_json(recommendation_request_dto)
results =IAIRecommendationsApi(api_client).get_recommendations(new_recommendation_request_dto)
# Returns Recommendation Based on Object
new_recommendation_request_dto = RecommendationRequestDto.from_json(recommendation_request_dto)
results = IAIRecommendationsApi(api_client).get_recommendations(recommendation_request_dto=new_recommendation_request_dto)
# Below is a request that includes all optional parameters
# results = IAIRecommendationsApi(api_client).get_recommendations(new_recommendation_request_dto)
print("The response of IAIRecommendationsApi->get_recommendations:\n")
@@ -118,6 +117,7 @@ Code | Description | Data Type | Response headers |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response | - |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
### HTTP request headers
@@ -127,7 +127,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_recommendations_api import IAIRecommendationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.recommendation_config_dto import RecommendationConfigDto
@@ -135,12 +134,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get certification recommendation config values
results =IAIRecommendationsApi(api_client).get_recommendations_config()
results = IAIRecommendationsApi(api_client).get_recommendations_config()
# Below is a request that includes all optional parameters
# results = IAIRecommendationsApi(api_client).get_recommendations_config()
print("The response of IAIRecommendationsApi->get_recommendations_config:\n")
@@ -175,6 +175,7 @@ Code | Description | Data Type | Response headers |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response | - |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
### HTTP request headers
@@ -184,7 +185,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_recommendations_api import IAIRecommendationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.recommendation_config_dto import RecommendationConfigDto
@@ -192,19 +192,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
recommendation_config_dto = {
recommendation_config_dto = '''{
"recommenderFeatures" : [ "jobTitle", "location", "peer_group", "department", "active" ],
"peerGroupPercentageThreshold" : 0.5,
"runAutoSelectOnce" : false,
"onlyTuneThreshold" : false
} # RecommendationConfigDto |
}''' # RecommendationConfigDto |
try:
# Update certification recommendation config values
new_recommendation_config_dto = RecommendationConfigDto()
new_recommendation_config_dto.from_json(recommendation_config_dto)
results =IAIRecommendationsApi(api_client).update_recommendations_config(new_recommendation_config_dto)
new_recommendation_config_dto = RecommendationConfigDto.from_json(recommendation_config_dto)
results = IAIRecommendationsApi(api_client).update_recommendations_config(recommendation_config_dto=new_recommendation_config_dto)
# Below is a request that includes all optional parameters
# results = IAIRecommendationsApi(api_client).update_recommendations_config(new_recommendation_config_dto)
print("The response of IAIRecommendationsApi->update_recommendations_config:\n")

147
docs/tools/sdk/python/Reference/Beta/Methods/IAIRoleMiningApi.md
View File

@@ -78,7 +78,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_potential_role_provision_request import RoleMiningPotentialRoleProvisionRequest
@@ -87,23 +86,24 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
min_entitlement_popularity = 0 # int | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0) # int | Minimum popularity required for an entitlement to be included in the provisioned role. (optional) (default to 0)
include_common_access = True # bool | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to True) # bool | Boolean determining whether common access entitlements will be included in the provisioned role. (optional) (default to True)
role_mining_potential_role_provision_request = {
role_mining_potential_role_provision_request = '''{
"includeIdentities" : true,
"roleName" : "Finance - Accounting",
"ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41",
"roleDescription" : "General access for accounting department",
"directlyAssignedEntitlements" : false
} # RoleMiningPotentialRoleProvisionRequest | Required information to create a new role (optional)
}''' # RoleMiningPotentialRoleProvisionRequest | Required information to create a new role (optional)
try:
# Create request to provision a potential role into an actual role.
results =IAIRoleMiningApi(api_client).create_potential_role_provision_request(session_id, potential_role_id, )
results = IAIRoleMiningApi(api_client).create_potential_role_provision_request(session_id=session_id, potential_role_id=potential_role_id)
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).create_potential_role_provision_request(session_id, potential_role_id, min_entitlement_popularity, include_common_access, new_role_mining_potential_role_provision_request)
print("The response of IAIRoleMiningApi->create_potential_role_provision_request:\n")
@@ -148,7 +148,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_session_dto import RoleMiningSessionDto
@@ -157,8 +156,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role_mining_session_dto = {
role_mining_session_dto = '''{
"emailRecipientId" : "2c918090761a5aac0176215c46a62d58",
"prescribedPruneThreshold" : 10,
"pruneThreshold" : 50,
@@ -189,13 +189,12 @@ with ApiClient(configuration) as api_client:
"minNumIdentitiesInPotentialRole" : 20,
"identityCount" : 0,
"type" : "SPECIALIZED"
} # RoleMiningSessionDto | Role mining session parameters
}''' # RoleMiningSessionDto | Role mining session parameters
try:
# Create a role mining session
new_role_mining_session_dto = RoleMiningSessionDto()
new_role_mining_session_dto.from_json(role_mining_session_dto)
results =IAIRoleMiningApi(api_client).create_role_mining_sessions(new_role_mining_session_dto)
new_role_mining_session_dto = RoleMiningSessionDto.from_json(role_mining_session_dto)
results = IAIRoleMiningApi(api_client).create_role_mining_sessions(role_mining_session_dto=new_role_mining_session_dto)
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).create_role_mining_sessions(new_role_mining_session_dto)
print("The response of IAIRoleMiningApi->create_role_mining_sessions:\n")
@@ -241,13 +240,13 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '278359a6-04b7-4669-9468-924cf580964a' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
@@ -256,7 +255,7 @@ with ApiClient(configuration) as api_client:
try:
# Export (download) details for a potential role in a role mining session
results =IAIRoleMiningApi(api_client).download_role_mining_potential_role_zip(session_id, potential_role_id, export_id)
results = IAIRoleMiningApi(api_client).download_role_mining_potential_role_zip(session_id=session_id, potential_role_id=potential_role_id, export_id=export_id)
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).download_role_mining_potential_role_zip(session_id, potential_role_id, export_id)
print("The response of IAIRoleMiningApi->download_role_mining_potential_role_zip:\n")
@@ -301,13 +300,13 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
@@ -315,7 +314,7 @@ with ApiClient(configuration) as api_client:
try:
# Export (download) details for a potential role in a role mining session
results =IAIRoleMiningApi(api_client).export_role_mining_potential_role(session_id, potential_role_id)
results = IAIRoleMiningApi(api_client).export_role_mining_potential_role(session_id=session_id, potential_role_id=potential_role_id)
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).export_role_mining_potential_role(session_id, potential_role_id)
print("The response of IAIRoleMiningApi->export_role_mining_potential_role:\n")
@@ -361,7 +360,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_potential_role_export_request import RoleMiningPotentialRoleExportRequest
@@ -370,18 +368,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '278359a6-04b7-4669-9468-924cf580964a' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
role_mining_potential_role_export_request = {
role_mining_potential_role_export_request = '''{
"minEntitlementPopularity" : 0,
"includeCommonAccess" : true
} # RoleMiningPotentialRoleExportRequest | (optional)
}''' # RoleMiningPotentialRoleExportRequest | (optional)
try:
# Asynchronously export details for a potential role in a role mining session and upload to S3
results =IAIRoleMiningApi(api_client).export_role_mining_potential_role_async(session_id, potential_role_id, )
results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_async(session_id=session_id, potential_role_id=potential_role_id)
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_async(session_id, potential_role_id, new_role_mining_potential_role_export_request)
print("The response of IAIRoleMiningApi->export_role_mining_potential_role_async:\n")
@@ -427,7 +426,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_potential_role_export_response import RoleMiningPotentialRoleExportResponse
@@ -435,6 +433,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '278359a6-04b7-4669-9468-924cf580964a' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
@@ -443,7 +442,7 @@ with ApiClient(configuration) as api_client:
try:
# Retrieve status of a potential role export job
results =IAIRoleMiningApi(api_client).export_role_mining_potential_role_status(session_id, potential_role_id, export_id)
results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_status(session_id=session_id, potential_role_id=potential_role_id, export_id=export_id)
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).export_role_mining_potential_role_status(session_id, potential_role_id, export_id)
print("The response of IAIRoleMiningApi->export_role_mining_potential_role_status:\n")
@@ -492,7 +491,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary
@@ -500,6 +498,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
sorters = 'createdDate' # 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: **createdDate, identityCount, entitlementCount, freshness, quality** (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: **createdDate, identityCount, entitlementCount, freshness, quality** (optional)
filters = '(createdByName co \"int\") and (createdById sw \"2c9180907\") and (type eq \"COMMON\") and ((name co \"entt\") or (saved 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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (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: **createdById**: *eq, sw, co* **createdByName**: *eq, sw, co* **description**: *sw, co* **endDate**: *le, lt* **freshness**: *eq, ge, gt, le, lt* **name**: *eq, sw, co, ge, gt, le, lt* **quality**: *eq, ge, gt, le, lt* **startDate**: *ge, gt* **saved**: *eq* **type**: *eq, ge, gt, le, lt* **scopingMethod**: *eq* **sessionState**: *eq* **identityAttribute**: *co* (optional)
@@ -510,7 +509,7 @@ with ApiClient(configuration) as api_client:
try:
# Retrieves all potential role summaries
results =IAIRoleMiningApi(api_client).get_all_potential_role_summaries()
results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries()
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_all_potential_role_summaries(sorters, filters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_all_potential_role_summaries:\n")
@@ -556,13 +555,13 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
@@ -571,7 +570,7 @@ with ApiClient(configuration) as api_client:
try:
# Retrieves entitlement popularity distribution for a potential role in a role mining session
results =IAIRoleMiningApi(api_client).get_entitlement_distribution_potential_role(session_id, potential_role_id, )
results = IAIRoleMiningApi(api_client).get_entitlement_distribution_potential_role(session_id=session_id, potential_role_id=potential_role_id)
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_entitlement_distribution_potential_role(session_id, potential_role_id, include_common_access)
print("The response of IAIRoleMiningApi->get_entitlement_distribution_potential_role:\n")
@@ -623,7 +622,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_entitlement import RoleMiningEntitlement
@@ -631,6 +629,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
@@ -644,7 +643,7 @@ with ApiClient(configuration) as api_client:
try:
# Retrieves entitlements for a potential role in a role mining session
results =IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id, potential_role_id, )
results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id=session_id, potential_role_id=potential_role_id)
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_entitlements_potential_role(session_id, potential_role_id, include_common_access, sorters, filters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_entitlements_potential_role:\n")
@@ -694,7 +693,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_entitlement import RoleMiningEntitlement
@@ -702,6 +700,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
@@ -714,7 +713,7 @@ with ApiClient(configuration) as api_client:
try:
# Retrieves excluded entitlements for a potential role in a role mining session
results =IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id, potential_role_id, )
results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id=session_id, potential_role_id=potential_role_id)
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_excluded_entitlements_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_excluded_entitlements_potential_role:\n")
@@ -764,7 +763,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_identity import RoleMiningIdentity
@@ -772,6 +770,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
@@ -784,7 +783,7 @@ with ApiClient(configuration) as api_client:
try:
# Retrieves identities for a potential role in a role mining session
results =IAIRoleMiningApi(api_client).get_identities_potential_role(session_id, potential_role_id, )
results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id=session_id, potential_role_id=potential_role_id)
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_identities_potential_role(session_id, potential_role_id, sorters, filters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_identities_potential_role:\n")
@@ -830,7 +829,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_potential_role import RoleMiningPotentialRole
@@ -838,6 +836,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
@@ -845,7 +844,7 @@ with ApiClient(configuration) as api_client:
try:
# Retrieve potential role in session
results =IAIRoleMiningApi(api_client).get_potential_role(session_id, potential_role_id)
results = IAIRoleMiningApi(api_client).get_potential_role(session_id=session_id, potential_role_id=potential_role_id)
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_potential_role(session_id, potential_role_id)
print("The response of IAIRoleMiningApi->get_potential_role:\n")
@@ -895,7 +894,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_potential_role_application import RoleMiningPotentialRoleApplication
@@ -903,6 +901,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '62f28d91-7d9f-4d17-be15-666d5b41d77f' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
@@ -914,7 +913,7 @@ with ApiClient(configuration) as api_client:
try:
# Retrieves the applications of a potential role for a role mining session
results =IAIRoleMiningApi(api_client).get_potential_role_applications(session_id, potential_role_id, )
results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id=session_id, potential_role_id=potential_role_id)
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_potential_role_applications(session_id, potential_role_id, filters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_potential_role_applications:\n")
@@ -964,7 +963,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_potential_role_entitlements import RoleMiningPotentialRoleEntitlements
@@ -972,6 +970,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '62f28d91-7d9f-4d17-be15-666d5b41d77f' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
@@ -983,7 +982,7 @@ with ApiClient(configuration) as api_client:
try:
# Retrieves the entitlements of a potential role for a role mining session
results =IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id, potential_role_id, )
results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id=session_id, potential_role_id=potential_role_id)
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_potential_role_entitlements(session_id, potential_role_id, filters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_potential_role_entitlements:\n")
@@ -1033,7 +1032,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_potential_role_source_usage import RoleMiningPotentialRoleSourceUsage
@@ -1041,6 +1039,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
potential_role_id = 'e0cc5d7d-bf7f-4f81-b2af-8885b09d9923' # str | A potential role id # str | A potential role id
source_id = '2c9180877620c1460176267f336a106f' # str | A source id # str | A source id
@@ -1052,7 +1051,7 @@ with ApiClient(configuration) as api_client:
try:
# Retrieves potential role source usage
results =IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id, source_id, )
results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id=potential_role_id, source_id=source_id)
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_potential_role_source_identity_usage(potential_role_id, source_id, sorters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_potential_role_source_identity_usage:\n")
@@ -1102,7 +1101,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_potential_role_summary import RoleMiningPotentialRoleSummary
@@ -1110,6 +1108,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
sorters = 'createdDate' # 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: **createdDate** (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: **createdDate** (optional)
@@ -1121,7 +1120,7 @@ with ApiClient(configuration) as api_client:
try:
# Retrieve session's potential role summaries
results =IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id, )
results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id=session_id)
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_potential_role_summaries(session_id, sorters, filters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_potential_role_summaries:\n")
@@ -1166,7 +1165,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_potential_role import RoleMiningPotentialRole
@@ -1174,13 +1172,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id # str | A potential role id
try:
# Retrieves a specific potential role
results =IAIRoleMiningApi(api_client).get_role_mining_potential_role(potential_role_id)
results = IAIRoleMiningApi(api_client).get_role_mining_potential_role(potential_role_id=potential_role_id)
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_role_mining_potential_role(potential_role_id)
print("The response of IAIRoleMiningApi->get_role_mining_potential_role:\n")
@@ -1226,7 +1225,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_session_response import RoleMiningSessionResponse
@@ -1234,13 +1232,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be retrieved. # str | The role mining session id to be retrieved.
try:
# Get a role mining session
results =IAIRoleMiningApi(api_client).get_role_mining_session(session_id)
results = IAIRoleMiningApi(api_client).get_role_mining_session(session_id=session_id)
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_role_mining_session(session_id)
print("The response of IAIRoleMiningApi->get_role_mining_session:\n")
@@ -1284,7 +1283,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_session_status import RoleMiningSessionStatus
@@ -1292,13 +1290,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
try:
# Get role mining session status state
results =IAIRoleMiningApi(api_client).get_role_mining_session_status(session_id)
results = IAIRoleMiningApi(api_client).get_role_mining_session_status(session_id=session_id)
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_role_mining_session_status(session_id)
print("The response of IAIRoleMiningApi->get_role_mining_session_status:\n")
@@ -1347,7 +1346,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_session_response import RoleMiningSessionResponse
@@ -1355,6 +1353,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
filters = 'saved eq \"true\" and name sw \"RM Session\"' # 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: **saved**: *eq* **name**: *eq, sw* (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: **saved**: *eq* **name**: *eq, sw* (optional)
sorters = 'createdBy,createdDate' # 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: **createdBy, createdDate** (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: **createdBy, createdDate** (optional)
@@ -1365,7 +1364,7 @@ with ApiClient(configuration) as api_client:
try:
# Retrieves all role mining sessions
results =IAIRoleMiningApi(api_client).get_role_mining_sessions()
results = IAIRoleMiningApi(api_client).get_role_mining_sessions()
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_role_mining_sessions(filters, sorters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_role_mining_sessions:\n")
@@ -1413,7 +1412,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_session_draft_role_dto import RoleMiningSessionDraftRoleDto
@@ -1421,6 +1419,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
sorters = 'modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (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 is supported for the following fields: **modified** (optional)
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)
@@ -1430,7 +1429,7 @@ with ApiClient(configuration) as api_client:
try:
# Retrieves all saved potential roles
results =IAIRoleMiningApi(api_client).get_saved_potential_roles()
results = IAIRoleMiningApi(api_client).get_saved_potential_roles()
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).get_saved_potential_roles(sorters, offset, limit, count)
print("The response of IAIRoleMiningApi->get_saved_potential_roles:\n")
@@ -1490,7 +1489,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.patch_potential_role_request_inner import PatchPotentialRoleRequestInner
@@ -1498,18 +1496,16 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The potential role summary id # str | The potential role summary id
[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}] # List[PatchPotentialRoleRequestInner] |
patch_potential_role_request_inner = [{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}] # List[PatchPotentialRoleRequestInner] |
patch_potential_role_request_inner = '''[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]''' # List[PatchPotentialRoleRequestInner] |
try:
# Update a potential role in session
new_patch_potential_role_request_inner = PatchPotentialRoleRequestInner()
new_patch_potential_role_request_inner.from_json(patch_potential_role_request_inner)
results =IAIRoleMiningApi(api_client).patch_potential_role(session_id, potential_role_id, new_patch_potential_role_request_inner)
new_patch_potential_role_request_inner = PatchPotentialRoleRequestInner.from_json(patch_potential_role_request_inner)
results = IAIRoleMiningApi(api_client).patch_potential_role(session_id=session_id, potential_role_id=potential_role_id, patch_potential_role_request_inner=new_patch_potential_role_request_inner)
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).patch_potential_role(session_id, potential_role_id, new_patch_potential_role_request_inner)
print("The response of IAIRoleMiningApi->patch_potential_role:\n")
@@ -1568,7 +1564,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.patch_potential_role_request_inner import PatchPotentialRoleRequestInner
@@ -1576,17 +1571,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The potential role summary id # str | The potential role summary id
[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}] # List[PatchPotentialRoleRequestInner] |
patch_potential_role_request_inner = [{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}] # List[PatchPotentialRoleRequestInner] |
patch_potential_role_request_inner = '''[{op=remove, path=/description}, {op=replace, path=/description, value=Acct I - Potential Role}, {op=remove, path=/saved}, {op=replace, path=/saved, value=false}, {op=remove, path=/name}, {op=replace, path=/name, value=Potential Role Accounting}]''' # List[PatchPotentialRoleRequestInner] |
try:
# Update a potential role
new_patch_potential_role_request_inner = PatchPotentialRoleRequestInner()
new_patch_potential_role_request_inner.from_json(patch_potential_role_request_inner)
results =IAIRoleMiningApi(api_client).patch_role_mining_potential_role(potential_role_id, new_patch_potential_role_request_inner)
new_patch_potential_role_request_inner = PatchPotentialRoleRequestInner.from_json(patch_potential_role_request_inner)
results = IAIRoleMiningApi(api_client).patch_role_mining_potential_role(potential_role_id=potential_role_id, patch_potential_role_request_inner=new_patch_potential_role_request_inner)
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).patch_role_mining_potential_role(potential_role_id, new_patch_potential_role_request_inner)
print("The response of IAIRoleMiningApi->patch_role_mining_potential_role:\n")
@@ -1633,7 +1626,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.json_patch_operation import JsonPatchOperation
@@ -1641,21 +1633,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id to be patched # str | The role mining session id to be patched
[{op=replace, path=/pruneThreshold, value=83}, {op=replace, path=/minNumIdentitiesInPotentialRole, value=10}, {op=replace, path=/saved, value=false}, {op=replace, path=/name, value=RM Session - 07/10/22}, {op=add, path=/name, value=RM Session - 07/10/22}] # List[JsonPatchOperation] | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session.
json_patch_operation = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session.
json_patch_operation = '''[{op=replace, path=/pruneThreshold, value=83}, {op=replace, path=/minNumIdentitiesInPotentialRole, value=10}, {op=replace, path=/saved, value=false}, {op=replace, path=/name, value=RM Session - 07/10/22}, {op=add, path=/name, value=RM Session - 07/10/22}]''' # List[JsonPatchOperation] | Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session.
try:
# Patch a role mining session
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =IAIRoleMiningApi(api_client).patch_role_mining_session(session_id, new_json_patch_operation)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = IAIRoleMiningApi(api_client).patch_role_mining_session(session_id=session_id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).patch_role_mining_session(session_id, new_json_patch_operation)
print("The response of IAIRoleMiningApi->patch_role_mining_session:\n")
@@ -1701,7 +1687,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.iai_role_mining_api import IAIRoleMiningApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_mining_potential_role import RoleMiningPotentialRole
@@ -1710,19 +1695,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
session_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role mining session id # str | The role mining session id
potential_role_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | A potential role id in a role mining session # str | A potential role id in a role mining session
role_mining_potential_role_edit_entitlements = {
role_mining_potential_role_edit_entitlements = '''{
"ids" : [ "entId1", "entId2" ],
"exclude" : true
} # RoleMiningPotentialRoleEditEntitlements | Role mining session parameters
}''' # RoleMiningPotentialRoleEditEntitlements | Role mining session parameters
try:
# Edit entitlements for a potential role to exclude some entitlements
new_role_mining_potential_role_edit_entitlements = RoleMiningPotentialRoleEditEntitlements()
new_role_mining_potential_role_edit_entitlements.from_json(role_mining_potential_role_edit_entitlements)
results =IAIRoleMiningApi(api_client).update_entitlements_potential_role(session_id, potential_role_id, new_role_mining_potential_role_edit_entitlements)
new_role_mining_potential_role_edit_entitlements = RoleMiningPotentialRoleEditEntitlements.from_json(role_mining_potential_role_edit_entitlements)
results = IAIRoleMiningApi(api_client).update_entitlements_potential_role(session_id=session_id, potential_role_id=potential_role_id, role_mining_potential_role_edit_entitlements=new_role_mining_potential_role_edit_entitlements)
# Below is a request that includes all optional parameters
# results = IAIRoleMiningApi(api_client).update_entitlements_potential_role(session_id, potential_role_id, new_role_mining_potential_role_edit_entitlements)
print("The response of IAIRoleMiningApi->update_entitlements_potential_role:\n")

8
docs/tools/sdk/python/Reference/Beta/Methods/IconsApi.md
View File

@@ -55,13 +55,13 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.icons_api import IconsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
object_type = 'application' # str | Object type # str | Object type
object_id = 'a291e870-48c3-4953-b656-fb5ce2a93169' # str | Object id. # str | Object id.
@@ -69,7 +69,7 @@ with ApiClient(configuration) as api_client:
try:
# Delete an icon
IconsApi(api_client).delete_icon(object_type, object_id)
IconsApi(api_client).delete_icon(object_type=object_type, object_id=object_id)
# Below is a request that includes all optional parameters
# IconsApi(api_client).delete_icon(object_type, object_id)
except Exception as e:
@@ -115,7 +115,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.icons_api import IconsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.set_icon200_response import SetIcon200Response
@@ -123,6 +122,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
object_type = 'application' # str | Object type # str | Object type
object_id = 'a291e870-48c3-4953-b656-fb5ce2a93169' # str | Object id. # str | Object id.
@@ -131,7 +131,7 @@ with ApiClient(configuration) as api_client:
try:
# Update an icon
results =IconsApi(api_client).set_icon(object_type, object_id, image)
results = IconsApi(api_client).set_icon(object_type=object_type, object_id=object_id, image=image)
# Below is a request that includes all optional parameters
# results = IconsApi(api_client).set_icon(object_type, object_id, image)
print("The response of IconsApi->set_icon:\n")

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

@@ -76,20 +76,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identities_api import IdentitiesApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id
try:
# Delete identity
IdentitiesApi(api_client).delete_identity(id)
IdentitiesApi(api_client).delete_identity(id=id)
# Below is a request that includes all optional parameters
# IdentitiesApi(api_client).delete_identity(id)
except Exception as e:
@@ -133,7 +133,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identities_api import IdentitiesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity import Identity
@@ -141,13 +140,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id
try:
# Identity Details
results =IdentitiesApi(api_client).get_identity(id)
results = IdentitiesApi(api_client).get_identity(id=id)
# Below is a request that includes all optional parameters
# results = IdentitiesApi(api_client).get_identity(id)
print("The response of IdentitiesApi->get_identity:\n")
@@ -195,7 +195,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identities_api import IdentitiesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_ownership_association_details import IdentityOwnershipAssociationDetails
@@ -203,13 +202,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = 'ff8081814d2a8036014d701f3fbf53fa' # str | Identity ID. # str | Identity ID.
try:
# Get ownership details
results =IdentitiesApi(api_client).get_identity_ownership_details(identity_id)
results = IdentitiesApi(api_client).get_identity_ownership_details(identity_id=identity_id)
# Below is a request that includes all optional parameters
# results = IdentitiesApi(api_client).get_identity_ownership_details(identity_id)
print("The response of IdentitiesApi->get_identity_ownership_details:\n")
@@ -256,7 +256,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identities_api import IdentitiesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_assignment_dto import RoleAssignmentDto
@@ -264,6 +263,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id
assignment_id = '1cbb0705b38c4226b1334eadd8874086' # str | Assignment Id # str | Assignment Id
@@ -271,7 +271,7 @@ with ApiClient(configuration) as api_client:
try:
# Role assignment details
results =IdentitiesApi(api_client).get_role_assignment(identity_id, assignment_id)
results = IdentitiesApi(api_client).get_role_assignment(identity_id=identity_id, assignment_id=assignment_id)
# Below is a request that includes all optional parameters
# results = IdentitiesApi(api_client).get_role_assignment(identity_id, assignment_id)
print("The response of IdentitiesApi->get_role_assignment:\n")
@@ -319,7 +319,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identities_api import IdentitiesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.get_role_assignments200_response_inner import GetRoleAssignments200ResponseInner
@@ -327,6 +326,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id to get the role assignments for # str | Identity Id to get the role assignments for
role_id = 'e7697a1e96d04db1ac7b0f4544915d2c' # str | Role Id to filter the role assignments with (optional) # str | Role Id to filter the role assignments with (optional)
@@ -335,7 +335,7 @@ with ApiClient(configuration) as api_client:
try:
# List role assignments
results =IdentitiesApi(api_client).get_role_assignments(identity_id, )
results = IdentitiesApi(api_client).get_role_assignments(identity_id=identity_id)
# Below is a request that includes all optional parameters
# results = IdentitiesApi(api_client).get_role_assignments(identity_id, role_id, role_name)
print("The response of IdentitiesApi->get_role_assignments:\n")
@@ -385,7 +385,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identities_api import IdentitiesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity import Identity
@@ -393,6 +392,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
filters = 'id eq \"6c9079b270a266a60170a2779fcb0006\" or correlated eq false' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **alias**: *eq, sw* **firstname**: *eq, sw* **lastname**: *eq, sw* **email**: *eq, sw* **cloudStatus**: *eq* **processingState**: *eq* **correlated**: *eq* **protected**: *eq* (optional)
sorters = 'name,-cloudStatus' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, alias, cloudStatus** (optional)
@@ -404,7 +404,7 @@ with ApiClient(configuration) as api_client:
try:
# List Identities
results =IdentitiesApi(api_client).list_identities()
results = IdentitiesApi(api_client).list_identities()
# Below is a request that includes all optional parameters
# results = IdentitiesApi(api_client).list_identities(filters, sorters, default_filter, count, limit, offset)
print("The response of IdentitiesApi->list_identities:\n")
@@ -450,20 +450,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identities_api import IdentitiesApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id
try:
# Reset an identity
IdentitiesApi(api_client).reset_identity(identity_id)
IdentitiesApi(api_client).reset_identity(identity_id=identity_id)
# Below is a request that includes all optional parameters
# IdentitiesApi(api_client).reset_identity(identity_id)
except Exception as e:
@@ -509,7 +509,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identities_api import IdentitiesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.send_account_verification_request import SendAccountVerificationRequest
@@ -517,18 +516,18 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID
send_account_verification_request = {
send_account_verification_request = '''{
"sourceName" : "Active Directory Source",
"via" : "EMAIL_WORK"
} # SendAccountVerificationRequest |
}''' # SendAccountVerificationRequest |
try:
# Send password reset email
new_send_account_verification_request = SendAccountVerificationRequest()
new_send_account_verification_request.from_json(send_account_verification_request)
IdentitiesApi(api_client).send_identity_verification_account_token(id, new_send_account_verification_request)
new_send_account_verification_request = SendAccountVerificationRequest.from_json(send_account_verification_request)
IdentitiesApi(api_client).send_identity_verification_account_token(id=id, send_account_verification_request=new_send_account_verification_request)
# Below is a request that includes all optional parameters
# IdentitiesApi(api_client).send_identity_verification_account_token(id, new_send_account_verification_request)
except Exception as e:
@@ -577,7 +576,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identities_api import IdentitiesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.invite_identities_request import InviteIdentitiesRequest
@@ -586,17 +584,17 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
invite_identities_request = {
invite_identities_request = '''{
"ids" : [ "2b568c65bc3c4c57a43bd97e3a8e55", "2c9180867769897d01776ed5f125512f" ],
"uninvited" : false
} # InviteIdentitiesRequest |
}''' # InviteIdentitiesRequest |
try:
# Invite identities to register
new_invite_identities_request = InviteIdentitiesRequest()
new_invite_identities_request.from_json(invite_identities_request)
results =IdentitiesApi(api_client).start_identities_invite(new_invite_identities_request)
new_invite_identities_request = InviteIdentitiesRequest.from_json(invite_identities_request)
results = IdentitiesApi(api_client).start_identities_invite(invite_identities_request=new_invite_identities_request)
# Below is a request that includes all optional parameters
# results = IdentitiesApi(api_client).start_identities_invite(new_invite_identities_request)
print("The response of IdentitiesApi->start_identities_invite:\n")
@@ -652,7 +650,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identities_api import IdentitiesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.process_identities_request import ProcessIdentitiesRequest
@@ -661,16 +658,16 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
process_identities_request = {
process_identities_request = '''{
"identityIds" : [ "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8", "ef38f94347e94562b5bb8424a56397d8" ]
} # ProcessIdentitiesRequest |
}''' # ProcessIdentitiesRequest |
try:
# Process a list of identityIds
new_process_identities_request = ProcessIdentitiesRequest()
new_process_identities_request.from_json(process_identities_request)
results =IdentitiesApi(api_client).start_identity_processing(new_process_identities_request)
new_process_identities_request = ProcessIdentitiesRequest.from_json(process_identities_request)
results = IdentitiesApi(api_client).start_identity_processing(process_identities_request=new_process_identities_request)
# Below is a request that includes all optional parameters
# results = IdentitiesApi(api_client).start_identity_processing(new_process_identities_request)
print("The response of IdentitiesApi->start_identity_processing:\n")
@@ -716,7 +713,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identities_api import IdentitiesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_sync_job import IdentitySyncJob
@@ -724,13 +720,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = 'identity_id_example' # str | The Identity id # str | The Identity id
try:
# Attribute synchronization for single identity.
results =IdentitiesApi(api_client).synchronize_attributes_for_identity(identity_id)
results = IdentitiesApi(api_client).synchronize_attributes_for_identity(identity_id=identity_id)
# Below is a request that includes all optional parameters
# results = IdentitiesApi(api_client).synchronize_attributes_for_identity(identity_id)
print("The response of IdentitiesApi->synchronize_attributes_for_identity:\n")

45
docs/tools/sdk/python/Reference/Beta/Methods/IdentityAttributesApi.md
View File

@@ -56,7 +56,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_attributes_api import IdentityAttributesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_attribute import IdentityAttribute
@@ -64,8 +63,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_attribute = {
identity_attribute = '''{
"standard" : false,
"system" : false,
"sources" : [ {
@@ -86,13 +86,12 @@ with ApiClient(configuration) as api_client:
"type" : "string",
"searchable" : false,
"multi" : false
} # IdentityAttribute |
}''' # IdentityAttribute |
try:
# Create Identity Attribute
new_identity_attribute = IdentityAttribute()
new_identity_attribute.from_json(identity_attribute)
results =IdentityAttributesApi(api_client).create_identity_attribute(new_identity_attribute)
new_identity_attribute = IdentityAttribute.from_json(identity_attribute)
results = IdentityAttributesApi(api_client).create_identity_attribute(identity_attribute=new_identity_attribute)
# Below is a request that includes all optional parameters
# results = IdentityAttributesApi(api_client).create_identity_attribute(new_identity_attribute)
print("The response of IdentityAttributesApi->create_identity_attribute:\n")
@@ -138,20 +137,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_attributes_api import IdentityAttributesApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name.
try:
# Delete Identity Attribute
IdentityAttributesApi(api_client).delete_identity_attribute(name)
IdentityAttributesApi(api_client).delete_identity_attribute(name=name)
# Below is a request that includes all optional parameters
# IdentityAttributesApi(api_client).delete_identity_attribute(name)
except Exception as e:
@@ -195,7 +194,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_attributes_api import IdentityAttributesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_attribute_names import IdentityAttributeNames
@@ -203,16 +201,16 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_attribute_names = {
identity_attribute_names = '''{
"ids" : [ "name", "displayName" ]
} # IdentityAttributeNames |
}''' # IdentityAttributeNames |
try:
# Bulk delete Identity Attributes
new_identity_attribute_names = IdentityAttributeNames()
new_identity_attribute_names.from_json(identity_attribute_names)
IdentityAttributesApi(api_client).delete_identity_attributes_in_bulk(new_identity_attribute_names)
new_identity_attribute_names = IdentityAttributeNames.from_json(identity_attribute_names)
IdentityAttributesApi(api_client).delete_identity_attributes_in_bulk(identity_attribute_names=new_identity_attribute_names)
# Below is a request that includes all optional parameters
# IdentityAttributesApi(api_client).delete_identity_attributes_in_bulk(new_identity_attribute_names)
except Exception as e:
@@ -256,7 +254,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_attributes_api import IdentityAttributesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_attribute import IdentityAttribute
@@ -264,13 +261,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name.
try:
# Get Identity Attribute
results =IdentityAttributesApi(api_client).get_identity_attribute(name)
results = IdentityAttributesApi(api_client).get_identity_attribute(name=name)
# Below is a request that includes all optional parameters
# results = IdentityAttributesApi(api_client).get_identity_attribute(name)
print("The response of IdentityAttributesApi->get_identity_attribute:\n")
@@ -318,7 +316,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_attributes_api import IdentityAttributesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_attribute import IdentityAttribute
@@ -326,6 +323,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
include_system = False # bool | Include 'system' attributes in the response. (optional) (default to False) # bool | Include 'system' attributes in the response. (optional) (default to False)
include_silent = False # bool | Include 'silent' attributes in the response. (optional) (default to False) # bool | Include 'silent' attributes in the response. (optional) (default to False)
@@ -335,7 +333,7 @@ with ApiClient(configuration) as api_client:
try:
# List Identity Attributes
results =IdentityAttributesApi(api_client).list_identity_attributes()
results = IdentityAttributesApi(api_client).list_identity_attributes()
# Below is a request that includes all optional parameters
# results = IdentityAttributesApi(api_client).list_identity_attributes(include_system, include_silent, searchable_only, count)
print("The response of IdentityAttributesApi->list_identity_attributes:\n")
@@ -382,7 +380,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_attributes_api import IdentityAttributesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_attribute import IdentityAttribute
@@ -390,9 +387,10 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name.
identity_attribute = {
identity_attribute = '''{
"standard" : false,
"system" : false,
"sources" : [ {
@@ -413,13 +411,12 @@ with ApiClient(configuration) as api_client:
"type" : "string",
"searchable" : false,
"multi" : false
} # IdentityAttribute |
}''' # IdentityAttribute |
try:
# Update Identity Attribute
new_identity_attribute = IdentityAttribute()
new_identity_attribute.from_json(identity_attribute)
results =IdentityAttributesApi(api_client).put_identity_attribute(name, new_identity_attribute)
new_identity_attribute = IdentityAttribute.from_json(identity_attribute)
results = IdentityAttributesApi(api_client).put_identity_attribute(name=name, identity_attribute=new_identity_attribute)
# Below is a request that includes all optional parameters
# results = IdentityAttributesApi(api_client).put_identity_attribute(name, new_identity_attribute)
print("The response of IdentityAttributesApi->put_identity_attribute:\n")

56
docs/tools/sdk/python/Reference/Beta/Methods/IdentityHistoryApi.md
View File

@@ -66,7 +66,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_history_api import IdentityHistoryApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_compare_response import IdentityCompareResponse
@@ -74,13 +73,12 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
snapshot1 = '2007-03-01T13:00:00Z' # str | The snapshot 1 of identity (optional) # str | The snapshot 1 of identity (optional)
snapshot2 = '2008-03-01T13:00:00Z' # str | The snapshot 2 of identity (optional) # str | The snapshot 2 of identity (optional)
access_item_types = ['access_item_types_example'] # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional)
access_item_types = ['access_item_types_example'] # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional)
access_item_types = '''['access_item_types_example']''' # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (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)
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)
@@ -88,7 +86,7 @@ with ApiClient(configuration) as api_client:
try:
# Gets a difference of count for each access item types for the given identity between 2 snapshots
results =IdentityHistoryApi(api_client).compare_identity_snapshots(id, )
results = IdentityHistoryApi(api_client).compare_identity_snapshots(id=id)
# Below is a request that includes all optional parameters
# results = IdentityHistoryApi(api_client).compare_identity_snapshots(id, snapshot1, snapshot2, access_item_types, limit, offset, count)
print("The response of IdentityHistoryApi->compare_identity_snapshots:\n")
@@ -140,7 +138,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_history_api import IdentityHistoryApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.access_item_diff import AccessItemDiff
@@ -148,6 +145,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
access_type = 'role' # str | The specific type which needs to be compared # str | The specific type which needs to be compared
@@ -161,7 +159,7 @@ with ApiClient(configuration) as api_client:
try:
# Gets a list of differences of specific accessType for the given identity between 2 snapshots
results =IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, )
results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id=id, access_type=access_type)
# Below is a request that includes all optional parameters
# results = IdentityHistoryApi(api_client).compare_identity_snapshots_access_type(id, access_type, access_associated, snapshot1, snapshot2, limit, offset, count)
print("The response of IdentityHistoryApi->compare_identity_snapshots_access_type:\n")
@@ -206,7 +204,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_history_api import IdentityHistoryApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_history_response import IdentityHistoryResponse
@@ -214,13 +211,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
try:
# Get latest snapshot of identity
results =IdentityHistoryApi(api_client).get_historical_identity(id)
results = IdentityHistoryApi(api_client).get_historical_identity(id=id)
# Below is a request that includes all optional parameters
# results = IdentityHistoryApi(api_client).get_historical_identity(id)
print("The response of IdentityHistoryApi->get_historical_identity:\n")
@@ -272,7 +270,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_history_api import IdentityHistoryApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.get_historical_identity_events200_response_inner import GetHistoricalIdentityEvents200ResponseInner
@@ -280,15 +277,12 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
var_from = '2024-03-01T13:00:00Z' # str | The optional instant until which access events are returned (optional) # str | The optional instant until which access events are returned (optional)
event_types = ['[AccessAddedEvent, AccessRemovedEvent]'] # List[str] | An optional list of event types to return. If null or empty, all events are returned (optional)
event_types = ['[AccessAddedEvent, AccessRemovedEvent]'] # List[str] | An optional list of event types to return. If null or empty, all events are returned (optional)
access_item_types = ['[entitlement, account]'] # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional)
access_item_types = ['[entitlement, account]'] # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (optional)
event_types = '''['[AccessAddedEvent, AccessRemovedEvent]']''' # List[str] | An optional list of event types to return. If null or empty, all events are returned (optional)
access_item_types = '''['[entitlement, account]']''' # List[str] | An optional list of access item types (app, account, entitlement, etc...) to return. If null or empty, all access items types are returned (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)
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)
@@ -296,7 +290,7 @@ with ApiClient(configuration) as api_client:
try:
# Lists all events for the given identity
results =IdentityHistoryApi(api_client).get_historical_identity_events(id, )
results = IdentityHistoryApi(api_client).get_historical_identity_events(id=id)
# Below is a request that includes all optional parameters
# results = IdentityHistoryApi(api_client).get_historical_identity_events(id, var_from, event_types, access_item_types, limit, offset, count)
print("The response of IdentityHistoryApi->get_historical_identity_events:\n")
@@ -342,7 +336,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_history_api import IdentityHistoryApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_history_response import IdentityHistoryResponse
@@ -350,6 +343,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
var_date = '2007-03-01T13:00:00Z' # str | The specified date # str | The specified date
@@ -357,7 +351,7 @@ with ApiClient(configuration) as api_client:
try:
# Gets an identity snapshot at a given date
results =IdentityHistoryApi(api_client).get_identity_snapshot(id, var_date)
results = IdentityHistoryApi(api_client).get_identity_snapshot(id=id, var_date=var_date)
# Below is a request that includes all optional parameters
# results = IdentityHistoryApi(api_client).get_identity_snapshot(id, var_date)
print("The response of IdentityHistoryApi->get_identity_snapshot:\n")
@@ -408,7 +402,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_history_api import IdentityHistoryApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.metric_response import MetricResponse
@@ -416,6 +409,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
before = '2007-03-01T13:00:00Z' # str | The date before which snapshot summary is required (optional) # str | The date before which snapshot summary is required (optional)
@@ -428,7 +422,7 @@ with ApiClient(configuration) as api_client:
try:
# Gets the summary for the event count for a specific identity
results =IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, )
results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id=id)
# Below is a request that includes all optional parameters
# results = IdentityHistoryApi(api_client).get_identity_snapshot_summary(id, before, interval, time_zone, limit, offset, count)
print("The response of IdentityHistoryApi->get_identity_snapshot_summary:\n")
@@ -473,20 +467,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_history_api import IdentityHistoryApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
try:
# Gets the start date of the identity
results =IdentityHistoryApi(api_client).get_identity_start_date(id)
results = IdentityHistoryApi(api_client).get_identity_start_date(id=id)
# Below is a request that includes all optional parameters
# results = IdentityHistoryApi(api_client).get_identity_start_date(id)
print("The response of IdentityHistoryApi->get_identity_start_date:\n")
@@ -535,7 +529,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_history_api import IdentityHistoryApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_list_item import IdentityListItem
@@ -543,6 +536,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
starts_with_query = 'Ada' # str | This param is used for starts-with search for first, last and display name of the identity (optional) # str | This param is used for starts-with search for first, last and display name of the identity (optional)
is_deleted = true # bool | Indicates if we want to only list down deleted identities or not. (optional) # bool | Indicates if we want to only list down deleted identities or not. (optional)
@@ -553,7 +547,7 @@ with ApiClient(configuration) as api_client:
try:
# Lists all the identities
results =IdentityHistoryApi(api_client).list_historical_identities()
results = IdentityHistoryApi(api_client).list_historical_identities()
# Below is a request that includes all optional parameters
# results = IdentityHistoryApi(api_client).list_historical_identities(starts_with_query, is_deleted, is_active, limit, offset)
print("The response of IdentityHistoryApi->list_historical_identities:\n")
@@ -606,7 +600,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_history_api import IdentityHistoryApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner
@@ -614,6 +607,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
type = 'account' # str | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional) # str | The type of access item for the identity. If not provided, it defaults to account. Types of access items: **accessProfile, account, app, entitlement, role** (optional)
@@ -627,7 +621,7 @@ with ApiClient(configuration) as api_client:
try:
# List Access Items by Identity
results =IdentityHistoryApi(api_client).list_identity_access_items(id, )
results = IdentityHistoryApi(api_client).list_identity_access_items(id=id)
# Below is a request that includes all optional parameters
# results = IdentityHistoryApi(api_client).list_identity_access_items(id, type, filters, sorters, query, limit, count, offset)
print("The response of IdentityHistoryApi->list_identity_access_items:\n")
@@ -675,7 +669,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_history_api import IdentityHistoryApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner
@@ -683,6 +676,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | Identity ID. # str | Identity ID.
var_date = '2007-03-01T13:00:00Z' # str | Specified date. # str | Specified date.
@@ -691,7 +685,7 @@ with ApiClient(configuration) as api_client:
try:
# Get Identity Access Items Snapshot
results =IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, )
results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id=id, var_date=var_date)
# Below is a request that includes all optional parameters
# results = IdentityHistoryApi(api_client).list_identity_snapshot_access_items(id, var_date, type)
print("The response of IdentityHistoryApi->list_identity_snapshot_access_items:\n")
@@ -741,7 +735,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_history_api import IdentityHistoryApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_snapshot_summary_response import IdentitySnapshotSummaryResponse
@@ -749,6 +742,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | The identity id # str | The identity id
start = '2007-03-01T13:00:00Z' # str | The specified start date (optional) # str | The specified start date (optional)
@@ -760,7 +754,7 @@ with ApiClient(configuration) as api_client:
try:
# Lists all the snapshots for the identity
results =IdentityHistoryApi(api_client).list_identity_snapshots(id, )
results = IdentityHistoryApi(api_client).list_identity_snapshots(id=id)
# Below is a request that includes all optional parameters
# results = IdentityHistoryApi(api_client).list_identity_snapshots(id, start, interval, limit, offset, count)
print("The response of IdentityHistoryApi->list_identity_snapshots:\n")

139
docs/tools/sdk/python/Reference/Beta/Methods/IdentityProfilesApi.md
View File

@@ -72,7 +72,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_profile import IdentityProfile
@@ -80,8 +79,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile = {
identity_profile = '''{
"owner" : {
"name" : "William Wilson",
"id" : "2c9180835d191a86015d28455b4b232a",
@@ -129,13 +129,12 @@ with ApiClient(configuration) as api_client:
"name" : "aName",
"modified" : "2023-01-03T21:16:22.432Z",
"id" : "id12345"
} # IdentityProfile |
}''' # IdentityProfile |
try:
# Create Identity Profile
new_identity_profile = IdentityProfile()
new_identity_profile.from_json(identity_profile)
results =IdentityProfilesApi(api_client).create_identity_profile(new_identity_profile)
new_identity_profile = IdentityProfile.from_json(identity_profile)
results = IdentityProfilesApi(api_client).create_identity_profile(identity_profile=new_identity_profile)
# Below is a request that includes all optional parameters
# results = IdentityProfilesApi(api_client).create_identity_profile(new_identity_profile)
print("The response of IdentityProfilesApi->create_identity_profile:\n")
@@ -183,7 +182,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.task_result_simplified import TaskResultSimplified
@@ -191,13 +189,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID.
try:
# Delete Identity Profile
results =IdentityProfilesApi(api_client).delete_identity_profile(identity_profile_id)
results = IdentityProfilesApi(api_client).delete_identity_profile(identity_profile_id=identity_profile_id)
# Below is a request that includes all optional parameters
# results = IdentityProfilesApi(api_client).delete_identity_profile(identity_profile_id)
print("The response of IdentityProfilesApi->delete_identity_profile:\n")
@@ -248,7 +247,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.task_result_simplified import TaskResultSimplified
@@ -256,16 +254,14 @@ 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.
with ApiClient(configuration) as api_client:
request_body = '''['request_body_example']''' # List[str] | Identity Profile bulk delete request body.
try:
# Delete Identity Profiles
new_request_body = RequestBody()
new_request_body.from_json(request_body)
results =IdentityProfilesApi(api_client).delete_identity_profiles(new_request_body)
new_request_body = RequestBody.from_json(request_body)
results = IdentityProfilesApi(api_client).delete_identity_profiles(request_body=new_request_body)
# Below is a request that includes all optional parameters
# results = IdentityProfilesApi(api_client).delete_identity_profiles(new_request_body)
print("The response of IdentityProfilesApi->delete_identity_profiles:\n")
@@ -315,7 +311,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_profile_exported_object import IdentityProfileExportedObject
@@ -323,6 +318,7 @@ 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)
@@ -333,7 +329,7 @@ with ApiClient(configuration) as api_client:
try:
# Export Identity Profiles
results =IdentityProfilesApi(api_client).export_identity_profiles()
results = IdentityProfilesApi(api_client).export_identity_profiles()
# Below is a request that includes all optional parameters
# results = IdentityProfilesApi(api_client).export_identity_profiles(limit, offset, count, filters, sorters)
print("The response of IdentityProfilesApi->export_identity_profiles:\n")
@@ -380,7 +376,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_attribute_config import IdentityAttributeConfig
@@ -388,13 +383,14 @@ 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:
# Default identity attribute config
results =IdentityProfilesApi(api_client).get_default_identity_attribute_config(identity_profile_id)
results = IdentityProfilesApi(api_client).get_default_identity_attribute_config(identity_profile_id=identity_profile_id)
# Below is a request that includes all optional parameters
# results = IdentityProfilesApi(api_client).get_default_identity_attribute_config(identity_profile_id)
print("The response of IdentityProfilesApi->get_default_identity_attribute_config:\n")
@@ -441,7 +437,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_profile import IdentityProfile
@@ -449,13 +444,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID.
try:
# Get Identity Profile
results =IdentityProfilesApi(api_client).get_identity_profile(identity_profile_id)
results = IdentityProfilesApi(api_client).get_identity_profile(identity_profile_id=identity_profile_id)
# Below is a request that includes all optional parameters
# results = IdentityProfilesApi(api_client).get_identity_profile(identity_profile_id)
print("The response of IdentityProfilesApi->get_identity_profile:\n")
@@ -500,7 +496,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_profile_exported_object import IdentityProfileExportedObject
@@ -509,72 +504,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
[sailpoint.beta.IdentityProfileExportedObject()] # List[IdentityProfileExportedObject] | Previously exported Identity Profiles.
identity_profile_exported_object = {
"self" : {
"name" : "HR Active Directory",
"id" : "2c9180835d191a86015d28455b4b232a",
"type" : "SOURCE"
},
"version" : 1,
"object" : {
"owner" : {
"name" : "William Wilson",
"id" : "2c9180835d191a86015d28455b4b232a",
"type" : "IDENTITY"
},
"identityExceptionReportReference" : {
"reportName" : "My annual report",
"taskResultId" : "2b838de9-db9b-abcf-e646-d4f274ad4238"
},
"authoritativeSource" : {
"name" : "HR Active Directory",
"id" : "2c9180835d191a86015d28455b4b232a",
"type" : "SOURCE"
},
"hasTimeBasedAttr" : true,
"created" : "2015-05-28T14:07:17Z",
"description" : "My custom flat file profile",
"identityRefreshRequired" : true,
"identityCount" : 8,
"priority" : 10,
"identityAttributeConfig" : {
"attributeTransforms" : [ {
"transformDefinition" : {
"attributes" : {
"attributeName" : "e-mail",
"sourceName" : "MySource",
"sourceId" : "2c9180877a826e68017a8c0b03da1a53"
},
"type" : "accountAttribute"
},
"identityAttributeName" : "email"
}, {
"transformDefinition" : {
"attributes" : {
"attributeName" : "e-mail",
"sourceName" : "MySource",
"sourceId" : "2c9180877a826e68017a8c0b03da1a53"
},
"type" : "accountAttribute"
},
"identityAttributeName" : "email"
} ],
"enabled" : true
},
"name" : "aName",
"modified" : "2015-05-28T14:07:17Z",
"id" : "id12345"
}
} # List[IdentityProfileExportedObject] | Previously exported Identity Profiles.
with ApiClient(configuration) as api_client:
identity_profile_exported_object = '''[sailpoint.beta.IdentityProfileExportedObject()]''' # List[IdentityProfileExportedObject] | Previously exported Identity Profiles.
try:
# Import Identity Profiles
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)
new_identity_profile_exported_object = IdentityProfileExportedObject.from_json(identity_profile_exported_object)
results = IdentityProfilesApi(api_client).import_identity_profiles(identity_profile_exported_object=new_identity_profile_exported_object)
# Below is a request that includes all optional parameters
# results = IdentityProfilesApi(api_client).import_identity_profiles(new_identity_profile_exported_object)
print("The response of IdentityProfilesApi->import_identity_profiles:\n")
@@ -624,7 +561,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_profile import IdentityProfile
@@ -632,6 +568,7 @@ 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)
@@ -642,7 +579,7 @@ with ApiClient(configuration) as api_client:
try:
# List Identity Profiles
results =IdentityProfilesApi(api_client).list_identity_profiles()
results = IdentityProfilesApi(api_client).list_identity_profiles()
# Below is a request that includes all optional parameters
# results = IdentityProfilesApi(api_client).list_identity_profiles(limit, offset, count, filters, sorters)
print("The response of IdentityProfilesApi->list_identity_profiles:\n")
@@ -689,7 +626,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_preview_request import IdentityPreviewRequest
@@ -698,8 +634,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_preview_request = {
identity_preview_request = '''{
"identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
"identityAttributeConfig" : {
"attributeTransforms" : [ {
@@ -725,13 +662,12 @@ with ApiClient(configuration) as api_client:
} ],
"enabled" : true
}
} # IdentityPreviewRequest | Identity Preview request body.
}''' # IdentityPreviewRequest | Identity Preview request body.
try:
# Generate Identity Profile Preview
new_identity_preview_request = IdentityPreviewRequest()
new_identity_preview_request.from_json(identity_preview_request)
results =IdentityProfilesApi(api_client).show_generate_identity_preview(new_identity_preview_request)
new_identity_preview_request = IdentityPreviewRequest.from_json(identity_preview_request)
results = IdentityProfilesApi(api_client).show_generate_identity_preview(identity_preview_request=new_identity_preview_request)
# Below is a request that includes all optional parameters
# results = IdentityProfilesApi(api_client).show_generate_identity_preview(new_identity_preview_request)
print("The response of IdentityProfilesApi->show_generate_identity_preview:\n")
@@ -782,20 +718,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Identity Profile ID to be processed # str | The Identity Profile ID to be processed
try:
# Process identities under profile
results =IdentityProfilesApi(api_client).sync_identity_profile(identity_profile_id)
results = IdentityProfilesApi(api_client).sync_identity_profile(identity_profile_id=identity_profile_id)
# Below is a request that includes all optional parameters
# results = IdentityProfilesApi(api_client).sync_identity_profile(identity_profile_id)
print("The response of IdentityProfilesApi->sync_identity_profile:\n")
@@ -850,7 +786,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.identity_profiles_api import IdentityProfilesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_profile import IdentityProfile
@@ -859,21 +794,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID.
[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}] # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
json_patch_operation = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
json_patch_operation = '''[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}]''' # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
try:
# Update Identity Profile
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)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = IdentityProfilesApi(api_client).update_identity_profile(identity_profile_id=identity_profile_id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = IdentityProfilesApi(api_client).update_identity_profile(identity_profile_id, new_json_patch_operation)
print("The response of IdentityProfilesApi->update_identity_profile:\n")

38
docs/tools/sdk/python/Reference/Beta/Methods/LaunchersApi.md
View File

@@ -59,7 +59,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.launchers_api import LaunchersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.launcher import Launcher
@@ -68,8 +67,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
launcher_request = {
launcher_request = '''{
"reference" : {
"id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5",
"type" : "WORKFLOW"
@@ -79,13 +79,12 @@ with ApiClient(configuration) as api_client:
"disabled" : false,
"type" : "INTERACTIVE_PROCESS",
"config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}"
} # LauncherRequest | Payload to create a Launcher
}''' # LauncherRequest | Payload to create a Launcher
try:
# Create launcher
new_launcher_request = LauncherRequest()
new_launcher_request.from_json(launcher_request)
results =LaunchersApi(api_client).create_launcher(new_launcher_request)
new_launcher_request = LauncherRequest.from_json(launcher_request)
results = LaunchersApi(api_client).create_launcher(launcher_request=new_launcher_request)
# Below is a request that includes all optional parameters
# results = LaunchersApi(api_client).create_launcher(new_launcher_request)
print("The response of LaunchersApi->create_launcher:\n")
@@ -131,20 +130,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.launchers_api import LaunchersApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be deleted # str | ID of the Launcher to be deleted
try:
# Delete Launcher
LaunchersApi(api_client).delete_launcher(launcher_id)
LaunchersApi(api_client).delete_launcher(launcher_id=launcher_id)
# Below is a request that includes all optional parameters
# LaunchersApi(api_client).delete_launcher(launcher_id)
except Exception as e:
@@ -188,7 +187,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.launchers_api import LaunchersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.launcher import Launcher
@@ -196,13 +194,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be retrieved # str | ID of the Launcher to be retrieved
try:
# Get Launcher by ID
results =LaunchersApi(api_client).get_launcher(launcher_id)
results = LaunchersApi(api_client).get_launcher(launcher_id=launcher_id)
# Below is a request that includes all optional parameters
# results = LaunchersApi(api_client).get_launcher(launcher_id)
print("The response of LaunchersApi->get_launcher:\n")
@@ -250,7 +249,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.launchers_api import LaunchersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.get_launchers200_response import GetLaunchers200Response
@@ -258,6 +256,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
filters = 'disabled 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: **description**: *sw* **disabled**: *eq* **name**: *sw* (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: **description**: *sw* **disabled**: *eq* **name**: *sw* (optional)
next = 'eyJuZXh0IjoxMjN9Cg==' # str | Pagination marker (optional) # str | Pagination marker (optional)
@@ -266,7 +265,7 @@ with ApiClient(configuration) as api_client:
try:
# List all Launchers for tenant
results =LaunchersApi(api_client).get_launchers()
results = LaunchersApi(api_client).get_launchers()
# Below is a request that includes all optional parameters
# results = LaunchersApi(api_client).get_launchers(filters, next, limit)
print("The response of LaunchersApi->get_launchers:\n")
@@ -313,7 +312,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.launchers_api import LaunchersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.launcher import Launcher
@@ -322,9 +320,10 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be replaced # str | ID of the Launcher to be replaced
launcher_request = {
launcher_request = '''{
"reference" : {
"id" : "2fd6ff94-2081-4d29-acbc-83a0a2f744a5",
"type" : "WORKFLOW"
@@ -334,13 +333,12 @@ with ApiClient(configuration) as api_client:
"disabled" : false,
"type" : "INTERACTIVE_PROCESS",
"config" : "{\"workflowId\" : \"6b42d9be-61b6-46af-827e-ea29ba8aa3d9\"}"
} # LauncherRequest | Payload to replace Launcher
}''' # LauncherRequest | Payload to replace Launcher
try:
# Replace Launcher
new_launcher_request = LauncherRequest()
new_launcher_request.from_json(launcher_request)
results =LaunchersApi(api_client).put_launcher(launcher_id, new_launcher_request)
new_launcher_request = LauncherRequest.from_json(launcher_request)
results = LaunchersApi(api_client).put_launcher(launcher_id=launcher_id, launcher_request=new_launcher_request)
# Below is a request that includes all optional parameters
# results = LaunchersApi(api_client).put_launcher(launcher_id, new_launcher_request)
print("The response of LaunchersApi->put_launcher:\n")
@@ -386,7 +384,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.launchers_api import LaunchersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.start_launcher200_response import StartLauncher200Response
@@ -394,13 +391,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
launcher_id = 'e3012408-8b61-4564-ad41-c5ec131c325b' # str | ID of the Launcher to be launched # str | ID of the Launcher to be launched
try:
# Launch a Launcher
results =LaunchersApi(api_client).start_launcher(launcher_id)
results = LaunchersApi(api_client).start_launcher(launcher_id=launcher_id)
# Below is a request that includes all optional parameters
# results = LaunchersApi(api_client).start_launcher(launcher_id)
print("The response of LaunchersApi->start_launcher:\n")

19
docs/tools/sdk/python/Reference/Beta/Methods/LifecycleStatesApi.md
View File

@@ -91,7 +91,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.lifecycle_states_api import LifecycleStatesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.lifecycle_state import LifecycleState
@@ -99,6 +98,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity Profile ID. # str | Identity Profile ID.
lifecycle_state_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Lifecycle State ID. # str | Lifecycle State ID.
@@ -106,7 +106,7 @@ with ApiClient(configuration) as api_client:
try:
# Get Lifecycle State
results =LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, lifecycle_state_id)
results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id)
# Below is a request that includes all optional parameters
# results = LifecycleStatesApi(api_client).get_lifecycle_states(identity_profile_id, lifecycle_state_id)
print("The response of LifecycleStatesApi->get_lifecycle_states:\n")
@@ -156,7 +156,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.lifecycle_states_api import LifecycleStatesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.json_patch_operation import JsonPatchOperation
@@ -165,22 +164,16 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity Profile ID. # str | Identity Profile ID.
lifecycle_state_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Lifecycle State ID. # str | Lifecycle State ID.
[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/accessProfileIds, value=[2c918087742bab150174407a80f3125e, 2c918087742bab150174407a80f3124f]}, {op=replace, path=/accountActions, value=[{action=ENABLE, sourceIds=[2c9180846a2f82fb016a481c1b1560c5, 2c9180846a2f82fb016a481c1b1560cc]}, {action=DISABLE, sourceIds=[2c91808869a0c9980169a207258513fb]}]}, {op=replace, path=/emailNotificationOption, value={notifyManagers=true, notifyAllAdmins=false, notifySpecificUsers=false, emailAddressList=[]}}] # List[JsonPatchOperation] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption
json_patch_operation = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption
json_patch_operation = '''[{op=replace, path=/description, value=Updated description!}, {op=replace, path=/accessProfileIds, value=[2c918087742bab150174407a80f3125e, 2c918087742bab150174407a80f3124f]}, {op=replace, path=/accountActions, value=[{action=ENABLE, sourceIds=[2c9180846a2f82fb016a481c1b1560c5, 2c9180846a2f82fb016a481c1b1560cc]}, {action=DISABLE, sourceIds=[2c91808869a0c9980169a207258513fb]}]}, {op=replace, path=/emailNotificationOption, value={notifyManagers=true, notifyAllAdmins=false, notifySpecificUsers=false, emailAddressList=[]}}]''' # List[JsonPatchOperation] | A list of lifecycle state update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields can be updated: * enabled * description * accountActions * accessProfileIds * emailNotificationOption
try:
# Update Lifecycle State
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =LifecycleStatesApi(api_client).update_lifecycle_states(identity_profile_id, lifecycle_state_id, new_json_patch_operation)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = LifecycleStatesApi(api_client).update_lifecycle_states(identity_profile_id=identity_profile_id, lifecycle_state_id=lifecycle_state_id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = LifecycleStatesApi(api_client).update_lifecycle_states(identity_profile_id, lifecycle_state_id, new_json_patch_operation)
print("The response of LifecycleStatesApi->update_lifecycle_states:\n")

56
docs/tools/sdk/python/Reference/Beta/Methods/MFAConfigurationApi.md
View File

@@ -57,7 +57,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.mfa_configuration_api import MFAConfigurationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.mfa_okta_config import MfaOktaConfig
@@ -65,13 +64,14 @@ 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
results =MFAConfigurationApi(api_client).delete_mfa_config(method)
results = MFAConfigurationApi(api_client).delete_mfa_config(method=method)
# Below is a request that includes all optional parameters
# results = MFAConfigurationApi(api_client).delete_mfa_config(method)
print("The response of MFAConfigurationApi->delete_mfa_config:\n")
@@ -113,7 +113,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.mfa_configuration_api import MFAConfigurationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.mfa_duo_config import MfaDuoConfig
@@ -121,12 +120,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Configuration of Duo MFA method
results =MFAConfigurationApi(api_client).get_mfa_duo_config()
results = MFAConfigurationApi(api_client).get_mfa_duo_config()
# Below is a request that includes all optional parameters
# results = MFAConfigurationApi(api_client).get_mfa_duo_config()
print("The response of MFAConfigurationApi->get_mfa_duo_config:\n")
@@ -171,7 +171,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.mfa_configuration_api import MFAConfigurationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.kba_question import KbaQuestion
@@ -179,13 +178,14 @@ 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
results =MFAConfigurationApi(api_client).get_mfa_kba_config()
results = MFAConfigurationApi(api_client).get_mfa_kba_config()
# Below is a request that includes all optional parameters
# results = MFAConfigurationApi(api_client).get_mfa_kba_config(all_languages)
print("The response of MFAConfigurationApi->get_mfa_kba_config:\n")
@@ -227,7 +227,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.mfa_configuration_api import MFAConfigurationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.mfa_okta_config import MfaOktaConfig
@@ -235,12 +234,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Configuration of Okta MFA method
results =MFAConfigurationApi(api_client).get_mfa_okta_config()
results = MFAConfigurationApi(api_client).get_mfa_okta_config()
# Below is a request that includes all optional parameters
# results = MFAConfigurationApi(api_client).get_mfa_okta_config()
print("The response of MFAConfigurationApi->get_mfa_okta_config:\n")
@@ -285,7 +285,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.mfa_configuration_api import MFAConfigurationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.mfa_duo_config import MfaDuoConfig
@@ -293,8 +292,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
mfa_duo_config = {
mfa_duo_config = '''{
"accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y",
"host" : "example.com",
"configProperties" : {
@@ -304,13 +304,12 @@ with ApiClient(configuration) as api_client:
"mfaMethod" : "duo-web",
"enabled" : true,
"identityAttribute" : "email"
} # MfaDuoConfig |
}''' # MfaDuoConfig |
try:
# Set Duo MFA configuration
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)
new_mfa_duo_config = MfaDuoConfig.from_json(mfa_duo_config)
results = MFAConfigurationApi(api_client).set_mfa_duo_config(mfa_duo_config=new_mfa_duo_config)
# Below is a request that includes all optional parameters
# results = MFAConfigurationApi(api_client).set_mfa_duo_config(new_mfa_duo_config)
print("The response of MFAConfigurationApi->set_mfa_duo_config:\n")
@@ -355,7 +354,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.mfa_configuration_api import MFAConfigurationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.mfa_okta_config import MfaOktaConfig
@@ -363,20 +361,20 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
mfa_okta_config = {
mfa_okta_config = '''{
"accessKey" : "qw123Y3QlA5UqocYpdU3rEkzrK2D497y",
"host" : "example.com",
"mfaMethod" : "okta-verify",
"enabled" : true,
"identityAttribute" : "email"
} # MfaOktaConfig |
}''' # MfaOktaConfig |
try:
# Set Okta MFA configuration
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)
new_mfa_okta_config = MfaOktaConfig.from_json(mfa_okta_config)
results = MFAConfigurationApi(api_client).set_mfa_okta_config(mfa_okta_config=new_mfa_okta_config)
# Below is a request that includes all optional parameters
# results = MFAConfigurationApi(api_client).set_mfa_okta_config(new_mfa_okta_config)
print("The response of MFAConfigurationApi->set_mfa_okta_config:\n")
@@ -421,7 +419,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.mfa_configuration_api import MFAConfigurationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.kba_answer_request_item import KbaAnswerRequestItem
@@ -430,19 +427,14 @@ 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",
"id" : "c54fee53-2d63-4fc5-9259-3e93b9994135"
} # List[KbaAnswerRequestItem] |
with ApiClient(configuration) as api_client:
kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] |
try:
# Set MFA KBA configuration
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)
new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item)
results = MFAConfigurationApi(api_client).set_mfakba_config(kba_answer_request_item=new_kba_answer_request_item)
# Below is a request that includes all optional parameters
# results = MFAConfigurationApi(api_client).set_mfakba_config(new_kba_answer_request_item)
print("The response of MFAConfigurationApi->set_mfakba_config:\n")
@@ -487,7 +479,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.mfa_configuration_api import MFAConfigurationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.mfa_config_test_response import MfaConfigTestResponse
@@ -495,13 +486,14 @@ 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
results =MFAConfigurationApi(api_client).test_mfa_config(method)
results = MFAConfigurationApi(api_client).test_mfa_config(method=method)
# Below is a request that includes all optional parameters
# results = MFAConfigurationApi(api_client).test_mfa_config(method)
print("The response of MFAConfigurationApi->test_mfa_config:\n")

69
docs/tools/sdk/python/Reference/Beta/Methods/MFAControllerApi.md
View File

@@ -55,7 +55,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.mfa_controller_api import MFAControllerApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.send_token_request import SendTokenRequest
@@ -64,17 +63,17 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
send_token_request = {
send_token_request = '''{
"userAlias" : "will.albin",
"deliveryType" : "EMAIL_WORK"
} # SendTokenRequest |
}''' # SendTokenRequest |
try:
# Create and send user token
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)
new_send_token_request = SendTokenRequest.from_json(send_token_request)
results = MFAControllerApi(api_client).create_send_token(send_token_request=new_send_token_request)
# Below is a request that includes all optional parameters
# results = MFAControllerApi(api_client).create_send_token(new_send_token_request)
print("The response of MFAControllerApi->create_send_token:\n")
@@ -120,7 +119,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.mfa_controller_api import MFAControllerApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.verification_poll_request import VerificationPollRequest
@@ -129,17 +127,17 @@ 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 = {
verification_poll_request = '''{
"requestId" : "089899f13a8f4da7824996191587bab9"
} # VerificationPollRequest |
}''' # VerificationPollRequest |
try:
# Polling MFA method by VerificationPollRequest
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)
new_verification_poll_request = VerificationPollRequest.from_json(verification_poll_request)
results = MFAControllerApi(api_client).ping_verification_status(method=method, verification_poll_request=new_verification_poll_request)
# Below is a request that includes all optional parameters
# results = MFAControllerApi(api_client).ping_verification_status(method, new_verification_poll_request)
print("The response of MFAControllerApi->ping_verification_status:\n")
@@ -184,7 +182,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.mfa_controller_api import MFAControllerApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.duo_verification_request import DuoVerificationRequest
@@ -193,17 +190,17 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
duo_verification_request = {
duo_verification_request = '''{
"signedResponse" : "AUTH|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjUzMDg5|f1f5f8ced5b340f3d303b05d0efa0e43b6a8f970:APP|d2lsbC5hbGJpbnxESTZNMFpHSThKQVRWTVpZN0M5VXwxNzAxMjU2NjE5|cb44cf44353f5127edcae31b1da0355f87357db2",
"userId" : "2c9180947f0ef465017f215cbcfd004b"
} # DuoVerificationRequest |
}''' # DuoVerificationRequest |
try:
# Verifying authentication via Duo method
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)
new_duo_verification_request = DuoVerificationRequest.from_json(duo_verification_request)
results = MFAControllerApi(api_client).send_duo_verify_request(duo_verification_request=new_duo_verification_request)
# Below is a request that includes all optional parameters
# results = MFAControllerApi(api_client).send_duo_verify_request(new_duo_verification_request)
print("The response of MFAControllerApi->send_duo_verify_request:\n")
@@ -248,7 +245,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.mfa_controller_api import MFAControllerApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.kba_answer_request_item import KbaAnswerRequestItem
@@ -257,19 +253,14 @@ 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",
"id" : "c54fee53-2d63-4fc5-9259-3e93b9994135"
} # List[KbaAnswerRequestItem] |
with ApiClient(configuration) as api_client:
kba_answer_request_item = '''[{id=173423, answer=822cd15d6c15aa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a0859a2fea34}, {id=c54fee53-2d63-4fc5-9259-3e93b9994135, answer=9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08}]''' # List[KbaAnswerRequestItem] |
try:
# Authenticate KBA provided MFA method
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)
new_kba_answer_request_item = KbaAnswerRequestItem.from_json(kba_answer_request_item)
results = MFAControllerApi(api_client).send_kba_answers(kba_answer_request_item=new_kba_answer_request_item)
# Below is a request that includes all optional parameters
# results = MFAControllerApi(api_client).send_kba_answers(new_kba_answer_request_item)
print("The response of MFAControllerApi->send_kba_answers:\n")
@@ -314,7 +305,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.mfa_controller_api import MFAControllerApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.okta_verification_request import OktaVerificationRequest
@@ -323,16 +313,16 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
okta_verification_request = {
okta_verification_request = '''{
"userId" : "example@mail.com"
} # OktaVerificationRequest |
}''' # OktaVerificationRequest |
try:
# Verifying authentication via Okta method
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)
new_okta_verification_request = OktaVerificationRequest.from_json(okta_verification_request)
results = MFAControllerApi(api_client).send_okta_verify_request(okta_verification_request=new_okta_verification_request)
# Below is a request that includes all optional parameters
# results = MFAControllerApi(api_client).send_okta_verify_request(new_okta_verification_request)
print("The response of MFAControllerApi->send_okta_verify_request:\n")
@@ -377,7 +367,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.mfa_controller_api import MFAControllerApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.token_auth_request import TokenAuthRequest
@@ -386,18 +375,18 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
token_auth_request = {
token_auth_request = '''{
"userAlias" : "will.albin",
"deliveryType" : "EMAIL_WORK",
"token" : "12345"
} # TokenAuthRequest |
}''' # TokenAuthRequest |
try:
# Authenticate Token provided MFA method
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)
new_token_auth_request = TokenAuthRequest.from_json(token_auth_request)
results = MFAControllerApi(api_client).send_token_auth_request(token_auth_request=new_token_auth_request)
# Below is a request that includes all optional parameters
# results = MFAControllerApi(api_client).send_token_auth_request(new_token_auth_request)
print("The response of MFAControllerApi->send_token_auth_request:\n")

15
docs/tools/sdk/python/Reference/Beta/Methods/ManagedClientsApi.md
View File

@@ -58,7 +58,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.managed_clients_api import ManagedClientsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.managed_client_status import ManagedClientStatus
@@ -67,6 +66,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'aClientId' # str | ID of the Managed Client Status to get # str | ID of the Managed Client Status to get
type = sailpoint.beta.ManagedClientType() # ManagedClientType | Type of the Managed Client Status to get # ManagedClientType | Type of the Managed Client Status to get
@@ -74,7 +74,7 @@ with ApiClient(configuration) as api_client:
try:
# Specified Managed Client Status.
results =ManagedClientsApi(api_client).get_managed_client_status(id, type)
results = ManagedClientsApi(api_client).get_managed_client_status(id=id, type=type)
# Below is a request that includes all optional parameters
# results = ManagedClientsApi(api_client).get_managed_client_status(id, type)
print("The response of ManagedClientsApi->get_managed_client_status:\n")
@@ -124,7 +124,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.managed_clients_api import ManagedClientsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.managed_client_status import ManagedClientStatus
@@ -133,9 +132,10 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'aClientId' # str | ID of the Managed Client Status to update # str | ID of the Managed Client Status to update
managed_client_status = {
managed_client_status = '''{
"body" : {
"alertKey" : "",
"id" : "5678",
@@ -160,13 +160,12 @@ with ApiClient(configuration) as api_client:
"type" : "CCG",
"status" : "NORMAL",
"timestamp" : "2020-01-01T00:00:00Z"
} # ManagedClientStatus |
}''' # ManagedClientStatus |
try:
# Handle status request from client
new_managed_client_status = ManagedClientStatus()
new_managed_client_status.from_json(managed_client_status)
results =ManagedClientsApi(api_client).update_managed_client_status(id, new_managed_client_status)
new_managed_client_status = ManagedClientStatus.from_json(managed_client_status)
results = ManagedClientsApi(api_client).update_managed_client_status(id=id, managed_client_status=new_managed_client_status)
# Below is a request that includes all optional parameters
# results = ManagedClientsApi(api_client).update_managed_client_status(id, new_managed_client_status)
print("The response of ManagedClientsApi->update_managed_client_status:\n")

20
docs/tools/sdk/python/Reference/Beta/Methods/ManagedClustersApi.md
View File

@@ -59,7 +59,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration
@@ -67,13 +66,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'aClusterId' # str | ID of ManagedCluster to get log configuration for # str | ID of ManagedCluster to get log configuration for
try:
# Get managed cluster's log configuration
results =ManagedClustersApi(api_client).get_client_log_configuration(id)
results = ManagedClustersApi(api_client).get_client_log_configuration(id=id)
# Below is a request that includes all optional parameters
# results = ManagedClustersApi(api_client).get_client_log_configuration(id)
print("The response of ManagedClustersApi->get_client_log_configuration:\n")
@@ -122,7 +122,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.managed_cluster import ManagedCluster
@@ -130,13 +129,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'aClusterId' # str | ID of the ManagedCluster to get # str | ID of the ManagedCluster to get
try:
# Get a specified ManagedCluster.
results =ManagedClustersApi(api_client).get_managed_cluster(id)
results = ManagedClustersApi(api_client).get_managed_cluster(id=id)
# Below is a request that includes all optional parameters
# results = ManagedClustersApi(api_client).get_managed_cluster(id)
print("The response of ManagedClustersApi->get_managed_cluster:\n")
@@ -187,7 +187,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.managed_cluster import ManagedCluster
@@ -195,6 +194,7 @@ 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)
@@ -204,7 +204,7 @@ with ApiClient(configuration) as api_client:
try:
# Retrieve all Managed Clusters.
results =ManagedClustersApi(api_client).get_managed_clusters()
results = ManagedClustersApi(api_client).get_managed_clusters()
# Below is a request that includes all optional parameters
# results = ManagedClustersApi(api_client).get_managed_clusters(offset, limit, count, filters)
print("The response of ManagedClustersApi->get_managed_clusters:\n")
@@ -254,7 +254,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.managed_clusters_api import ManagedClustersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.client_log_configuration import ClientLogConfiguration
@@ -262,20 +261,21 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'aClusterId' # str | ID of ManagedCluster to update log configuration for # str | ID of ManagedCluster to update log configuration for
client_log_configuration = {
client_log_configuration = '''{
"durationMinutes" : 120,
"rootLevel" : "INFO",
"clientId" : "aClientId",
"expiration" : "2020-12-15T19:13:36.079Z",
"logLevels" : "INFO"
} # ClientLogConfiguration | ClientLogConfiguration for given ManagedCluster
}''' # ClientLogConfiguration | ClientLogConfiguration for given ManagedCluster
try:
# Update managed cluster's log configuration
results =ManagedClustersApi(api_client).put_client_log_configuration(id, new_client_log_configuration)
results = ManagedClustersApi(api_client).put_client_log_configuration(id=id, client_log_configuration=new_client_log_configuration)
# Below is a request that includes all optional parameters
# results = ManagedClustersApi(api_client).put_client_log_configuration(id, new_client_log_configuration)
print("The response of ManagedClustersApi->put_client_log_configuration:\n")

84
docs/tools/sdk/python/Reference/Beta/Methods/MultiHostIntegrationApi.md
View File

@@ -68,7 +68,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.multi_host_integrations import MultiHostIntegrations
@@ -77,8 +76,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
multi_host_integrations_create = {
multi_host_integrations_create = '''{
"owner" : {
"name" : "MyName",
"id" : "2c91808568c529c60168cca6f90c1313",
@@ -103,13 +103,12 @@ with ApiClient(configuration) as api_client:
"name" : "My Multi-Host Integration",
"description" : "This is the Multi-Host Integration.",
"modified" : "2024-01-23T18:08:50.897Z"
} # MultiHostIntegrationsCreate | The specifics of the Multi-Host Integration to create
}''' # MultiHostIntegrationsCreate | The specifics of the Multi-Host Integration to create
try:
# Create Multi-Host Integration
new_multi_host_integrations_create = MultiHostIntegrationsCreate()
new_multi_host_integrations_create.from_json(multi_host_integrations_create)
results =MultiHostIntegrationApi(api_client).create_multi_host_integration(new_multi_host_integrations_create)
new_multi_host_integrations_create = MultiHostIntegrationsCreate.from_json(multi_host_integrations_create)
results = MultiHostIntegrationApi(api_client).create_multi_host_integration(multi_host_integrations_create=new_multi_host_integrations_create)
# Below is a request that includes all optional parameters
# results = MultiHostIntegrationApi(api_client).create_multi_host_integration(new_multi_host_integrations_create)
print("The response of MultiHostIntegrationApi->create_multi_host_integration:\n")
@@ -158,7 +157,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.multi_host_integrations_create_sources import MultiHostIntegrationsCreateSources
@@ -166,28 +164,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration. # str | ID of the Multi-Host Integration.
[sailpoint.beta.MultiHostIntegrationsCreateSources()] # List[MultiHostIntegrationsCreateSources] | The specifics of the sources to create within Multi-Host Integration.
multi_host_integrations_create_sources = {
"connectorAttributes" : {
"authType" : "SQLAuthentication",
"url" : "jdbc:sqlserver://178.18.41.118:1433",
"user" : "username",
"driverClass" : "com.microsoft.sqlserver.jdbc.SQLServerDriver",
"maxSourcesPerAggGroup" : 10,
"maxAllowedSources" : 300
},
"name" : "My Source",
"description" : "This is the corporate directory."
} # List[MultiHostIntegrationsCreateSources] | The specifics of the sources to create within Multi-Host Integration.
multi_host_integrations_create_sources = '''[sailpoint.beta.MultiHostIntegrationsCreateSources()]''' # List[MultiHostIntegrationsCreateSources] | The specifics of the sources to create within Multi-Host Integration.
try:
# Create Sources Within Multi-Host Integration
new_multi_host_integrations_create_sources = MultiHostIntegrationsCreateSources()
new_multi_host_integrations_create_sources.from_json(multi_host_integrations_create_sources)
MultiHostIntegrationApi(api_client).create_sources_within_multi_host(multihost_id, new_multi_host_integrations_create_sources)
new_multi_host_integrations_create_sources = MultiHostIntegrationsCreateSources.from_json(multi_host_integrations_create_sources)
MultiHostIntegrationApi(api_client).create_sources_within_multi_host(multihost_id=multihost_id, multi_host_integrations_create_sources=new_multi_host_integrations_create_sources)
# Below is a request that includes all optional parameters
# MultiHostIntegrationApi(api_client).create_sources_within_multi_host(multihost_id, new_multi_host_integrations_create_sources)
except Exception as e:
@@ -233,20 +218,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of Multi-Host Integration to delete. # str | ID of Multi-Host Integration to delete.
try:
# Delete Multi-Host Integration
MultiHostIntegrationApi(api_client).delete_multi_host(multihost_id)
MultiHostIntegrationApi(api_client).delete_multi_host(multihost_id=multihost_id)
# Below is a request that includes all optional parameters
# MultiHostIntegrationApi(api_client).delete_multi_host(multihost_id)
except Exception as e:
@@ -292,7 +277,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.multi_host_integrations_agg_schedule_update import MultiHostIntegrationsAggScheduleUpdate
@@ -300,13 +284,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
multihost_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update
try:
# Get Account Aggregation Groups Within Multi-Host Integration ID
results =MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id)
results = MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id=multihost_id)
# Below is a request that includes all optional parameters
# results = MultiHostIntegrationApi(api_client).get_acct_aggregation_groups(multihost_id)
print("The response of MultiHostIntegrationApi->get_acct_aggregation_groups:\n")
@@ -354,7 +339,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.multi_host_integrations_agg_schedule_update import MultiHostIntegrationsAggScheduleUpdate
@@ -362,13 +346,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
multi_host_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update
try:
# Get Entitlement Aggregation Groups Within Multi-Host Integration ID
results =MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id)
results = MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id=multi_host_id)
# Below is a request that includes all optional parameters
# results = MultiHostIntegrationApi(api_client).get_entitlement_aggregation_groups(multi_host_id)
print("The response of MultiHostIntegrationApi->get_entitlement_aggregation_groups:\n")
@@ -416,7 +401,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.multi_host_integrations import MultiHostIntegrations
@@ -424,13 +408,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration. # str | ID of the Multi-Host Integration.
try:
# Get Multi-Host Integration By ID
results =MultiHostIntegrationApi(api_client).get_multi_host_integrations(multihost_id)
results = MultiHostIntegrationApi(api_client).get_multi_host_integrations(multihost_id=multihost_id)
# Below is a request that includes all optional parameters
# results = MultiHostIntegrationApi(api_client).get_multi_host_integrations(multihost_id)
print("The response of MultiHostIntegrationApi->get_multi_host_integrations:\n")
@@ -483,7 +468,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.multi_host_integrations import MultiHostIntegrations
@@ -491,6 +475,7 @@ 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)
@@ -502,7 +487,7 @@ with ApiClient(configuration) as api_client:
try:
# List All Existing Multi-Host Integrations
results =MultiHostIntegrationApi(api_client).get_multi_host_integrations_list()
results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list()
# Below is a request that includes all optional parameters
# results = MultiHostIntegrationApi(api_client).get_multi_host_integrations_list(offset, limit, sorters, filters, count, for_subadmin)
print("The response of MultiHostIntegrationApi->get_multi_host_integrations_list:\n")
@@ -550,7 +535,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.source_creation_errors import SourceCreationErrors
@@ -558,13 +542,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
multi_host_id = '004091cb79b04636b88662afa50a4440' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration
try:
# List Multi-Host Source Creation Errors
results =MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id)
results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id=multi_host_id)
# Below is a request that includes all optional parameters
# results = MultiHostIntegrationApi(api_client).get_multi_host_source_creation_errors(multi_host_id)
print("The response of MultiHostIntegrationApi->get_multi_host_source_creation_errors:\n")
@@ -609,7 +594,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.multi_host_integration_template_type import MultiHostIntegrationTemplateType
@@ -617,12 +601,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Multi-Host Integration Types
results =MultiHostIntegrationApi(api_client).get_multihost_integration_types()
results = MultiHostIntegrationApi(api_client).get_multihost_integration_types()
# Below is a request that includes all optional parameters
# results = MultiHostIntegrationApi(api_client).get_multihost_integration_types()
print("The response of MultiHostIntegrationApi->get_multihost_integration_types:\n")
@@ -675,7 +660,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.multi_host_sources import MultiHostSources
@@ -683,6 +667,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
multihost_id = 'aMultiHostId' # str | ID of the Multi-Host Integration to update # str | ID of the Multi-Host Integration to update
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)
@@ -694,7 +679,7 @@ with ApiClient(configuration) as api_client:
try:
# List Sources Within Multi-Host Integration
results =MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id, )
results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id=multihost_id)
# Below is a request that includes all optional parameters
# results = MultiHostIntegrationApi(api_client).get_sources_within_multi_host(multihost_id, offset, limit, sorters, filters, count)
print("The response of MultiHostIntegrationApi->get_sources_within_multi_host:\n")
@@ -742,20 +727,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
multihost_id = '2c91808568c529c60168cca6f90c1324' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration
try:
# Test Configuration For Multi-Host Integration
MultiHostIntegrationApi(api_client).test_connection_multi_host_sources(multihost_id)
MultiHostIntegrationApi(api_client).test_connection_multi_host_sources(multihost_id=multihost_id)
# Below is a request that includes all optional parameters
# MultiHostIntegrationApi(api_client).test_connection_multi_host_sources(multihost_id)
except Exception as e:
@@ -802,7 +787,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.test_source_connection_multihost200_response import TestSourceConnectionMultihost200Response
@@ -810,6 +794,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
multihost_id = '2c91808568c529c60168cca6f90c1326' # str | ID of the Multi-Host Integration # str | ID of the Multi-Host Integration
source_id = '2c91808568c529f60168cca6f90c1324' # str | ID of the source within the Multi-Host Integration # str | ID of the source within the Multi-Host Integration
@@ -817,7 +802,7 @@ with ApiClient(configuration) as api_client:
try:
# Test Configuration For Multi-Host Integration's Single Source
results =MultiHostIntegrationApi(api_client).test_source_connection_multihost(multihost_id, source_id)
results = MultiHostIntegrationApi(api_client).test_source_connection_multihost(multihost_id=multihost_id, source_id=source_id)
# Below is a request that includes all optional parameters
# results = MultiHostIntegrationApi(api_client).test_source_connection_multihost(multihost_id, source_id)
print("The response of MultiHostIntegrationApi->test_source_connection_multihost:\n")
@@ -866,7 +851,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.multi_host_integration_api import MultiHostIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.update_multi_host_sources_request_inner import UpdateMultiHostSourcesRequestInner
@@ -874,17 +858,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
multihost_id = 'anId' # str | ID of the Multi-Host Integration to update. # str | ID of the Multi-Host Integration to update.
[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}] # List[UpdateMultiHostSourcesRequestInner] | This endpoint allows you to update a Multi-Host Integration.
update_multi_host_sources_request_inner = [{op=add, path=/description, value=MDK Multi-Host Integration 222 description}] # List[UpdateMultiHostSourcesRequestInner] | This endpoint allows you to update a Multi-Host Integration.
update_multi_host_sources_request_inner = '''[{op=add, path=/description, value=MDK Multi-Host Integration 222 description}]''' # List[UpdateMultiHostSourcesRequestInner] | This endpoint allows you to update a Multi-Host Integration.
try:
# Update Multi-Host Integration
new_update_multi_host_sources_request_inner = UpdateMultiHostSourcesRequestInner()
new_update_multi_host_sources_request_inner.from_json(update_multi_host_sources_request_inner)
MultiHostIntegrationApi(api_client).update_multi_host_sources(multihost_id, new_update_multi_host_sources_request_inner)
new_update_multi_host_sources_request_inner = UpdateMultiHostSourcesRequestInner.from_json(update_multi_host_sources_request_inner)
MultiHostIntegrationApi(api_client).update_multi_host_sources(multihost_id=multihost_id, update_multi_host_sources_request_inner=new_update_multi_host_sources_request_inner)
# Below is a request that includes all optional parameters
# MultiHostIntegrationApi(api_client).update_multi_host_sources(multihost_id, new_update_multi_host_sources_request_inner)
except Exception as e:

215
docs/tools/sdk/python/Reference/Beta/Methods/NonEmployeeLifecycleManagementApi.md
View File

@@ -113,7 +113,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.non_employee_approval_decision import NonEmployeeApprovalDecision
@@ -122,17 +121,17 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'id_example' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID)
non_employee_approval_decision = {
non_employee_approval_decision = '''{
"comment" : "comment"
} # NonEmployeeApprovalDecision |
}''' # NonEmployeeApprovalDecision |
try:
# Approve a Non-Employee Request
new_non_employee_approval_decision = NonEmployeeApprovalDecision()
new_non_employee_approval_decision.from_json(non_employee_approval_decision)
results =NonEmployeeLifecycleManagementApi(api_client).approve_non_employee_request(id, new_non_employee_approval_decision)
new_non_employee_approval_decision = NonEmployeeApprovalDecision.from_json(non_employee_approval_decision)
results = NonEmployeeLifecycleManagementApi(api_client).approve_non_employee_request(id=id, non_employee_approval_decision=new_non_employee_approval_decision)
# Below is a request that includes all optional parameters
# results = NonEmployeeLifecycleManagementApi(api_client).approve_non_employee_request(id, new_non_employee_approval_decision)
print("The response of NonEmployeeLifecycleManagementApi->approve_non_employee_request:\n")
@@ -179,7 +178,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.non_employee_record import NonEmployeeRecord
@@ -188,8 +186,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
non_employee_request_body = {
non_employee_request_body = '''{
"sourceId" : "2c91808568c529c60168cca6f90c1313",
"firstName" : "William",
"lastName" : "Smith",
@@ -202,13 +201,12 @@ with ApiClient(configuration) as api_client:
"endDate" : "2021-03-25T00:00:00-05:00",
"email" : "william.smith@example.com",
"startDate" : "2020-03-24T00:00:00-05:00"
} # NonEmployeeRequestBody | Non-Employee record creation request body.
}''' # NonEmployeeRequestBody | Non-Employee record creation request body.
try:
# Create Non-Employee Record
new_non_employee_request_body = NonEmployeeRequestBody()
new_non_employee_request_body.from_json(non_employee_request_body)
results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(new_non_employee_request_body)
new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body)
results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(non_employee_request_body=new_non_employee_request_body)
# Below is a request that includes all optional parameters
# results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_record(new_non_employee_request_body)
print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_record:\n")
@@ -253,7 +251,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.non_employee_request import NonEmployeeRequest
@@ -262,8 +259,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
non_employee_request_body = {
non_employee_request_body = '''{
"sourceId" : "2c91808568c529c60168cca6f90c1313",
"firstName" : "William",
"lastName" : "Smith",
@@ -276,13 +274,12 @@ with ApiClient(configuration) as api_client:
"endDate" : "2021-03-25T00:00:00-05:00",
"email" : "william.smith@example.com",
"startDate" : "2020-03-24T00:00:00-05:00"
} # NonEmployeeRequestBody | Non-Employee creation request body
}''' # NonEmployeeRequestBody | Non-Employee creation request body
try:
# Create Non-Employee Request
new_non_employee_request_body = NonEmployeeRequestBody()
new_non_employee_request_body.from_json(non_employee_request_body)
results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(new_non_employee_request_body)
new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body)
results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(non_employee_request_body=new_non_employee_request_body)
# Below is a request that includes all optional parameters
# results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_request(new_non_employee_request_body)
print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_request:\n")
@@ -327,7 +324,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.non_employee_source_request_body import NonEmployeeSourceRequestBody
@@ -336,8 +332,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
non_employee_source_request_body = {
non_employee_source_request_body = '''{
"owner" : {
"id" : "2c91808570313110017040b06f344ec9"
},
@@ -362,13 +359,12 @@ with ApiClient(configuration) as api_client:
}, {
"id" : "2c91808570313110017040b06f344ec9"
} ]
} # NonEmployeeSourceRequestBody | Non-Employee source creation request body.
}''' # NonEmployeeSourceRequestBody | Non-Employee source creation request body.
try:
# Create Non-Employee Source
new_non_employee_source_request_body = NonEmployeeSourceRequestBody()
new_non_employee_source_request_body.from_json(non_employee_source_request_body)
results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source(new_non_employee_source_request_body)
new_non_employee_source_request_body = NonEmployeeSourceRequestBody.from_json(non_employee_source_request_body)
results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source(non_employee_source_request_body=new_non_employee_source_request_body)
# Below is a request that includes all optional parameters
# results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source(new_non_employee_source_request_body)
print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source:\n")
@@ -414,7 +410,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute
@@ -423,22 +418,22 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id
non_employee_schema_attribute_body = {
non_employee_schema_attribute_body = '''{
"helpText" : "The unique identifier for the account",
"label" : "Account Name",
"placeholder" : "Enter a unique user name for this account.",
"type" : "TEXT",
"technicalName" : "account.name",
"required" : true
} # NonEmployeeSchemaAttributeBody |
}''' # NonEmployeeSchemaAttributeBody |
try:
# Create Non-Employee Source Schema Attribute
new_non_employee_schema_attribute_body = NonEmployeeSchemaAttributeBody()
new_non_employee_schema_attribute_body.from_json(non_employee_schema_attribute_body)
results =NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source_schema_attributes(source_id, new_non_employee_schema_attribute_body)
new_non_employee_schema_attribute_body = NonEmployeeSchemaAttributeBody.from_json(non_employee_schema_attribute_body)
results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source_schema_attributes(source_id=source_id, non_employee_schema_attribute_body=new_non_employee_schema_attribute_body)
# Below is a request that includes all optional parameters
# results = NonEmployeeLifecycleManagementApi(api_client).create_non_employee_source_schema_attributes(source_id, new_non_employee_schema_attribute_body)
print("The response of NonEmployeeLifecycleManagementApi->create_non_employee_source_schema_attributes:\n")
@@ -483,20 +478,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID)
try:
# Delete Non-Employee Record
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record(id)
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record(id=id)
# Below is a request that includes all optional parameters
# NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record(id)
except Exception as e:
@@ -541,7 +536,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.delete_non_employee_record_in_bulk_request import DeleteNonEmployeeRecordInBulkRequest
@@ -549,14 +543,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
delete_non_employee_record_in_bulk_request = sailpoint.beta.DeleteNonEmployeeRecordInBulkRequest() # DeleteNonEmployeeRecordInBulkRequest | Non-Employee bulk delete request body.
delete_non_employee_record_in_bulk_request = '''sailpoint.beta.DeleteNonEmployeeRecordInBulkRequest()''' # DeleteNonEmployeeRecordInBulkRequest | Non-Employee bulk delete request body.
try:
# Delete Multiple Non-Employee Records
new_delete_non_employee_record_in_bulk_request = DeleteNonEmployeeRecordInBulkRequest()
new_delete_non_employee_record_in_bulk_request.from_json(delete_non_employee_record_in_bulk_request)
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record_in_bulk(new_delete_non_employee_record_in_bulk_request)
new_delete_non_employee_record_in_bulk_request = DeleteNonEmployeeRecordInBulkRequest.from_json(delete_non_employee_record_in_bulk_request)
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record_in_bulk(delete_non_employee_record_in_bulk_request=new_delete_non_employee_record_in_bulk_request)
# Below is a request that includes all optional parameters
# NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_record_in_bulk(new_delete_non_employee_record_in_bulk_request)
except Exception as e:
@@ -600,20 +594,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee request id in the UUID format # str | Non-Employee request id in the UUID format
try:
# Delete Non-Employee Request
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_request(id)
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_request(id=id)
# Below is a request that includes all optional parameters
# NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_request(id)
except Exception as e:
@@ -658,13 +652,13 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
attribute_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID)
source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id
@@ -672,7 +666,7 @@ with ApiClient(configuration) as api_client:
try:
# Delete Non-Employee Source's Schema Attribute
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_schema_attribute(attribute_id, source_id)
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id)
# Below is a request that includes all optional parameters
# NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_schema_attribute(attribute_id, source_id)
except Exception as e:
@@ -715,20 +709,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c91808b6ef1d43e016efba0ce470904' # str | Source Id # str | Source Id
try:
# Delete Non-Employee Source
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source(source_id)
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source(source_id=source_id)
# Below is a request that includes all optional parameters
# NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source(source_id)
except Exception as e:
@@ -771,20 +765,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id
try:
# Delete all custom schema attributes
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source_schema_attributes(source_id)
NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source_schema_attributes(source_id=source_id)
# Below is a request that includes all optional parameters
# NonEmployeeLifecycleManagementApi(api_client).delete_non_employee_source_schema_attributes(source_id)
except Exception as e:
@@ -828,20 +822,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c918085842e69ae018432d22ccb212f' # str | Source Id (UUID) # str | Source Id (UUID)
try:
# Exports Non-Employee Records to CSV
NonEmployeeLifecycleManagementApi(api_client).export_non_employee_records(id)
NonEmployeeLifecycleManagementApi(api_client).export_non_employee_records(id=id)
# Below is a request that includes all optional parameters
# NonEmployeeLifecycleManagementApi(api_client).export_non_employee_records(id)
except Exception as e:
@@ -887,20 +881,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c918085842e69ae018432d22ccb212f' # str | Source Id (UUID) # str | Source Id (UUID)
try:
# Exports Source Schema Template
NonEmployeeLifecycleManagementApi(api_client).export_non_employee_source_schema_template(id)
NonEmployeeLifecycleManagementApi(api_client).export_non_employee_source_schema_template(id=id)
# Below is a request that includes all optional parameters
# NonEmployeeLifecycleManagementApi(api_client).export_non_employee_source_schema_template(id)
except Exception as e:
@@ -944,7 +938,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.non_employee_approval_item_detail import NonEmployeeApprovalItemDetail
@@ -952,6 +945,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID)
include_detail = 'include-detail=false' # str | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional) # str | The object nonEmployeeRequest will not be included detail when set to false. *Default value is true* (optional)
@@ -959,7 +953,7 @@ with ApiClient(configuration) as api_client:
try:
# Get a non-employee approval item detail
results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval(id, )
results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval(id=id)
# Below is a request that includes all optional parameters
# results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval(id, include_detail)
print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval:\n")
@@ -1004,7 +998,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.non_employee_approval_summary import NonEmployeeApprovalSummary
@@ -1012,13 +1005,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
requested_for = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # str | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # str | The identity (UUID) of the approver for whom for whom the summary is being retrieved. Use \"me\" instead to indicate the current user.
try:
# Get Summary of Non-Employee Approval Requests
results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval_summary(requested_for)
results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval_summary(requested_for=requested_for)
# Below is a request that includes all optional parameters
# results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_approval_summary(requested_for)
print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_approval_summary:\n")
@@ -1064,7 +1058,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.non_employee_bulk_upload_status import NonEmployeeBulkUploadStatus
@@ -1072,13 +1065,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c918085842e69ae018432d22ccb212f' # str | Source ID (UUID) # str | Source ID (UUID)
try:
# Bulk upload status on source
results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_bulk_upload_status(id)
results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_bulk_upload_status(id=id)
# Below is a request that includes all optional parameters
# results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_bulk_upload_status(id)
print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_bulk_upload_status:\n")
@@ -1123,7 +1117,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.non_employee_record import NonEmployeeRecord
@@ -1131,13 +1124,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee record id (UUID) # str | Non-Employee record id (UUID)
try:
# Get a Non-Employee Record
results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_record(id)
results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_record(id=id)
# Below is a request that includes all optional parameters
# results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_record(id)
print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_record:\n")
@@ -1183,7 +1177,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.non_employee_request import NonEmployeeRequest
@@ -1191,13 +1184,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-Employee request id (UUID) # str | Non-Employee request id (UUID)
try:
# Get a Non-Employee Request
results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request(id)
results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request(id=id)
# Below is a request that includes all optional parameters
# results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request(id)
print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request:\n")
@@ -1242,7 +1236,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.non_employee_request_summary import NonEmployeeRequestSummary
@@ -1250,13 +1243,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
requested_for = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # str | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user. # str | The identity (UUID) of the non-employee account manager for whom the summary is being retrieved. Use \"me\" instead to indicate the current user.
try:
# Get Summary of Non-Employee Requests
results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request_summary(requested_for)
results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request_summary(requested_for=requested_for)
# Below is a request that includes all optional parameters
# results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_request_summary(requested_for)
print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_request_summary:\n")
@@ -1302,7 +1296,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute
@@ -1310,6 +1303,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
attribute_id = '2c918085842e69ae018432d22ccb212f' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID)
source_id = '2c918085842e69ae018432d22ccb212f' # str | The Source id # str | The Source id
@@ -1317,7 +1311,7 @@ with ApiClient(configuration) as api_client:
try:
# Get Schema Attribute Non-Employee Source
results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_schema_attribute(attribute_id, source_id)
results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id)
# Below is a request that includes all optional parameters
# results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_schema_attribute(attribute_id, source_id)
print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_schema_attribute:\n")
@@ -1362,7 +1356,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.non_employee_source import NonEmployeeSource
@@ -1370,13 +1363,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c91808b7c28b350017c2a2ec5790aa1' # str | Source Id # str | Source Id
try:
# Get a Non-Employee Source
results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source(source_id)
results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source(source_id=source_id)
# Below is a request that includes all optional parameters
# results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source(source_id)
print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source:\n")
@@ -1422,7 +1416,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.non_employee_schema_attribute import NonEmployeeSchemaAttribute
@@ -1430,13 +1423,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c918085842e69ae018432d22ccb212f' # str | The Source id # str | The Source id
try:
# List Schema Attributes Non-Employee Source
results =NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id)
results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id=source_id)
# Below is a request that includes all optional parameters
# results = NonEmployeeLifecycleManagementApi(api_client).get_non_employee_source_schema_attributes(source_id)
print("The response of NonEmployeeLifecycleManagementApi->get_non_employee_source_schema_attributes:\n")
@@ -1485,7 +1479,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.non_employee_bulk_upload_job import NonEmployeeBulkUploadJob
@@ -1493,6 +1486,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'e136567de87e4d029e60b3c3c55db56d' # str | Source Id (UUID) # str | Source Id (UUID)
data = None # bytearray | # bytearray |
@@ -1500,7 +1494,7 @@ with ApiClient(configuration) as api_client:
try:
# Imports, or Updates, Non-Employee Records
results =NonEmployeeLifecycleManagementApi(api_client).import_non_employee_records_in_bulk(id, data)
results = NonEmployeeLifecycleManagementApi(api_client).import_non_employee_records_in_bulk(id=id, data=data)
# Below is a request that includes all optional parameters
# results = NonEmployeeLifecycleManagementApi(api_client).import_non_employee_records_in_bulk(id, data)
print("The response of NonEmployeeLifecycleManagementApi->import_non_employee_records_in_bulk:\n")
@@ -1550,7 +1544,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.non_employee_approval_item import NonEmployeeApprovalItem
@@ -1558,6 +1551,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
requested_for = 'ac10d20a-841e-1e7d-8184-32d2e22c0179' # str | The identity for whom the request was made. *me* indicates the current user. (optional) # str | The identity for whom the request was made. *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)
@@ -1569,7 +1563,7 @@ with ApiClient(configuration) as api_client:
try:
# Get List of Non-Employee Approval Requests
results =NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approval()
results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approval()
# Below is a request that includes all optional parameters
# results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_approval(requested_for, limit, offset, count, filters, sorters)
print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_approval:\n")
@@ -1618,7 +1612,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.non_employee_record import NonEmployeeRecord
@@ -1626,6 +1619,7 @@ 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)
@@ -1636,7 +1630,7 @@ with ApiClient(configuration) as api_client:
try:
# List Non-Employee Records
results =NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records()
results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records()
# Below is a request that includes all optional parameters
# results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_records(limit, offset, count, sorters, filters)
print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_records:\n")
@@ -1686,7 +1680,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.non_employee_request import NonEmployeeRequest
@@ -1694,6 +1687,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
requested_for = 'me' # str | The identity for whom the request was made. *me* indicates the current user. # str | The identity for whom the request was made. *me* indicates the current user.
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)
@@ -1705,7 +1699,7 @@ with ApiClient(configuration) as api_client:
try:
# List Non-Employee Requests
results =NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, )
results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for=requested_for)
# Below is a request that includes all optional parameters
# results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_requests(requested_for, limit, offset, count, sorters, filters)
print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_requests:\n")
@@ -1757,7 +1751,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.non_employee_source_with_ne_count import NonEmployeeSourceWithNECount
@@ -1765,6 +1758,7 @@ 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)
@@ -1776,7 +1770,7 @@ with ApiClient(configuration) as api_client:
try:
# List Non-Employee Sources
results =NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources()
results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources()
# Below is a request that includes all optional parameters
# results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters)
print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n")
@@ -1823,7 +1817,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.json_patch_operation import JsonPatchOperation
@@ -1832,21 +1825,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID)
[{op=replace, path=/endDate, value={2019-08-23T18:40:35.772Z=null}}] # List[JsonPatchOperation] | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.
json_patch_operation = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.
json_patch_operation = '''[{op=replace, path=/endDate, value={2019-08-23T18:40:35.772Z=null}}]''' # List[JsonPatchOperation] | A list of non-employee update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.
try:
# Patch Non-Employee Record
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id, new_json_patch_operation)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_record(id, new_json_patch_operation)
print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_record:\n")
@@ -1895,7 +1882,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.json_patch_operation import JsonPatchOperation
@@ -1904,22 +1890,16 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
attribute_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Schema Attribute Id (UUID) # str | The Schema Attribute Id (UUID)
source_id = '2c91808b6ef1d43e016efba0ce470904' # str | The Source id # str | The Source id
[{op=replace, path=/label, value={new attribute label=null}}] # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'.
json_patch_operation = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'.
json_patch_operation = '''[{op=replace, path=/label, value={new attribute label=null}}]''' # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following properties are allowed for update ':' 'label', 'helpText', 'placeholder', 'required'.
try:
# Patch Non-Employee Source's Schema Attribute
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_schema_attribute(attribute_id, source_id, new_json_patch_operation)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_schema_attribute(attribute_id=attribute_id, source_id=source_id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_schema_attribute(attribute_id, source_id, new_json_patch_operation)
print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_schema_attribute:\n")
@@ -1965,7 +1945,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.json_patch_operation import JsonPatchOperation
@@ -1974,21 +1953,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
source_id = '2c91808b6ef1d43e016efba0ce470904' # str | Source Id # str | Source Id
[{op=replace, path=/name, value={new name=null}}, {op=replace, path=/approvers, value=[2c91809f703bb37a017040a2fe8748c7, 48b1f463c9e8427db5a5071bd81914b8]}] # List[JsonPatchOperation] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
json_patch_operation = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
json_patch_operation = '''[{op=replace, path=/name, value={new name=null}}, {op=replace, path=/approvers, value=[2c91809f703bb37a017040a2fe8748c7, 48b1f463c9e8427db5a5071bd81914b8]}]''' # List[JsonPatchOperation] | A list of non-employee source update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
try:
# Patch a Non-Employee Source
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id, new_json_patch_operation)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id=source_id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = NonEmployeeLifecycleManagementApi(api_client).patch_non_employee_source(source_id, new_json_patch_operation)
print("The response of NonEmployeeLifecycleManagementApi->patch_non_employee_source:\n")
@@ -2034,7 +2007,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.non_employee_approval_item import NonEmployeeApprovalItem
@@ -2043,17 +2015,17 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'id_example' # str | Non-Employee approval item id (UUID) # str | Non-Employee approval item id (UUID)
non_employee_reject_approval_decision = {
non_employee_reject_approval_decision = '''{
"comment" : "comment"
} # NonEmployeeRejectApprovalDecision |
}''' # NonEmployeeRejectApprovalDecision |
try:
# Reject a Non-Employee Request
new_non_employee_reject_approval_decision = NonEmployeeRejectApprovalDecision()
new_non_employee_reject_approval_decision.from_json(non_employee_reject_approval_decision)
results =NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id, new_non_employee_reject_approval_decision)
new_non_employee_reject_approval_decision = NonEmployeeRejectApprovalDecision.from_json(non_employee_reject_approval_decision)
results = NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id=id, non_employee_reject_approval_decision=new_non_employee_reject_approval_decision)
# Below is a request that includes all optional parameters
# results = NonEmployeeLifecycleManagementApi(api_client).reject_non_employee_request(id, new_non_employee_reject_approval_decision)
print("The response of NonEmployeeLifecycleManagementApi->reject_non_employee_request:\n")
@@ -2100,7 +2072,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.non_employee_lifecycle_management_api import NonEmployeeLifecycleManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.non_employee_record import NonEmployeeRecord
@@ -2109,9 +2080,10 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808b6ef1d43e016efba0ce470904' # str | Non-employee record id (UUID) # str | Non-employee record id (UUID)
non_employee_request_body = {
non_employee_request_body = '''{
"sourceId" : "2c91808568c529c60168cca6f90c1313",
"firstName" : "William",
"lastName" : "Smith",
@@ -2124,13 +2096,12 @@ with ApiClient(configuration) as api_client:
"endDate" : "2021-03-25T00:00:00-05:00",
"email" : "william.smith@example.com",
"startDate" : "2020-03-24T00:00:00-05:00"
} # NonEmployeeRequestBody | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.
}''' # NonEmployeeRequestBody | Non-employee record creation request body. Attributes are restricted by user type. Owner of source can update end date. Organization admins can update all available fields.
try:
# Update Non-Employee Record
new_non_employee_request_body = NonEmployeeRequestBody()
new_non_employee_request_body.from_json(non_employee_request_body)
results =NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id, new_non_employee_request_body)
new_non_employee_request_body = NonEmployeeRequestBody.from_json(non_employee_request_body)
results = NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id=id, non_employee_request_body=new_non_employee_request_body)
# Below is a request that includes all optional parameters
# results = NonEmployeeLifecycleManagementApi(api_client).update_non_employee_record(id, new_non_employee_request_body)
print("The response of NonEmployeeLifecycleManagementApi->update_non_employee_record:\n")

106
docs/tools/sdk/python/Reference/Beta/Methods/NotificationsApi.md
View File

@@ -65,7 +65,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.domain_address import DomainAddress
@@ -74,16 +73,16 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
domain_address = {
domain_address = '''{
"domain" : "sailpoint.com"
} # DomainAddress |
}''' # DomainAddress |
try:
# Verify domain address via DKIM
new_domain_address = DomainAddress()
new_domain_address.from_json(domain_address)
results =NotificationsApi(api_client).create_domain_dkim(new_domain_address)
new_domain_address = DomainAddress.from_json(domain_address)
results = NotificationsApi(api_client).create_domain_dkim(domain_address=new_domain_address)
# Below is a request that includes all optional parameters
# results = NotificationsApi(api_client).create_domain_dkim(new_domain_address)
print("The response of NotificationsApi->create_domain_dkim:\n")
@@ -130,7 +129,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.template_dto import TemplateDto
@@ -138,8 +136,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
template_dto = {
template_dto = '''{
"slackTemplate" : "slackTemplate",
"footer" : "footer",
"teamsTemplate" : "teamsTemplate",
@@ -156,13 +155,12 @@ with ApiClient(configuration) as api_client:
"from" : "$__global.emailFromAddress",
"id" : "c17bea3a-574d-453c-9e04-4365fbf5af0b",
"key" : "cloud_manual_work_item_summary"
} # TemplateDto |
}''' # TemplateDto |
try:
# Create Notification Template
new_template_dto = TemplateDto()
new_template_dto.from_json(template_dto)
results =NotificationsApi(api_client).create_notification_template(new_template_dto)
new_template_dto = TemplateDto.from_json(template_dto)
results = NotificationsApi(api_client).create_notification_template(template_dto=new_template_dto)
# Below is a request that includes all optional parameters
# results = NotificationsApi(api_client).create_notification_template(new_template_dto)
print("The response of NotificationsApi->create_notification_template:\n")
@@ -207,7 +205,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.email_status_dto import EmailStatusDto
@@ -215,19 +212,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
email_status_dto = {
email_status_dto = '''{
"isVerifiedByDomain" : false,
"verificationStatus" : "PENDING",
"id" : "id",
"email" : "sender@example.com"
} # EmailStatusDto |
}''' # EmailStatusDto |
try:
# Create Verified From Address
new_email_status_dto = EmailStatusDto()
new_email_status_dto.from_json(email_status_dto)
results =NotificationsApi(api_client).create_verified_from_address(new_email_status_dto)
new_email_status_dto = EmailStatusDto.from_json(email_status_dto)
results = NotificationsApi(api_client).create_verified_from_address(email_status_dto=new_email_status_dto)
# Below is a request that includes all optional parameters
# results = NotificationsApi(api_client).create_verified_from_address(new_email_status_dto)
print("The response of NotificationsApi->create_verified_from_address:\n")
@@ -272,7 +269,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.template_bulk_delete_dto import TemplateBulkDeleteDto
@@ -280,20 +276,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
[sailpoint.beta.TemplateBulkDeleteDto()] # List[TemplateBulkDeleteDto] |
template_bulk_delete_dto = {
"medium" : "EMAIL",
"locale" : "en",
"key" : "cloud_manual_work_item_summary"
} # List[TemplateBulkDeleteDto] |
with ApiClient(configuration) as api_client:
template_bulk_delete_dto = '''[sailpoint.beta.TemplateBulkDeleteDto()]''' # List[TemplateBulkDeleteDto] |
try:
# Bulk Delete Notification Templates
new_template_bulk_delete_dto = TemplateBulkDeleteDto()
new_template_bulk_delete_dto.from_json(template_bulk_delete_dto)
NotificationsApi(api_client).delete_notification_templates_in_bulk(new_template_bulk_delete_dto)
new_template_bulk_delete_dto = TemplateBulkDeleteDto.from_json(template_bulk_delete_dto)
NotificationsApi(api_client).delete_notification_templates_in_bulk(template_bulk_delete_dto=new_template_bulk_delete_dto)
# Below is a request that includes all optional parameters
# NotificationsApi(api_client).delete_notification_templates_in_bulk(new_template_bulk_delete_dto)
except Exception as e:
@@ -337,20 +327,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'id_example' # str | # str |
try:
# Delete Verified From Address
NotificationsApi(api_client).delete_verified_from_address(id)
NotificationsApi(api_client).delete_verified_from_address(id=id)
# Below is a request that includes all optional parameters
# NotificationsApi(api_client).delete_verified_from_address(id)
except Exception as e:
@@ -390,7 +380,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.dkim_attributes import DkimAttributes
@@ -398,12 +387,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get DKIM Attributes
results =NotificationsApi(api_client).get_dkim_attributes()
results = NotificationsApi(api_client).get_dkim_attributes()
# Below is a request that includes all optional parameters
# results = NotificationsApi(api_client).get_dkim_attributes()
print("The response of NotificationsApi->get_dkim_attributes:\n")
@@ -448,7 +438,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.mail_from_attributes import MailFromAttributes
@@ -456,13 +445,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = 'bobsmith@sailpoint.com' # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status # str | Returns the MX and TXT record to be put in your DNS, as well as the MAIL FROM domain status
try:
# Get MAIL FROM Attributes
results =NotificationsApi(api_client).get_mail_from_attributes(identity_id)
results = NotificationsApi(api_client).get_mail_from_attributes(identity_id=identity_id)
# Below is a request that includes all optional parameters
# results = NotificationsApi(api_client).get_mail_from_attributes(identity_id)
print("The response of NotificationsApi->get_mail_from_attributes:\n")
@@ -507,7 +497,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.template_dto import TemplateDto
@@ -515,13 +504,14 @@ 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 Notification Template # str | Id of the Notification Template
try:
# Get Notification Template By Id
results =NotificationsApi(api_client).get_notification_template(id)
results = NotificationsApi(api_client).get_notification_template(id=id)
# Below is a request that includes all optional parameters
# results = NotificationsApi(api_client).get_notification_template(id)
print("The response of NotificationsApi->get_notification_template:\n")
@@ -564,7 +554,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.notification_template_context import NotificationTemplateContext
@@ -572,12 +561,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Notification Template Context
results =NotificationsApi(api_client).get_notifications_template_context()
results = NotificationsApi(api_client).get_notifications_template_context()
# Below is a request that includes all optional parameters
# results = NotificationsApi(api_client).get_notifications_template_context()
print("The response of NotificationsApi->get_notifications_template_context:\n")
@@ -625,7 +615,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.email_status_dto import EmailStatusDto
@@ -633,6 +622,7 @@ 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)
@@ -643,7 +633,7 @@ with ApiClient(configuration) as api_client:
try:
# List From Addresses
results =NotificationsApi(api_client).list_from_addresses()
results = NotificationsApi(api_client).list_from_addresses()
# Below is a request that includes all optional parameters
# results = NotificationsApi(api_client).list_from_addresses(limit, offset, count, filters, sorters)
print("The response of NotificationsApi->list_from_addresses:\n")
@@ -689,7 +679,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.preferences_dto import PreferencesDto
@@ -697,13 +686,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
key = 'cloud_manual_work_item_summary' # str | The notification key. # str | The notification key.
try:
# List Notification Preferences for tenant.
results =NotificationsApi(api_client).list_notification_preferences(key)
results = NotificationsApi(api_client).list_notification_preferences(key=key)
# Below is a request that includes all optional parameters
# results = NotificationsApi(api_client).list_notification_preferences(key)
print("The response of NotificationsApi->list_notification_preferences:\n")
@@ -750,7 +740,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.template_dto_default import TemplateDtoDefault
@@ -758,6 +747,7 @@ 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)
@@ -766,7 +756,7 @@ with ApiClient(configuration) as api_client:
try:
# List Notification Template Defaults
results =NotificationsApi(api_client).list_notification_template_defaults()
results = NotificationsApi(api_client).list_notification_template_defaults()
# Below is a request that includes all optional parameters
# results = NotificationsApi(api_client).list_notification_template_defaults(limit, offset, filters)
print("The response of NotificationsApi->list_notification_template_defaults:\n")
@@ -813,7 +803,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.template_dto import TemplateDto
@@ -821,6 +810,7 @@ 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)
@@ -829,7 +819,7 @@ with ApiClient(configuration) as api_client:
try:
# List Notification Templates
results =NotificationsApi(api_client).list_notification_templates()
results = NotificationsApi(api_client).list_notification_templates()
# Below is a request that includes all optional parameters
# results = NotificationsApi(api_client).list_notification_templates(limit, offset, filters)
print("The response of NotificationsApi->list_notification_templates:\n")
@@ -874,7 +864,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.mail_from_attributes import MailFromAttributes
@@ -883,17 +872,17 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
mail_from_attributes_dto = {
mail_from_attributes_dto = '''{
"identity" : "BobSmith@sailpoint.com",
"mailFromDomain" : "example.sailpoint.com"
} # MailFromAttributesDto |
}''' # MailFromAttributesDto |
try:
# Change MAIL FROM domain
new_mail_from_attributes_dto = MailFromAttributesDto()
new_mail_from_attributes_dto.from_json(mail_from_attributes_dto)
results =NotificationsApi(api_client).put_mail_from_attributes(new_mail_from_attributes_dto)
new_mail_from_attributes_dto = MailFromAttributesDto.from_json(mail_from_attributes_dto)
results = NotificationsApi(api_client).put_mail_from_attributes(mail_from_attributes_dto=new_mail_from_attributes_dto)
# Below is a request that includes all optional parameters
# results = NotificationsApi(api_client).put_mail_from_attributes(new_mail_from_attributes_dto)
print("The response of NotificationsApi->put_mail_from_attributes:\n")
@@ -939,7 +928,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.notifications_api import NotificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.send_test_notification_request_dto import SendTestNotificationRequestDto
@@ -947,18 +935,18 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
send_test_notification_request_dto = {
send_test_notification_request_dto = '''{
"context" : "{}",
"medium" : "EMAIL",
"key" : "cloud_manual_work_item_summary"
} # SendTestNotificationRequestDto |
}''' # SendTestNotificationRequestDto |
try:
# Send Test Notification
new_send_test_notification_request_dto = SendTestNotificationRequestDto()
new_send_test_notification_request_dto.from_json(send_test_notification_request_dto)
NotificationsApi(api_client).send_test_notification(new_send_test_notification_request_dto)
new_send_test_notification_request_dto = SendTestNotificationRequestDto.from_json(send_test_notification_request_dto)
NotificationsApi(api_client).send_test_notification(send_test_notification_request_dto=new_send_test_notification_request_dto)
# Below is a request that includes all optional parameters
# NotificationsApi(api_client).send_test_notification(new_send_test_notification_request_dto)
except Exception as e:

38
docs/tools/sdk/python/Reference/Beta/Methods/OAuthClientsApi.md
View File

@@ -57,7 +57,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.o_auth_clients_api import OAuthClientsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.create_o_auth_client_request import CreateOAuthClientRequest
@@ -66,8 +65,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
create_o_auth_client_request = {
create_o_auth_client_request = '''{
"internal" : false,
"businessName" : "Acme-Solar",
"description" : "An API client used for the authorization_code, refresh_token, and client_credentials flows",
@@ -83,13 +83,12 @@ with ApiClient(configuration) as api_client:
"scope" : [ "demo:api-client-scope:first", "demo:api-client-scope:second" ],
"name" : "Demo API Client",
"claimsSupported" : false
} # CreateOAuthClientRequest |
}''' # CreateOAuthClientRequest |
try:
# Create OAuth Client
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)
new_create_o_auth_client_request = CreateOAuthClientRequest.from_json(create_o_auth_client_request)
results = OAuthClientsApi(api_client).create_oauth_client(create_o_auth_client_request=new_create_o_auth_client_request)
# Below is a request that includes all optional parameters
# results = OAuthClientsApi(api_client).create_oauth_client(new_create_o_auth_client_request)
print("The response of OAuthClientsApi->create_oauth_client:\n")
@@ -135,20 +134,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.o_auth_clients_api import OAuthClientsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The OAuth client id # str | The OAuth client id
try:
# Delete OAuth Client
OAuthClientsApi(api_client).delete_oauth_client(id)
OAuthClientsApi(api_client).delete_oauth_client(id=id)
# Below is a request that includes all optional parameters
# OAuthClientsApi(api_client).delete_oauth_client(id)
except Exception as e:
@@ -192,7 +191,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.o_auth_clients_api import OAuthClientsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.get_o_auth_client_response import GetOAuthClientResponse
@@ -200,13 +198,14 @@ 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
results =OAuthClientsApi(api_client).get_oauth_client(id)
results = OAuthClientsApi(api_client).get_oauth_client(id=id)
# Below is a request that includes all optional parameters
# results = OAuthClientsApi(api_client).get_oauth_client(id)
print("The response of OAuthClientsApi->get_oauth_client:\n")
@@ -251,7 +250,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.o_auth_clients_api import OAuthClientsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.get_o_auth_client_response import GetOAuthClientResponse
@@ -259,13 +257,14 @@ 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
results =OAuthClientsApi(api_client).list_oauth_clients()
results = OAuthClientsApi(api_client).list_oauth_clients()
# Below is a request that includes all optional parameters
# results = OAuthClientsApi(api_client).list_oauth_clients(filters)
print("The response of OAuthClientsApi->list_oauth_clients:\n")
@@ -314,7 +313,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.o_auth_clients_api import OAuthClientsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.get_o_auth_client_response import GetOAuthClientResponse
@@ -323,21 +321,15 @@ 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 = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # 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 = '''[{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
try:
# Patch OAuth Client
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)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = OAuthClientsApi(api_client).patch_oauth_client(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = OAuthClientsApi(api_client).patch_oauth_client(id, new_json_patch_operation)
print("The response of OAuthClientsApi->patch_oauth_client:\n")

23
docs/tools/sdk/python/Reference/Beta/Methods/OrgConfigApi.md
View File

@@ -52,7 +52,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.org_config_api import OrgConfigApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.org_config import OrgConfig
@@ -60,12 +59,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Org configuration settings
results =OrgConfigApi(api_client).get_org_config()
results = OrgConfigApi(api_client).get_org_config()
# Below is a request that includes all optional parameters
# results = OrgConfigApi(api_client).get_org_config()
print("The response of OrgConfigApi->get_org_config:\n")
@@ -107,19 +107,19 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.org_config_api import OrgConfigApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get list of time zones
results =OrgConfigApi(api_client).get_valid_time_zones()
results = OrgConfigApi(api_client).get_valid_time_zones()
# Below is a request that includes all optional parameters
# results = OrgConfigApi(api_client).get_valid_time_zones()
print("The response of OrgConfigApi->get_valid_time_zones:\n")
@@ -165,7 +165,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.org_config_api import OrgConfigApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.json_patch_operation import JsonPatchOperation
@@ -174,20 +173,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
[{op=replace, path=/timeZone, value=America/Toronto}] # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
json_patch_operation = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
with ApiClient(configuration) as api_client:
json_patch_operation = '''[{op=replace, path=/timeZone, value=America/Toronto}]''' # List[JsonPatchOperation] | A list of schema attribute update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
try:
# Patch an Org configuration property
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =OrgConfigApi(api_client).patch_org_config(new_json_patch_operation)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = OrgConfigApi(api_client).patch_org_config(json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = OrgConfigApi(api_client).patch_org_config(new_json_patch_operation)
print("The response of OrgConfigApi->patch_org_config:\n")

26
docs/tools/sdk/python/Reference/Beta/Methods/PasswordConfigurationApi.md
View File

@@ -60,7 +60,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.password_configuration_api import PasswordConfigurationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.password_org_config import PasswordOrgConfig
@@ -68,19 +67,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
password_org_config = {
password_org_config = '''{
"digitTokenLength" : 9,
"digitTokenEnabled" : true,
"digitTokenDurationMinutes" : 10,
"customInstructionsEnabled" : true
} # PasswordOrgConfig |
}''' # PasswordOrgConfig |
try:
# Create Password Org Config
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)
new_password_org_config = PasswordOrgConfig.from_json(password_org_config)
results = PasswordConfigurationApi(api_client).create_password_org_config(password_org_config=new_password_org_config)
# Below is a request that includes all optional parameters
# results = PasswordConfigurationApi(api_client).create_password_org_config(new_password_org_config)
print("The response of PasswordConfigurationApi->create_password_org_config:\n")
@@ -122,7 +121,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.password_configuration_api import PasswordConfigurationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.password_org_config import PasswordOrgConfig
@@ -130,12 +128,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Password Org Config
results =PasswordConfigurationApi(api_client).get_password_org_config()
results = PasswordConfigurationApi(api_client).get_password_org_config()
# Below is a request that includes all optional parameters
# results = PasswordConfigurationApi(api_client).get_password_org_config()
print("The response of PasswordConfigurationApi->get_password_org_config:\n")
@@ -182,7 +181,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.password_configuration_api import PasswordConfigurationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.password_org_config import PasswordOrgConfig
@@ -190,19 +188,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
password_org_config = {
password_org_config = '''{
"digitTokenLength" : 9,
"digitTokenEnabled" : true,
"digitTokenDurationMinutes" : 10,
"customInstructionsEnabled" : true
} # PasswordOrgConfig |
}''' # PasswordOrgConfig |
try:
# Update Password Org Config
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)
new_password_org_config = PasswordOrgConfig.from_json(password_org_config)
results = PasswordConfigurationApi(api_client).put_password_org_config(password_org_config=new_password_org_config)
# Below is a request that includes all optional parameters
# results = PasswordConfigurationApi(api_client).put_password_org_config(new_password_org_config)
print("The response of PasswordConfigurationApi->put_password_org_config:\n")

6
docs/tools/sdk/python/Reference/Beta/Methods/PasswordDictionaryApi.md
View File

@@ -124,19 +124,19 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.password_dictionary_api import PasswordDictionaryApi
from sailpoint.beta.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
results =PasswordDictionaryApi(api_client).get_password_dictionary()
results = PasswordDictionaryApi(api_client).get_password_dictionary()
# Below is a request that includes all optional parameters
# results = PasswordDictionaryApi(api_client).get_password_dictionary()
print("The response of PasswordDictionaryApi->get_password_dictionary:\n")
@@ -211,13 +211,13 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.password_dictionary_api import PasswordDictionaryApi
from sailpoint.beta.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)

37
docs/tools/sdk/python/Reference/Beta/Methods/PasswordManagementApi.md
View File

@@ -77,7 +77,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.password_management_api import PasswordManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.password_digit_token import PasswordDigitToken
@@ -86,18 +85,18 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
password_digit_token_reset = {
password_digit_token_reset = '''{
"durationMinutes" : 5,
"length" : 8,
"userId" : "Abby.Smith"
} # PasswordDigitTokenReset |
}''' # PasswordDigitTokenReset |
try:
# Generate a digit token
new_password_digit_token_reset = PasswordDigitTokenReset()
new_password_digit_token_reset.from_json(password_digit_token_reset)
results =PasswordManagementApi(api_client).create_digit_token(new_password_digit_token_reset)
new_password_digit_token_reset = PasswordDigitTokenReset.from_json(password_digit_token_reset)
results = PasswordManagementApi(api_client).create_digit_token(password_digit_token_reset=new_password_digit_token_reset)
# Below is a request that includes all optional parameters
# results = PasswordManagementApi(api_client).create_digit_token(new_password_digit_token_reset)
print("The response of PasswordManagementApi->create_digit_token:\n")
@@ -142,7 +141,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.password_management_api import PasswordManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.password_status import PasswordStatus
@@ -150,13 +148,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'id_example' # str | # str |
try:
# Get Password Change Request Status
results =PasswordManagementApi(api_client).get_identity_password_change_status(id)
results = PasswordManagementApi(api_client).get_identity_password_change_status(id=id)
# Below is a request that includes all optional parameters
# results = PasswordManagementApi(api_client).get_identity_password_change_status(id)
print("The response of PasswordManagementApi->get_identity_password_change_status:\n")
@@ -209,7 +208,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.password_management_api import PasswordManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.password_info import PasswordInfo
@@ -218,17 +216,17 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
password_info_query_dto = {
password_info_query_dto = '''{
"sourceName" : "My-AD",
"userName" : "Abby.Smith"
} # PasswordInfoQueryDTO |
}''' # PasswordInfoQueryDTO |
try:
# Query Password Info
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)
new_password_info_query_dto = PasswordInfoQueryDto.from_json(password_info_query_dto)
results = PasswordManagementApi(api_client).query_password_info(password_info_query_dto=new_password_info_query_dto)
# Below is a request that includes all optional parameters
# results = PasswordManagementApi(api_client).query_password_info(new_password_info_query_dto)
print("The response of PasswordManagementApi->query_password_info:\n")
@@ -316,7 +314,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.password_management_api import PasswordManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.password_change_request import PasswordChangeRequest
@@ -325,20 +322,20 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
password_change_request = {
password_change_request = '''{
"sourceId" : "8a807d4c73c545510173c545d4b60246",
"accountId" : "CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com",
"identityId" : "8a807d4c73c545510173c545f0a002ff",
"publicKeyId" : "YWQ2NjQ4MTItZjY0NC00MWExLWFjMjktOGNmMzU3Y2VlNjk2",
"encryptedPassword" : "XzN+YwKgr2C+InkMYFMBG3UtjMEw5ZIql/XFlXo8cJNeslmkplx6vn4kd4/43IF9STBk5RnzR6XmjpEO+FwHDoiBwYZAkAZK/Iswxk4OdybG6Y4MStJCOCiK8osKr35IMMSV/mbO4wAeltoCk7daTWzTGLiI6UaT5tf+F2EgdjJZ7YqM8W8r7aUWsm3p2Xt01Y46ZRx0QaM91QruiIx2rECFT2pUO0wr+7oQ77jypATyGWRtADsu3YcvCk/6U5MqCnXMzKBcRas7NnZdSL/d5H1GglVGz3VLPMaivG4/oL4chOMmFCRl/zVsGxZ9RhN8rxsRGFFKn+rhExTi+bax3A=="
} # PasswordChangeRequest |
}''' # PasswordChangeRequest |
try:
# Set Identity's Password
new_password_change_request = PasswordChangeRequest()
new_password_change_request.from_json(password_change_request)
results =PasswordManagementApi(api_client).set_identity_password(new_password_change_request)
new_password_change_request = PasswordChangeRequest.from_json(password_change_request)
results = PasswordManagementApi(api_client).set_identity_password(password_change_request=new_password_change_request)
# Below is a request that includes all optional parameters
# results = PasswordManagementApi(api_client).set_identity_password(new_password_change_request)
print("The response of PasswordManagementApi->set_identity_password:\n")

34
docs/tools/sdk/python/Reference/Beta/Methods/PasswordPoliciesApi.md
View File

@@ -64,7 +64,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.password_policies_api import PasswordPoliciesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.password_policy_v3_dto import PasswordPolicyV3Dto
@@ -72,8 +71,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
password_policy_v3_dto = {
password_policy_v3_dto = '''{
"validateAgainstAccountName" : true,
"minLength" : 8,
"description" : "Information about the Password Policy",
@@ -105,13 +105,12 @@ with ApiClient(configuration) as api_client:
"requireStrongAuthOffNetwork" : true,
"name" : "PasswordPolicy Example",
"maxLength" : 25
} # PasswordPolicyV3Dto |
}''' # PasswordPolicyV3Dto |
try:
# Create Password Policy
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)
new_password_policy_v3_dto = PasswordPolicyV3Dto.from_json(password_policy_v3_dto)
results = PasswordPoliciesApi(api_client).create_password_policy(password_policy_v3_dto=new_password_policy_v3_dto)
# Below is a request that includes all optional parameters
# results = PasswordPoliciesApi(api_client).create_password_policy(new_password_policy_v3_dto)
print("The response of PasswordPoliciesApi->create_password_policy:\n")
@@ -157,20 +156,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.password_policies_api import PasswordPoliciesApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ff808081838d9e9d01838da6a03e0002' # str | The ID of password policy to delete. # str | The ID of password policy to delete.
try:
# Delete Password Policy by ID
PasswordPoliciesApi(api_client).delete_password_policy(id)
PasswordPoliciesApi(api_client).delete_password_policy(id=id)
# Below is a request that includes all optional parameters
# PasswordPoliciesApi(api_client).delete_password_policy(id)
except Exception as e:
@@ -214,7 +213,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.password_policies_api import PasswordPoliciesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.password_policy_v3_dto import PasswordPolicyV3Dto
@@ -222,13 +220,14 @@ 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
results =PasswordPoliciesApi(api_client).get_password_policy_by_id(id)
results = PasswordPoliciesApi(api_client).get_password_policy_by_id(id=id)
# Below is a request that includes all optional parameters
# results = PasswordPoliciesApi(api_client).get_password_policy_by_id(id)
print("The response of PasswordPoliciesApi->get_password_policy_by_id:\n")
@@ -276,7 +275,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.password_policies_api import PasswordPoliciesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.password_policy_v3_dto import PasswordPolicyV3Dto
@@ -284,6 +282,7 @@ 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)
@@ -292,7 +291,7 @@ with ApiClient(configuration) as api_client:
try:
# List Password Policies
results =PasswordPoliciesApi(api_client).list_password_policies()
results = PasswordPoliciesApi(api_client).list_password_policies()
# Below is a request that includes all optional parameters
# results = PasswordPoliciesApi(api_client).list_password_policies(limit, offset, count)
print("The response of PasswordPoliciesApi->list_password_policies:\n")
@@ -339,7 +338,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.password_policies_api import PasswordPoliciesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.password_policy_v3_dto import PasswordPolicyV3Dto
@@ -347,9 +345,10 @@ 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 = {
password_policy_v3_dto = '''{
"validateAgainstAccountName" : true,
"minLength" : 8,
"description" : "Information about the Password Policy",
@@ -381,13 +380,12 @@ with ApiClient(configuration) as api_client:
"requireStrongAuthOffNetwork" : true,
"name" : "PasswordPolicy Example",
"maxLength" : 25
} # PasswordPolicyV3Dto |
}''' # PasswordPolicyV3Dto |
try:
# Update Password Policy by ID
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)
new_password_policy_v3_dto = PasswordPolicyV3Dto.from_json(password_policy_v3_dto)
results = PasswordPoliciesApi(api_client).set_password_policy(id=id, password_policy_v3_dto=new_password_policy_v3_dto)
# Below is a request that includes all optional parameters
# results = PasswordPoliciesApi(api_client).set_password_policy(id, new_password_policy_v3_dto)
print("The response of PasswordPoliciesApi->set_password_policy:\n")

34
docs/tools/sdk/python/Reference/Beta/Methods/PasswordSyncGroupsApi.md
View File

@@ -86,7 +86,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.password_sync_groups_api import PasswordSyncGroupsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.password_sync_group import PasswordSyncGroup
@@ -94,21 +93,21 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
password_sync_group = {
password_sync_group = '''{
"created" : "2023-03-16T04:00:00Z",
"name" : "Password Sync Group 1",
"modified" : "2023-03-16T04:00:00Z",
"passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501",
"id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd",
"sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ]
} # PasswordSyncGroup |
}''' # PasswordSyncGroup |
try:
# Create Password Sync Group
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)
new_password_sync_group = PasswordSyncGroup.from_json(password_sync_group)
results = PasswordSyncGroupsApi(api_client).create_password_sync_group(password_sync_group=new_password_sync_group)
# Below is a request that includes all optional parameters
# results = PasswordSyncGroupsApi(api_client).create_password_sync_group(new_password_sync_group)
print("The response of PasswordSyncGroupsApi->create_password_sync_group:\n")
@@ -153,20 +152,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.password_sync_groups_api import PasswordSyncGroupsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '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
PasswordSyncGroupsApi(api_client).delete_password_sync_group(id)
PasswordSyncGroupsApi(api_client).delete_password_sync_group(id=id)
# Below is a request that includes all optional parameters
# PasswordSyncGroupsApi(api_client).delete_password_sync_group(id)
except Exception as e:
@@ -210,7 +209,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.password_sync_groups_api import PasswordSyncGroupsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.password_sync_group import PasswordSyncGroup
@@ -218,13 +216,14 @@ 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
results =PasswordSyncGroupsApi(api_client).get_password_sync_group(id)
results = PasswordSyncGroupsApi(api_client).get_password_sync_group(id=id)
# Below is a request that includes all optional parameters
# results = PasswordSyncGroupsApi(api_client).get_password_sync_group(id)
print("The response of PasswordSyncGroupsApi->get_password_sync_group:\n")
@@ -271,7 +270,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.password_sync_groups_api import PasswordSyncGroupsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.password_sync_group import PasswordSyncGroup
@@ -279,6 +277,7 @@ 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)
@@ -287,7 +286,7 @@ with ApiClient(configuration) as api_client:
try:
# Get Password Sync Group List
results =PasswordSyncGroupsApi(api_client).get_password_sync_groups()
results = PasswordSyncGroupsApi(api_client).get_password_sync_groups()
# Below is a request that includes all optional parameters
# results = PasswordSyncGroupsApi(api_client).get_password_sync_groups(limit, offset, count)
print("The response of PasswordSyncGroupsApi->get_password_sync_groups:\n")
@@ -334,7 +333,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.password_sync_groups_api import PasswordSyncGroupsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.password_sync_group import PasswordSyncGroup
@@ -342,22 +340,22 @@ 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 = {
password_sync_group = '''{
"created" : "2023-03-16T04:00:00Z",
"name" : "Password Sync Group 1",
"modified" : "2023-03-16T04:00:00Z",
"passwordPolicyId" : "2c91808d744ba0ce01746f93b6204501",
"id" : "6881f631-3bd5-4213-9c75-8e05cc3e35dd",
"sourceIds" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210500" ]
} # PasswordSyncGroup |
}''' # PasswordSyncGroup |
try:
# Update Password Sync Group by ID
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)
new_password_sync_group = PasswordSyncGroup.from_json(password_sync_group)
results = PasswordSyncGroupsApi(api_client).update_password_sync_group(id=id, password_sync_group=new_password_sync_group)
# Below is a request that includes all optional parameters
# results = PasswordSyncGroupsApi(api_client).update_password_sync_group(id, new_password_sync_group)
print("The response of PasswordSyncGroupsApi->update_password_sync_group:\n")

34
docs/tools/sdk/python/Reference/Beta/Methods/PersonalAccessTokensApi.md
View File

@@ -64,7 +64,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.personal_access_tokens_api import PersonalAccessTokensApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.create_personal_access_token_request import CreatePersonalAccessTokenRequest
@@ -73,18 +72,18 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
create_personal_access_token_request = {
create_personal_access_token_request = '''{
"scope" : [ "demo:personal-access-token-scope:first", "demo:personal-access-token-scope:second" ],
"accessTokenValiditySeconds" : 36900,
"name" : "NodeJS Integration"
} # CreatePersonalAccessTokenRequest | Name and scope of personal access token.
}''' # CreatePersonalAccessTokenRequest | Name and scope of personal access token.
try:
# Create Personal Access Token
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)
new_create_personal_access_token_request = CreatePersonalAccessTokenRequest.from_json(create_personal_access_token_request)
results = PersonalAccessTokensApi(api_client).create_personal_access_token(create_personal_access_token_request=new_create_personal_access_token_request)
# Below is a request that includes all optional parameters
# results = PersonalAccessTokensApi(api_client).create_personal_access_token(new_create_personal_access_token_request)
print("The response of PersonalAccessTokensApi->create_personal_access_token:\n")
@@ -130,20 +129,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.personal_access_tokens_api import PersonalAccessTokensApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The personal access token id # str | The personal access token id
try:
# Delete Personal Access Token
PersonalAccessTokensApi(api_client).delete_personal_access_token(id)
PersonalAccessTokensApi(api_client).delete_personal_access_token(id=id)
# Below is a request that includes all optional parameters
# PersonalAccessTokensApi(api_client).delete_personal_access_token(id)
except Exception as e:
@@ -187,7 +186,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.personal_access_tokens_api import PersonalAccessTokensApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.get_personal_access_token_response import GetPersonalAccessTokenResponse
@@ -195,6 +193,7 @@ 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)
@@ -202,7 +201,7 @@ with ApiClient(configuration) as api_client:
try:
# List Personal Access Tokens
results =PersonalAccessTokensApi(api_client).list_personal_access_tokens()
results = PersonalAccessTokensApi(api_client).list_personal_access_tokens()
# Below is a request that includes all optional parameters
# results = PersonalAccessTokensApi(api_client).list_personal_access_tokens(owner_id, filters)
print("The response of PersonalAccessTokensApi->list_personal_access_tokens:\n")
@@ -249,7 +248,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.personal_access_tokens_api import PersonalAccessTokensApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.get_personal_access_token_response import GetPersonalAccessTokenResponse
@@ -258,21 +256,15 @@ 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 = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # 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 = '''[{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
try:
# Patch Personal Access Token
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)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = PersonalAccessTokensApi(api_client).patch_personal_access_token(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = PersonalAccessTokensApi(api_client).patch_personal_access_token(id, new_json_patch_operation)
print("The response of PersonalAccessTokensApi->patch_personal_access_token:\n")

15
docs/tools/sdk/python/Reference/Beta/Methods/PublicIdentitiesConfigApi.md
View File

@@ -58,7 +58,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.public_identities_config_api import PublicIdentitiesConfigApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.public_identity_config import PublicIdentityConfig
@@ -66,12 +65,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Public Identity Config
results =PublicIdentitiesConfigApi(api_client).get_public_identity_config()
results = PublicIdentitiesConfigApi(api_client).get_public_identity_config()
# Below is a request that includes all optional parameters
# results = PublicIdentitiesConfigApi(api_client).get_public_identity_config()
print("The response of PublicIdentitiesConfigApi->get_public_identity_config:\n")
@@ -116,7 +116,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.public_identities_config_api import PublicIdentitiesConfigApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.public_identity_config import PublicIdentityConfig
@@ -124,8 +123,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
public_identity_config = {
public_identity_config = '''{
"modified" : "2018-06-25T20:22:28.104Z",
"attributes" : [ {
"name" : "Country",
@@ -139,13 +139,12 @@ with ApiClient(configuration) as api_client:
"id" : "2c9180a46faadee4016fb4e018c20639",
"type" : "IDENTITY"
}
} # PublicIdentityConfig |
}''' # PublicIdentityConfig |
try:
# Update Public Identity Config
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)
new_public_identity_config = PublicIdentityConfig.from_json(public_identity_config)
results = PublicIdentitiesConfigApi(api_client).update_public_identity_config(public_identity_config=new_public_identity_config)
# Below is a request that includes all optional parameters
# results = PublicIdentitiesConfigApi(api_client).update_public_identity_config(new_public_identity_config)
print("The response of PublicIdentitiesConfigApi->update_public_identity_config:\n")

12
docs/tools/sdk/python/Reference/Beta/Methods/RequestableObjectsApi.md
View File

@@ -62,7 +62,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.requestable_objects_api import RequestableObjectsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.requestable_object import RequestableObject
@@ -72,15 +71,12 @@ 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.beta.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)
types = [sailpoint.beta.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)
types = '''[sailpoint.beta.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)
term = 'Finance Role' # str | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional) # str | It allows searching requestable access items with a partial match on the name or description. If term is provided, then the *filter* query parameter will be ignored. (optional)
statuses = [sailpoint.beta.RequestableObjectRequestStatus()] # List[RequestableObjectRequestStatus] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional)
statuses = [sailpoint.beta.RequestableObjectRequestStatus()] # List[RequestableObjectRequestStatus] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (optional)
statuses = '''[sailpoint.beta.RequestableObjectRequestStatus()]''' # List[RequestableObjectRequestStatus] | Filters the result to the specified status/statuses, where each status is one of AVAILABLE, ASSIGNED, or PENDING. It is an error to specify this parameter without also specifying an *identity-id* parameter. Additional statuses may be added in the future without notice. (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)
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)
@@ -90,7 +86,7 @@ with ApiClient(configuration) as api_client:
try:
# Requestable Objects List
results =RequestableObjectsApi(api_client).list_requestable_objects()
results = RequestableObjectsApi(api_client).list_requestable_objects()
# Below is a request that includes all optional parameters
# 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")

36
docs/tools/sdk/python/Reference/Beta/Methods/RoleInsightsApi.md
View File

@@ -58,7 +58,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.role_insights_api import RoleInsightsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_insights_response import RoleInsightsResponse
@@ -66,12 +65,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Generate insights for roles
results =RoleInsightsApi(api_client).create_role_insight_requests()
results = RoleInsightsApi(api_client).create_role_insight_requests()
# Below is a request that includes all optional parameters
# results = RoleInsightsApi(api_client).create_role_insight_requests()
print("The response of RoleInsightsApi->create_role_insight_requests:\n")
@@ -117,13 +117,13 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.role_insights_api import RoleInsightsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id
sorters = 'identitiesWithAccess' # 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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (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: **identitiesWithAccess** The default sort is **identitiesWithAccess** in descending order. (optional)
@@ -132,7 +132,7 @@ with ApiClient(configuration) as api_client:
try:
# Download entitlement insights for a role
results =RoleInsightsApi(api_client).download_role_insights_entitlements_changes(insight_id, )
results = RoleInsightsApi(api_client).download_role_insights_entitlements_changes(insight_id=insight_id)
# Below is a request that includes all optional parameters
# results = RoleInsightsApi(api_client).download_role_insights_entitlements_changes(insight_id, sorters, filters)
print("The response of RoleInsightsApi->download_role_insights_entitlements_changes:\n")
@@ -183,7 +183,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.role_insights_api import RoleInsightsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_insights_identities import RoleInsightsIdentities
@@ -191,6 +190,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id
entitlement_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The entitlement id # str | The entitlement id
@@ -204,7 +204,7 @@ with ApiClient(configuration) as api_client:
try:
# Get identities for a suggested entitlement (for a role)
results =RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id, entitlement_id, )
results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id=insight_id, entitlement_id=entitlement_id)
# Below is a request that includes all optional parameters
# results = RoleInsightsApi(api_client).get_entitlement_changes_identities(insight_id, entitlement_id, has_entitlement, offset, limit, count, sorters, filters)
print("The response of RoleInsightsApi->get_entitlement_changes_identities:\n")
@@ -248,7 +248,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.role_insights_api import RoleInsightsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_insight import RoleInsight
@@ -256,13 +255,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id
try:
# Get a single role insight
results =RoleInsightsApi(api_client).get_role_insight(insight_id)
results = RoleInsightsApi(api_client).get_role_insight(insight_id=insight_id)
# Below is a request that includes all optional parameters
# results = RoleInsightsApi(api_client).get_role_insight(insight_id)
print("The response of RoleInsightsApi->get_role_insight:\n")
@@ -310,7 +310,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.role_insights_api import RoleInsightsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_insight import RoleInsight
@@ -318,6 +317,7 @@ 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)
@@ -328,7 +328,7 @@ with ApiClient(configuration) as api_client:
try:
# Get role insights
results =RoleInsightsApi(api_client).get_role_insights()
results = RoleInsightsApi(api_client).get_role_insights()
# Below is a request that includes all optional parameters
# results = RoleInsightsApi(api_client).get_role_insights(offset, limit, count, sorters, filters)
print("The response of RoleInsightsApi->get_role_insights:\n")
@@ -373,7 +373,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.role_insights_api import RoleInsightsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_insights_entitlement import RoleInsightsEntitlement
@@ -381,6 +380,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id
filters = 'name sw \"r\"' # 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* **description**: *sw* (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* **description**: *sw* (optional)
@@ -388,7 +388,7 @@ with ApiClient(configuration) as api_client:
try:
# Get current entitlement for a role
results =RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id, )
results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id=insight_id)
# Below is a request that includes all optional parameters
# results = RoleInsightsApi(api_client).get_role_insights_current_entitlements(insight_id, filters)
print("The response of RoleInsightsApi->get_role_insights_current_entitlements:\n")
@@ -434,7 +434,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.role_insights_api import RoleInsightsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_insights_entitlement_changes import RoleInsightsEntitlementChanges
@@ -442,6 +441,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
insight_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insight id # str | The role insight id
sorters = 'sorters_example' # 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: **identitiesWithAccess, 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: **identitiesWithAccess, name** (optional)
@@ -450,7 +450,7 @@ with ApiClient(configuration) as api_client:
try:
# Get entitlement insights for a role
results =RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id, )
results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id=insight_id)
# Below is a request that includes all optional parameters
# results = RoleInsightsApi(api_client).get_role_insights_entitlements_changes(insight_id, sorters, filters)
print("The response of RoleInsightsApi->get_role_insights_entitlements_changes:\n")
@@ -498,7 +498,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.role_insights_api import RoleInsightsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_insights_response import RoleInsightsResponse
@@ -506,13 +505,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | The role insights request id # str | The role insights request id
try:
# Returns metadata from prior request.
results =RoleInsightsApi(api_client).get_role_insights_requests(id)
results = RoleInsightsApi(api_client).get_role_insights_requests(id=id)
# Below is a request that includes all optional parameters
# results = RoleInsightsApi(api_client).get_role_insights_requests(id)
print("The response of RoleInsightsApi->get_role_insights_requests:\n")
@@ -553,7 +553,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.role_insights_api import RoleInsightsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_insights_summary import RoleInsightsSummary
@@ -561,12 +560,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get role insights summary information
results =RoleInsightsApi(api_client).get_role_insights_summary()
results = RoleInsightsApi(api_client).get_role_insights_summary()
# Below is a request that includes all optional parameters
# results = RoleInsightsApi(api_client).get_role_insights_summary()
print("The response of RoleInsightsApi->get_role_insights_summary:\n")

57
docs/tools/sdk/python/Reference/Beta/Methods/RolesApi.md
View File

@@ -100,7 +100,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.roles_api import RolesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role import Role
@@ -108,8 +107,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role = {
role = '''{
"owner" : {
"name" : "support",
"id" : "2c9180a46faadee4016fb4e018c20639",
@@ -266,13 +266,12 @@ with ApiClient(configuration) as api_client:
},
"id" : "2c918086749d78830174a1a40e121518",
"requestable" : true
} # Role |
}''' # Role |
try:
# Create a Role
new_role = Role()
new_role.from_json(role)
results =RolesApi(api_client).create_role(new_role)
new_role = Role.from_json(role)
results = RolesApi(api_client).create_role(role=new_role)
# Below is a request that includes all optional parameters
# results = RolesApi(api_client).create_role(new_role)
print("The response of RolesApi->create_role:\n")
@@ -320,7 +319,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.roles_api import RolesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_bulk_delete_request import RoleBulkDeleteRequest
@@ -329,16 +327,16 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
role_bulk_delete_request = {
role_bulk_delete_request = '''{
"roleIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ]
} # RoleBulkDeleteRequest |
}''' # RoleBulkDeleteRequest |
try:
# Delete Role(s)
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)
new_role_bulk_delete_request = RoleBulkDeleteRequest.from_json(role_bulk_delete_request)
results = RolesApi(api_client).delete_bulk_roles(role_bulk_delete_request=new_role_bulk_delete_request)
# Below is a request that includes all optional parameters
# results = RolesApi(api_client).delete_bulk_roles(new_role_bulk_delete_request)
print("The response of RolesApi->delete_bulk_roles:\n")
@@ -385,20 +383,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.roles_api import RolesApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role
try:
# Delete a Role
RolesApi(api_client).delete_role(id)
RolesApi(api_client).delete_role(id=id)
# Below is a request that includes all optional parameters
# RolesApi(api_client).delete_role(id)
except Exception as e:
@@ -442,7 +440,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.roles_api import RolesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role import Role
@@ -450,13 +447,14 @@ 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
results =RolesApi(api_client).get_role(id)
results = RolesApi(api_client).get_role(id=id)
# Below is a request that includes all optional parameters
# results = RolesApi(api_client).get_role(id)
print("The response of RolesApi->get_role:\n")
@@ -506,7 +504,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.roles_api import RolesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role_identity import RoleIdentity
@@ -514,6 +511,7 @@ 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)
@@ -525,7 +523,7 @@ with ApiClient(configuration) as api_client:
try:
# Identities assigned a Role
results =RolesApi(api_client).get_role_assigned_identities(id, )
results = RolesApi(api_client).get_role_assigned_identities(id=id)
# Below is a request that includes all optional parameters
# results = RolesApi(api_client).get_role_assigned_identities(id, limit, offset, count, filters, sorters)
print("The response of RolesApi->get_role_assigned_identities:\n")
@@ -577,7 +575,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.roles_api import RolesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.entitlement import Entitlement
@@ -585,6 +582,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121919ecca' # str | ID of the containing role # str | ID of the containing role
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)
@@ -596,7 +594,7 @@ with ApiClient(configuration) as api_client:
try:
# List role's Entitlements
results =RolesApi(api_client).get_role_entitlements(id, )
results = RolesApi(api_client).get_role_entitlements(id=id)
# Below is a request that includes all optional parameters
# results = RolesApi(api_client).get_role_entitlements(id, limit, offset, count, filters, sorters)
print("The response of RolesApi->get_role_entitlements:\n")
@@ -650,7 +648,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.roles_api import RolesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.role import Role
@@ -658,6 +655,7 @@ 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)
@@ -671,7 +669,7 @@ with ApiClient(configuration) as api_client:
try:
# List Roles
results =RolesApi(api_client).list_roles()
results = RolesApi(api_client).list_roles()
# Below is a request that includes all optional parameters
# 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")
@@ -737,7 +735,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.roles_api import RolesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.json_patch_operation import JsonPatchOperation
@@ -746,21 +743,15 @@ 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 = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] |
json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]''' # List[JsonPatchOperation] |
try:
# Patch a specified Role
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)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = RolesApi(api_client).patch_role(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = RolesApi(api_client).patch_role(id, new_json_patch_operation)
print("The response of RolesApi->patch_role:\n")

52
docs/tools/sdk/python/Reference/Beta/Methods/SIMIntegrationsApi.md
View File

@@ -64,7 +64,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sim_integrations_api import SIMIntegrationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto
@@ -73,8 +72,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
sim_integration_details = {
sim_integration_details = '''{
"cluster" : "xyzzy999",
"statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}",
"request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}",
@@ -91,13 +91,12 @@ with ApiClient(configuration) as api_client:
"id" : "2c918085708c274401708c2a8a760001",
"type" : "IDENTITY"
}
} # SimIntegrationDetails | DTO containing the details of the SIM integration
}''' # SimIntegrationDetails | DTO containing the details of the SIM integration
try:
# Create new SIM integration
new_sim_integration_details = SimIntegrationDetails()
new_sim_integration_details.from_json(sim_integration_details)
results =SIMIntegrationsApi(api_client).create_sim_integration(new_sim_integration_details)
new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details)
results = SIMIntegrationsApi(api_client).create_sim_integration(sim_integration_details=new_sim_integration_details)
# Below is a request that includes all optional parameters
# results = SIMIntegrationsApi(api_client).create_sim_integration(new_sim_integration_details)
print("The response of SIMIntegrationsApi->create_sim_integration:\n")
@@ -143,20 +142,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sim_integrations_api import SIMIntegrationsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '12345' # str | The id of the integration to delete. # str | The id of the integration to delete.
try:
# Delete a SIM integration
SIMIntegrationsApi(api_client).delete_sim_integration(id)
SIMIntegrationsApi(api_client).delete_sim_integration(id=id)
# Below is a request that includes all optional parameters
# SIMIntegrationsApi(api_client).delete_sim_integration(id)
except Exception as e:
@@ -200,7 +199,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sim_integrations_api import SIMIntegrationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto
@@ -208,13 +206,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '12345' # str | The id of the integration. # str | The id of the integration.
try:
# Get a SIM integration details.
results =SIMIntegrationsApi(api_client).get_sim_integration(id)
results = SIMIntegrationsApi(api_client).get_sim_integration(id=id)
# Below is a request that includes all optional parameters
# results = SIMIntegrationsApi(api_client).get_sim_integration(id)
print("The response of SIMIntegrationsApi->get_sim_integration:\n")
@@ -257,7 +256,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sim_integrations_api import SIMIntegrationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto
@@ -265,12 +263,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List the existing SIM integrations.
results =SIMIntegrationsApi(api_client).get_sim_integrations()
results = SIMIntegrationsApi(api_client).get_sim_integrations()
# Below is a request that includes all optional parameters
# results = SIMIntegrationsApi(api_client).get_sim_integrations()
print("The response of SIMIntegrationsApi->get_sim_integrations:\n")
@@ -317,7 +316,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sim_integrations_api import SIMIntegrationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.json_patch import JsonPatch
@@ -326,15 +324,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '12345' # str | SIM integration id # str | SIM integration id
json_patch = "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule.
json_patch = '''"[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]"''' # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule.
try:
# Patch a SIM beforeProvisioningRule attribute.
new_json_patch = JsonPatch()
new_json_patch.from_json(json_patch)
results =SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, new_json_patch)
new_json_patch = JsonPatch.from_json(json_patch)
results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id=id, json_patch=new_json_patch)
# Below is a request that includes all optional parameters
# results = SIMIntegrationsApi(api_client).patch_before_provisioning_rule(id, new_json_patch)
print("The response of SIMIntegrationsApi->patch_before_provisioning_rule:\n")
@@ -381,7 +379,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sim_integrations_api import SIMIntegrationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.json_patch import JsonPatch
@@ -390,15 +387,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '12345' # str | SIM integration id # str | SIM integration id
json_patch = "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" # JsonPatch | The JsonPatch object that describes the changes of SIM
json_patch = '''"[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]"''' # JsonPatch | The JsonPatch object that describes the changes of SIM
try:
# Patch a SIM attribute.
new_json_patch = JsonPatch()
new_json_patch.from_json(json_patch)
results =SIMIntegrationsApi(api_client).patch_sim_attributes(id, new_json_patch)
new_json_patch = JsonPatch.from_json(json_patch)
results = SIMIntegrationsApi(api_client).patch_sim_attributes(id=id, json_patch=new_json_patch)
# Below is a request that includes all optional parameters
# results = SIMIntegrationsApi(api_client).patch_sim_attributes(id, new_json_patch)
print("The response of SIMIntegrationsApi->patch_sim_attributes:\n")
@@ -445,7 +442,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sim_integrations_api import SIMIntegrationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto
@@ -454,9 +450,10 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '12345' # str | The id of the integration. # str | The id of the integration.
sim_integration_details = {
sim_integration_details = '''{
"cluster" : "xyzzy999",
"statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}",
"request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}",
@@ -473,13 +470,12 @@ with ApiClient(configuration) as api_client:
"id" : "2c918085708c274401708c2a8a760001",
"type" : "IDENTITY"
}
} # SimIntegrationDetails | The full DTO of the integration containing the updated model
}''' # SimIntegrationDetails | The full DTO of the integration containing the updated model
try:
# Update an existing SIM integration
new_sim_integration_details = SimIntegrationDetails()
new_sim_integration_details.from_json(sim_integration_details)
results =SIMIntegrationsApi(api_client).put_sim_integration(id, new_sim_integration_details)
new_sim_integration_details = SimIntegrationDetails.from_json(sim_integration_details)
results = SIMIntegrationsApi(api_client).put_sim_integration(id=id, sim_integration_details=new_sim_integration_details)
# Below is a request that includes all optional parameters
# results = SIMIntegrationsApi(api_client).put_sim_integration(id, new_sim_integration_details)
print("The response of SIMIntegrationsApi->put_sim_integration:\n")

96
docs/tools/sdk/python/Reference/Beta/Methods/SODPoliciesApi.md
View File

@@ -95,7 +95,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sod_policies_api import SODPoliciesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.sod_policy import SodPolicy
@@ -103,8 +102,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
sod_policy = {
sod_policy = '''{
"conflictingAccessCriteria" : {
"leftCriteria" : {
"name" : "money-in",
@@ -159,13 +159,12 @@ with ApiClient(configuration) as api_client:
"id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde",
"state" : "ENFORCED",
"externalPolicyReference" : "XYZ policy"
} # SodPolicy |
}''' # SodPolicy |
try:
# Create SOD policy
new_sod_policy = SodPolicy()
new_sod_policy.from_json(sod_policy)
results =SODPoliciesApi(api_client).create_sod_policy(new_sod_policy)
new_sod_policy = SodPolicy.from_json(sod_policy)
results = SODPoliciesApi(api_client).create_sod_policy(sod_policy=new_sod_policy)
# Below is a request that includes all optional parameters
# results = SODPoliciesApi(api_client).create_sod_policy(new_sod_policy)
print("The response of SODPoliciesApi->create_sod_policy:\n")
@@ -216,13 +215,13 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sod_policies_api import SODPoliciesApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | 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. (optional) (default to True) # bool | Indicates whether this is a soft delete (logical true) or a hard delete. (optional) (default to True)
@@ -230,7 +229,7 @@ with ApiClient(configuration) as api_client:
try:
# Delete SOD policy by ID
SODPoliciesApi(api_client).delete_sod_policy(id, )
SODPoliciesApi(api_client).delete_sod_policy(id=id)
# Below is a request that includes all optional parameters
# SODPoliciesApi(api_client).delete_sod_policy(id, logical)
except Exception as e:
@@ -278,20 +277,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sod_policies_api import SODPoliciesApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | 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
SODPoliciesApi(api_client).delete_sod_policy_schedule(id)
SODPoliciesApi(api_client).delete_sod_policy_schedule(id=id)
# Below is a request that includes all optional parameters
# SODPoliciesApi(api_client).delete_sod_policy_schedule(id)
except Exception as e:
@@ -340,13 +339,13 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sod_policies_api import SODPoliciesApi
from sailpoint.beta.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.
@@ -354,7 +353,7 @@ with ApiClient(configuration) as api_client:
try:
# Download custom violation report
results =SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name)
results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id=report_result_id, file_name=file_name)
# Below is a request that includes all optional parameters
# results = SODPoliciesApi(api_client).get_custom_violation_report(report_result_id, file_name)
print("The response of SODPoliciesApi->get_custom_violation_report:\n")
@@ -404,20 +403,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sod_policies_api import SODPoliciesApi
from sailpoint.beta.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
results =SODPoliciesApi(api_client).get_default_violation_report(report_result_id)
results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id=report_result_id)
# Below is a request that includes all optional parameters
# results = SODPoliciesApi(api_client).get_default_violation_report(report_result_id)
print("The response of SODPoliciesApi->get_default_violation_report:\n")
@@ -463,7 +462,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sod_policies_api import SODPoliciesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.report_result_reference import ReportResultReference
@@ -471,12 +469,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get multi-report run task status
results =SODPoliciesApi(api_client).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
# results = SODPoliciesApi(api_client).get_sod_all_report_run_status()
print("The response of SODPoliciesApi->get_sod_all_report_run_status:\n")
@@ -526,7 +525,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sod_policies_api import SODPoliciesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.sod_policy import SodPolicy
@@ -534,13 +532,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve.
try:
# Get SOD policy by ID
results =SODPoliciesApi(api_client).get_sod_policy(id)
results = SODPoliciesApi(api_client).get_sod_policy(id=id)
# Below is a request that includes all optional parameters
# results = SODPoliciesApi(api_client).get_sod_policy(id)
print("The response of SODPoliciesApi->get_sod_policy:\n")
@@ -589,7 +588,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sod_policies_api import SODPoliciesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.sod_policy_schedule import SodPolicySchedule
@@ -597,13 +595,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve.
try:
# Get SOD policy schedule
results =SODPoliciesApi(api_client).get_sod_policy_schedule(id)
results = SODPoliciesApi(api_client).get_sod_policy_schedule(id=id)
# Below is a request that includes all optional parameters
# results = SODPoliciesApi(api_client).get_sod_policy_schedule(id)
print("The response of SODPoliciesApi->get_sod_policy_schedule:\n")
@@ -653,7 +652,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sod_policies_api import SODPoliciesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.report_result_reference import ReportResultReference
@@ -661,13 +659,14 @@ 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
results =SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id)
results = SODPoliciesApi(api_client).get_sod_violation_report_run_status(report_result_id=report_result_id)
# Below is a request that includes all optional parameters
# 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")
@@ -717,7 +716,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sod_policies_api import SODPoliciesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.report_result_reference import ReportResultReference
@@ -725,13 +723,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve.
try:
# Get SOD violation report status
results =SODPoliciesApi(api_client).get_sod_violation_report_status(id)
results = SODPoliciesApi(api_client).get_sod_violation_report_status(id=id)
# Below is a request that includes all optional parameters
# results = SODPoliciesApi(api_client).get_sod_violation_report_status(id)
print("The response of SODPoliciesApi->get_sod_violation_report_status:\n")
@@ -784,7 +783,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sod_policies_api import SODPoliciesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.sod_policy import SodPolicy
@@ -792,6 +790,7 @@ 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)
@@ -802,7 +801,7 @@ with ApiClient(configuration) as api_client:
try:
# List SOD policies
results =SODPoliciesApi(api_client).list_sod_policies()
results = SODPoliciesApi(api_client).list_sod_policies()
# Below is a request that includes all optional parameters
# results = SODPoliciesApi(api_client).list_sod_policies(limit, offset, count, filters, sorters)
print("The response of SODPoliciesApi->list_sod_policies:\n")
@@ -854,7 +853,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sod_policies_api import SODPoliciesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.sod_policy import SodPolicy
@@ -862,17 +860,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | The ID of the SOD policy being modified. # str | The ID of the SOD policy being modified.
request_body = [{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[object] | 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
request_body = [{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[object] | 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
request_body = '''[{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[object] | 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
try:
# Patch a SOD policy
new_request_body = RequestBody()
new_request_body.from_json(request_body)
results =SODPoliciesApi(api_client).patch_sod_policy(id, new_request_body)
new_request_body = RequestBody.from_json(request_body)
results = SODPoliciesApi(api_client).patch_sod_policy(id=id, request_body=new_request_body)
# Below is a request that includes all optional parameters
# results = SODPoliciesApi(api_client).patch_sod_policy(id, new_request_body)
print("The response of SODPoliciesApi->patch_sod_policy:\n")
@@ -922,7 +918,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sod_policies_api import SODPoliciesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.sod_policy_schedule import SodPolicySchedule
@@ -930,9 +925,10 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # 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 = {
sod_policy_schedule = '''{
"schedule" : {
"hours" : {
"accountMatchConfig" : {
@@ -1017,13 +1013,12 @@ with ApiClient(configuration) as api_client:
"modified" : "2020-01-01T00:00:00Z",
"description" : "Schedule for policy xyz",
"emailEmptyResults" : false
} # SodPolicySchedule |
}''' # SodPolicySchedule |
try:
# Update SOD Policy schedule
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)
new_sod_policy_schedule = SodPolicySchedule.from_json(sod_policy_schedule)
results = SODPoliciesApi(api_client).put_policy_schedule(id=id, sod_policy_schedule=new_sod_policy_schedule)
# Below is a request that includes all optional parameters
# results = SODPoliciesApi(api_client).put_policy_schedule(id, new_sod_policy_schedule)
print("The response of SODPoliciesApi->put_policy_schedule:\n")
@@ -1074,7 +1069,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sod_policies_api import SODPoliciesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.sod_policy import SodPolicy
@@ -1082,9 +1076,10 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the SOD policy to update. # str | The ID of the SOD policy to update.
sod_policy = {
sod_policy = '''{
"conflictingAccessCriteria" : {
"leftCriteria" : {
"name" : "money-in",
@@ -1139,13 +1134,12 @@ with ApiClient(configuration) as api_client:
"id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde",
"state" : "ENFORCED",
"externalPolicyReference" : "XYZ policy"
} # SodPolicy |
}''' # SodPolicy |
try:
# Update SOD policy by ID
new_sod_policy = SodPolicy()
new_sod_policy.from_json(sod_policy)
results =SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy)
new_sod_policy = SodPolicy.from_json(sod_policy)
results = SODPoliciesApi(api_client).put_sod_policy(id=id, sod_policy=new_sod_policy)
# Below is a request that includes all optional parameters
# results = SODPoliciesApi(api_client).put_sod_policy(id, new_sod_policy)
print("The response of SODPoliciesApi->put_sod_policy:\n")
@@ -1194,7 +1188,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sod_policies_api import SODPoliciesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.multi_policy_request import MultiPolicyRequest
@@ -1203,15 +1196,16 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
multi_policy_request = {
multi_policy_request = '''{
"filteredPolicyList" : [ "filteredPolicyList", "filteredPolicyList" ]
} # MultiPolicyRequest | (optional)
}''' # MultiPolicyRequest | (optional)
try:
# Runs all policies for org
results =SODPoliciesApi(api_client).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
# 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")
@@ -1261,7 +1255,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sod_policies_api import SODPoliciesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.report_result_reference import ReportResultReference
@@ -1269,13 +1262,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The SOD policy ID to run. # str | The SOD policy ID to run.
try:
# Runs SOD policy violation report
results =SODPoliciesApi(api_client).start_sod_policy(id)
results = SODPoliciesApi(api_client).start_sod_policy(id=id)
# Below is a request that includes all optional parameters
# results = SODPoliciesApi(api_client).start_sod_policy(id)
print("The response of SODPoliciesApi->start_sod_policy:\n")

11
docs/tools/sdk/python/Reference/Beta/Methods/SODViolationsApi.md
View File

@@ -74,7 +74,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sod_violations_api import SODViolationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.identity_with_new_access import IdentityWithNewAccess
@@ -83,8 +82,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_with_new_access = {
identity_with_new_access = '''{
"identityId" : "2c91808568c529c60168cca6f90c1313",
"accessRefs" : [ {
"type" : "ENTITLEMENT",
@@ -95,13 +95,12 @@ with ApiClient(configuration) as api_client:
"id" : "2c918087682f9a86016839c0509c1ab2",
"name" : "CN=Information Technology,OU=test,OU=test-service,DC=TestAD,DC=local"
} ]
} # IdentityWithNewAccess |
}''' # IdentityWithNewAccess |
try:
# Predict SOD violations for identity.
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)
new_identity_with_new_access = IdentityWithNewAccess.from_json(identity_with_new_access)
results = SODViolationsApi(api_client).start_predict_sod_violations(identity_with_new_access=new_identity_with_new_access)
# Below is a request that includes all optional parameters
# results = SODViolationsApi(api_client).start_predict_sod_violations(new_identity_with_new_access)
print("The response of SODViolationsApi->start_predict_sod_violations:\n")

37
docs/tools/sdk/python/Reference/Beta/Methods/SPConfigApi.md
View File

@@ -58,7 +58,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sp_config_api import SPConfigApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.export_payload import ExportPayload
@@ -67,16 +66,16 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
export_payload = {
export_payload = '''{
"description" : "Export Job 1 Test"
} # ExportPayload | Export options control what will be included in the export.
}''' # ExportPayload | Export options control what will be included in the export.
try:
# Initiates configuration objects export job
new_export_payload = ExportPayload()
new_export_payload.from_json(export_payload)
results =SPConfigApi(api_client).export_sp_config(new_export_payload)
new_export_payload = ExportPayload.from_json(export_payload)
results = SPConfigApi(api_client).export_sp_config(export_payload=new_export_payload)
# Below is a request that includes all optional parameters
# results = SPConfigApi(api_client).export_sp_config(new_export_payload)
print("The response of SPConfigApi->export_sp_config:\n")
@@ -124,7 +123,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sp_config_api import SPConfigApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.sp_config_export_results import SpConfigExportResults
@@ -132,13 +130,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded.
try:
# Download export job result.
results =SPConfigApi(api_client).get_sp_config_export(id)
results = SPConfigApi(api_client).get_sp_config_export(id=id)
# Below is a request that includes all optional parameters
# results = SPConfigApi(api_client).get_sp_config_export(id)
print("The response of SPConfigApi->get_sp_config_export:\n")
@@ -186,7 +185,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sp_config_api import SPConfigApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.sp_config_export_job_status import SpConfigExportJobStatus
@@ -194,13 +192,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned.
try:
# Get export job status
results =SPConfigApi(api_client).get_sp_config_export_status(id)
results = SPConfigApi(api_client).get_sp_config_export_status(id=id)
# Below is a request that includes all optional parameters
# results = SPConfigApi(api_client).get_sp_config_export_status(id)
print("The response of SPConfigApi->get_sp_config_export_status:\n")
@@ -248,7 +247,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sp_config_api import SPConfigApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.sp_config_import_results import SpConfigImportResults
@@ -256,13 +254,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded.
try:
# Download import job result
results =SPConfigApi(api_client).get_sp_config_import(id)
results = SPConfigApi(api_client).get_sp_config_import(id=id)
# Below is a request that includes all optional parameters
# results = SPConfigApi(api_client).get_sp_config_import(id)
print("The response of SPConfigApi->get_sp_config_import:\n")
@@ -309,7 +308,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sp_config_api import SPConfigApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.sp_config_import_job_status import SpConfigImportJobStatus
@@ -317,13 +315,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned.
try:
# Get import job status
results =SPConfigApi(api_client).get_sp_config_import_status(id)
results = SPConfigApi(api_client).get_sp_config_import_status(id=id)
# Below is a request that includes all optional parameters
# results = SPConfigApi(api_client).get_sp_config_import_status(id)
print("The response of SPConfigApi->get_sp_config_import_status:\n")
@@ -381,7 +380,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sp_config_api import SPConfigApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.import_options import ImportOptions
@@ -390,15 +388,16 @@ 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.
preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False)
options = sailpoint.beta.ImportOptions() # ImportOptions | (optional)
options = '''sailpoint.beta.ImportOptions()''' # ImportOptions | (optional)
try:
# Initiates configuration objects import job
results =SPConfigApi(api_client).import_sp_config(data, )
results = SPConfigApi(api_client).import_sp_config(data=data)
# Below is a request that includes all optional parameters
# results = SPConfigApi(api_client).import_sp_config(data, preview, options)
print("The response of SPConfigApi->import_sp_config:\n")
@@ -441,7 +440,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.sp_config_api import SPConfigApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.sp_config_object import SpConfigObject
@@ -449,12 +447,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get config object details
results =SPConfigApi(api_client).list_sp_config_objects()
results = SPConfigApi(api_client).list_sp_config_objects()
# Below is a request that includes all optional parameters
# results = SPConfigApi(api_client).list_sp_config_objects()
print("The response of SPConfigApi->list_sp_config_objects:\n")

38
docs/tools/sdk/python/Reference/Beta/Methods/SearchAttributeConfigurationApi.md
View File

@@ -74,7 +74,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig
@@ -82,21 +81,21 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
search_attribute_config = {
search_attribute_config = '''{
"displayName" : "New Mail Attribute",
"name" : "newMailAttribute",
"applicationAttributes" : {
"2c91808b79fd2422017a0b35d30f3968" : "employeeNumber",
"2c91808b79fd2422017a0b36008f396b" : "employeeNumber"
}
} # SearchAttributeConfig |
}''' # SearchAttributeConfig |
try:
# Create Extended Search Attributes
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)
new_search_attribute_config = SearchAttributeConfig.from_json(search_attribute_config)
results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(search_attribute_config=new_search_attribute_config)
# Below is a request that includes all optional parameters
# results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(new_search_attribute_config)
print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n")
@@ -141,20 +140,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi
from sailpoint.beta.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
SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name)
SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name=name)
# Below is a request that includes all optional parameters
# SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name)
except Exception as e:
@@ -194,7 +193,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig
@@ -202,12 +200,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Extended Search Attributes
results =SearchAttributeConfigurationApi(api_client).get_search_attribute_config()
results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config()
# Below is a request that includes all optional parameters
# results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config()
print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n")
@@ -253,7 +252,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.search_attribute_config import SearchAttributeConfig
@@ -261,13 +259,14 @@ 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 get. # str | Name of the extended search attribute configuration to get.
try:
# Get Extended Search Attribute
results =SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name)
results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name=name)
# Below is a request that includes all optional parameters
# results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name)
print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n")
@@ -316,7 +315,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.search_attribute_configuration_api import SearchAttributeConfigurationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.json_patch_operation import JsonPatchOperation
@@ -325,21 +323,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
name = 'promotedMailAttribute' # str | Name of the extended search attribute configuration to patch. # str | Name of the extended 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 = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] |
json_patch_operation = '''[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}]''' # List[JsonPatchOperation] |
try:
# Update Extended Search Attribute
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)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name=name, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, new_json_patch_operation)
print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n")

34
docs/tools/sdk/python/Reference/Beta/Methods/SegmentsApi.md
View File

@@ -73,7 +73,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.segments_api import SegmentsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.segment import Segment
@@ -81,8 +80,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
segment = {
segment = '''{
"owner" : {
"name" : "support",
"id" : "2c9180a46faadee4016fb4e018c20639",
@@ -105,13 +105,12 @@ with ApiClient(configuration) as api_client:
"description" : "This segment represents xyz",
"active" : true,
"id" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde"
} # Segment |
}''' # Segment |
try:
# Create Segment
new_segment = Segment()
new_segment.from_json(segment)
results =SegmentsApi(api_client).create_segment(new_segment)
new_segment = Segment.from_json(segment)
results = SegmentsApi(api_client).create_segment(segment=new_segment)
# Below is a request that includes all optional parameters
# results = SegmentsApi(api_client).create_segment(new_segment)
print("The response of SegmentsApi->create_segment:\n")
@@ -159,20 +158,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.segments_api import SegmentsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The segment ID to delete. # str | The segment ID to delete.
try:
# Delete Segment by ID
SegmentsApi(api_client).delete_segment(id)
SegmentsApi(api_client).delete_segment(id=id)
# Below is a request that includes all optional parameters
# SegmentsApi(api_client).delete_segment(id)
except Exception as e:
@@ -217,7 +216,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.segments_api import SegmentsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.segment import Segment
@@ -225,13 +223,14 @@ 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
results =SegmentsApi(api_client).get_segment(id)
results = SegmentsApi(api_client).get_segment(id=id)
# Below is a request that includes all optional parameters
# results = SegmentsApi(api_client).get_segment(id)
print("The response of SegmentsApi->get_segment:\n")
@@ -279,7 +278,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.segments_api import SegmentsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.segment import Segment
@@ -287,6 +285,7 @@ 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)
@@ -295,7 +294,7 @@ with ApiClient(configuration) as api_client:
try:
# List Segments
results =SegmentsApi(api_client).list_segments()
results = SegmentsApi(api_client).list_segments()
# Below is a request that includes all optional parameters
# results = SegmentsApi(api_client).list_segments(limit, offset, count)
print("The response of SegmentsApi->list_segments:\n")
@@ -344,7 +343,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.segments_api import SegmentsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.segment import Segment
@@ -352,17 +350,15 @@ 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
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
try:
# Update Segment
new_request_body = RequestBody()
new_request_body.from_json(request_body)
results =SegmentsApi(api_client).patch_segment(id, new_request_body)
new_request_body = RequestBody.from_json(request_body)
results = SegmentsApi(api_client).patch_segment(id=id, request_body=new_request_body)
# Below is a request that includes all optional parameters
# results = SegmentsApi(api_client).patch_segment(id, new_request_body)
print("The response of SegmentsApi->patch_segment:\n")

66
docs/tools/sdk/python/Reference/Beta/Methods/ServiceDeskIntegrationApi.md
View File

@@ -84,7 +84,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto
@@ -92,8 +91,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
service_desk_integration_dto = {
service_desk_integration_dto = '''{
"ownerRef" : "",
"cluster" : "xyzzy999",
"managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ],
@@ -123,13 +123,12 @@ with ApiClient(configuration) as api_client:
"clusterRef" : "",
"type" : "ServiceNowSDIM",
"beforeProvisioningRule" : ""
} # ServiceDeskIntegrationDto | The specifics of a new integration to create
}''' # ServiceDeskIntegrationDto | The specifics of a new integration to create
try:
# Create new Service Desk integration
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)
new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto)
results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(service_desk_integration_dto=new_service_desk_integration_dto)
# Below is a request that includes all optional parameters
# results = ServiceDeskIntegrationApi(api_client).create_service_desk_integration(new_service_desk_integration_dto)
print("The response of ServiceDeskIntegrationApi->create_service_desk_integration:\n")
@@ -175,20 +174,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'anId' # str | ID of Service Desk integration to delete # str | ID of Service Desk integration to delete
try:
# Delete a Service Desk integration
ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id)
ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id=id)
# Below is a request that includes all optional parameters
# ServiceDeskIntegrationApi(api_client).delete_service_desk_integration(id)
except Exception as e:
@@ -232,7 +231,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto
@@ -240,13 +238,14 @@ 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
results =ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id)
results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id=id)
# Below is a request that includes all optional parameters
# results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration(id)
print("The response of ServiceDeskIntegrationApi->get_service_desk_integration:\n")
@@ -296,7 +295,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto
@@ -304,6 +302,7 @@ 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)
@@ -314,7 +313,7 @@ with ApiClient(configuration) as api_client:
try:
# List existing Service Desk integrations
results =ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list()
results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list()
# Below is a request that includes all optional parameters
# results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_list(offset, limit, sorters, filters, count)
print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_list:\n")
@@ -360,7 +359,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.service_desk_integration_template_dto import ServiceDeskIntegrationTemplateDto
@@ -368,13 +366,14 @@ 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
results =ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name)
results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name=script_name)
# Below is a request that includes all optional parameters
# results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_template(script_name)
print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_template:\n")
@@ -417,7 +416,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.service_desk_integration_template_type import ServiceDeskIntegrationTemplateType
@@ -425,12 +423,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Service Desk integration types
results =ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types()
results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types()
# Below is a request that includes all optional parameters
# results = ServiceDeskIntegrationApi(api_client).get_service_desk_integration_types()
print("The response of ServiceDeskIntegrationApi->get_service_desk_integration_types:\n")
@@ -473,7 +472,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails
@@ -481,12 +479,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get the time check configuration
results =ServiceDeskIntegrationApi(api_client).get_status_check_details()
results = ServiceDeskIntegrationApi(api_client).get_status_check_details()
# Below is a request that includes all optional parameters
# results = ServiceDeskIntegrationApi(api_client).get_status_check_details()
print("The response of ServiceDeskIntegrationApi->get_status_check_details:\n")
@@ -533,7 +532,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.patch_service_desk_integration_request import PatchServiceDeskIntegrationRequest
@@ -542,15 +540,15 @@ 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.beta.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.
patch_service_desk_integration_request = '''sailpoint.beta.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
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)
new_patch_service_desk_integration_request = PatchServiceDeskIntegrationRequest.from_json(patch_service_desk_integration_request)
results = ServiceDeskIntegrationApi(api_client).patch_service_desk_integration(id=id, patch_service_desk_integration_request=new_patch_service_desk_integration_request)
# Below is a request that includes all optional parameters
# 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")
@@ -597,7 +595,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.service_desk_integration_dto import ServiceDeskIntegrationDto
@@ -605,9 +602,10 @@ 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 = {
service_desk_integration_dto = '''{
"ownerRef" : "",
"cluster" : "xyzzy999",
"managedSources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ],
@@ -637,13 +635,12 @@ with ApiClient(configuration) as api_client:
"clusterRef" : "",
"type" : "ServiceNowSDIM",
"beforeProvisioningRule" : ""
} # ServiceDeskIntegrationDto | The specifics of the integration to update
}''' # ServiceDeskIntegrationDto | The specifics of the integration to update
try:
# Update a Service Desk integration
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)
new_service_desk_integration_dto = ServiceDeskIntegrationDto.from_json(service_desk_integration_dto)
results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id=id, service_desk_integration_dto=new_service_desk_integration_dto)
# Below is a request that includes all optional parameters
# results = ServiceDeskIntegrationApi(api_client).put_service_desk_integration(id, new_service_desk_integration_dto)
print("The response of ServiceDeskIntegrationApi->put_service_desk_integration:\n")
@@ -689,7 +686,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.service_desk_integration_api import ServiceDeskIntegrationApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.queued_check_config_details import QueuedCheckConfigDetails
@@ -697,17 +693,17 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
queued_check_config_details = {
queued_check_config_details = '''{
"provisioningStatusCheckIntervalMinutes" : "30",
"provisioningMaxStatusCheckDays" : "2"
} # QueuedCheckConfigDetails | The modified time check configuration
}''' # QueuedCheckConfigDetails | The modified time check configuration
try:
# Update the time check configuration
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)
new_queued_check_config_details = QueuedCheckConfigDetails.from_json(queued_check_config_details)
results = ServiceDeskIntegrationApi(api_client).update_status_check_details(queued_check_config_details=new_queued_check_config_details)
# Below is a request that includes all optional parameters
# results = ServiceDeskIntegrationApi(api_client).update_status_check_details(new_queued_check_config_details)
print("The response of ServiceDeskIntegrationApi->update_status_check_details:\n")

8
docs/tools/sdk/python/Reference/Beta/Methods/SourceUsagesApi.md
View File

@@ -54,7 +54,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.source_usages_api import SourceUsagesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.source_usage_status import SourceUsageStatus
@@ -62,13 +61,14 @@ 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
results =SourceUsagesApi(api_client).get_status_by_source_id(source_id)
results = SourceUsagesApi(api_client).get_status_by_source_id(source_id=source_id)
# Below is a request that includes all optional parameters
# results = SourceUsagesApi(api_client).get_status_by_source_id(source_id)
print("The response of SourceUsagesApi->get_status_by_source_id:\n")
@@ -117,7 +117,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.source_usages_api import SourceUsagesApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.source_usage import SourceUsage
@@ -125,6 +124,7 @@ 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)
@@ -135,7 +135,7 @@ with ApiClient(configuration) as api_client:
try:
# Returns source usage insights
results =SourceUsagesApi(api_client).get_usages_by_source_id(source_id, )
results = SourceUsagesApi(api_client).get_usages_by_source_id(source_id=source_id)
# Below is a request that includes all optional parameters
# 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")

324
docs/tools/sdk/python/Reference/Beta/Methods/SourcesApi.md
View File

File diff suppressed because it is too large Load Diff

59
docs/tools/sdk/python/Reference/Beta/Methods/SuggestedEntitlementDescriptionApi.md
View File

@@ -64,7 +64,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.sed_batch_stats import SedBatchStats
@@ -72,13 +71,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
batch_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | Batch Id # str | Batch Id
try:
# Submit Sed Batch Stats Request
results =SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id)
results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id=batch_id)
# Below is a request that includes all optional parameters
# results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id)
print("The response of SuggestedEntitlementDescriptionApi->get_sed_batch_stats:\n")
@@ -122,7 +122,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.sed_batch_status import SedBatchStatus
@@ -130,12 +129,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Sed Batch Request
results =SuggestedEntitlementDescriptionApi(api_client).get_sed_batches()
results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batches()
# Below is a request that includes all optional parameters
# results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batches()
print("The response of SuggestedEntitlementDescriptionApi->get_sed_batches:\n")
@@ -201,7 +201,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.sed import Sed
@@ -209,6 +208,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
limit = limit=25 # int | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) # int | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional)
filters = 'displayName co \"Read and Write\"' # 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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional)
@@ -221,7 +221,7 @@ with ApiClient(configuration) as api_client:
try:
# List Suggested Entitlement Descriptions
results =SuggestedEntitlementDescriptionApi(api_client).list_seds()
results = SuggestedEntitlementDescriptionApi(api_client).list_seds()
# Below is a request that includes all optional parameters
# results = SuggestedEntitlementDescriptionApi(api_client).list_seds(limit, filters, sorters, count, count_only, requested_by_anyone, show_pending_status_only)
print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n")
@@ -268,7 +268,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.sed import Sed
@@ -277,21 +276,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ebab396f-0af1-4050-89b7-dafc63ec70e7' # str | id is sed id # str | id is sed id
[sailpoint.beta.SedPatch()] # List[SedPatch] | Sed Patch Request
sed_patch = {
"op" : "replace",
"path" : "status",
"value" : "approved"
} # List[SedPatch] | Sed Patch Request
sed_patch = '''[sailpoint.beta.SedPatch()]''' # List[SedPatch] | Sed Patch Request
try:
# Patch Suggested Entitlement Description
new_sed_patch = SedPatch()
new_sed_patch.from_json(sed_patch)
results =SuggestedEntitlementDescriptionApi(api_client).patch_sed(id, new_sed_patch)
new_sed_patch = SedPatch.from_json(sed_patch)
results = SuggestedEntitlementDescriptionApi(api_client).patch_sed(id=id, sed_patch=new_sed_patch)
# Below is a request that includes all optional parameters
# results = SuggestedEntitlementDescriptionApi(api_client).patch_sed(id, new_sed_patch)
print("The response of SuggestedEntitlementDescriptionApi->patch_sed:\n")
@@ -338,7 +331,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.sed_approval import SedApproval
@@ -347,18 +339,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
[sailpoint.beta.SedApproval()] # List[SedApproval] | Sed Approval
sed_approval = {
"items" : "016629d1-1d25-463f-97f3-c6686846650"
} # List[SedApproval] | Sed Approval
with ApiClient(configuration) as api_client:
sed_approval = '''[sailpoint.beta.SedApproval()]''' # List[SedApproval] | Sed Approval
try:
# Submit Bulk Approval Request
new_sed_approval = SedApproval()
new_sed_approval.from_json(sed_approval)
results =SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(new_sed_approval)
new_sed_approval = SedApproval.from_json(sed_approval)
results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(sed_approval=new_sed_approval)
# Below is a request that includes all optional parameters
# results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(new_sed_approval)
print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n")
@@ -405,7 +393,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.sed_assignment import SedAssignment
@@ -414,20 +401,20 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
sed_assignment = {
sed_assignment = '''{
"assignee" : {
"type" : "SOURCE_OWNER",
"value" : "016629d1-1d25-463f-97f3-c6686846650"
},
"items" : [ "016629d1-1d25-463f-97f3-0c6686846650", "016629d1-1d25-463f-97f3-0c6686846650" ]
} # SedAssignment | Sed Assignment Request
}''' # SedAssignment | Sed Assignment Request
try:
# Submit Sed Assignment Request
new_sed_assignment = SedAssignment()
new_sed_assignment.from_json(sed_assignment)
results =SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(new_sed_assignment)
new_sed_assignment = SedAssignment.from_json(sed_assignment)
results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(sed_assignment=new_sed_assignment)
# Below is a request that includes all optional parameters
# results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(new_sed_assignment)
print("The response of SuggestedEntitlementDescriptionApi->submit_sed_assignment:\n")
@@ -477,7 +464,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.suggested_entitlement_description_api import SuggestedEntitlementDescriptionApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.sed_batch_request import SedBatchRequest
@@ -486,16 +472,17 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
sed_batch_request = {
sed_batch_request = '''{
"entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ],
"seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ]
} # SedBatchRequest | Sed Batch Request (optional)
}''' # SedBatchRequest | Sed Batch Request (optional)
try:
# Submit Sed Batch Request
results =SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request()
results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request()
# Below is a request that includes all optional parameters
# results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request(new_sed_batch_request)
print("The response of SuggestedEntitlementDescriptionApi->submit_sed_batch_request:\n")

60
docs/tools/sdk/python/Reference/Beta/Methods/TaggedObjectsApi.md
View File

@@ -111,13 +111,13 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.tagged_objects_api import TaggedObjectsApi
from sailpoint.beta.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.
@@ -125,7 +125,7 @@ with ApiClient(configuration) as api_client:
try:
# Delete Object Tags
TaggedObjectsApi(api_client).delete_tagged_object(type, id)
TaggedObjectsApi(api_client).delete_tagged_object(type=type, id=id)
# Below is a request that includes all optional parameters
# TaggedObjectsApi(api_client).delete_tagged_object(type, id)
except Exception as e:
@@ -170,7 +170,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.tagged_objects_api import TaggedObjectsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.bulk_tagged_object import BulkTaggedObject
@@ -178,8 +177,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
bulk_tagged_object = {
bulk_tagged_object = '''{
"objectRefs" : [ {
"name" : "William Wilson",
"id" : "2c91808568c529c60168cca6f90c1313",
@@ -191,13 +191,12 @@ with ApiClient(configuration) as api_client:
} ],
"operation" : "MERGE",
"tags" : [ "BU_FINANCE", "PCI" ]
} # BulkTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
}''' # BulkTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
try:
# Remove Tags from Multiple Objects
new_bulk_tagged_object = BulkTaggedObject()
new_bulk_tagged_object.from_json(bulk_tagged_object)
TaggedObjectsApi(api_client).delete_tags_to_many_object(new_bulk_tagged_object)
new_bulk_tagged_object = BulkTaggedObject.from_json(bulk_tagged_object)
TaggedObjectsApi(api_client).delete_tags_to_many_object(bulk_tagged_object=new_bulk_tagged_object)
# Below is a request that includes all optional parameters
# TaggedObjectsApi(api_client).delete_tags_to_many_object(new_bulk_tagged_object)
except Exception as e:
@@ -241,7 +240,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.tagged_objects_api import TaggedObjectsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.tagged_object import TaggedObject
@@ -249,6 +247,7 @@ 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.
@@ -256,7 +255,7 @@ with ApiClient(configuration) as api_client:
try:
# Get Tagged Object
results =TaggedObjectsApi(api_client).get_tagged_object(type, id)
results = TaggedObjectsApi(api_client).get_tagged_object(type=type, id=id)
# Below is a request that includes all optional parameters
# results = TaggedObjectsApi(api_client).get_tagged_object(type, id)
print("The response of TaggedObjectsApi->get_tagged_object:\n")
@@ -306,7 +305,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.tagged_objects_api import TaggedObjectsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.tagged_object import TaggedObject
@@ -314,6 +312,7 @@ 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)
@@ -323,7 +322,7 @@ with ApiClient(configuration) as api_client:
try:
# List Tagged Objects
results =TaggedObjectsApi(api_client).list_tagged_objects()
results = TaggedObjectsApi(api_client).list_tagged_objects()
# Below is a request that includes all optional parameters
# results = TaggedObjectsApi(api_client).list_tagged_objects(limit, offset, count, filters)
print("The response of TaggedObjectsApi->list_tagged_objects:\n")
@@ -374,7 +373,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.tagged_objects_api import TaggedObjectsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.tagged_object import TaggedObject
@@ -382,6 +380,7 @@ 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)
@@ -392,7 +391,7 @@ with ApiClient(configuration) as api_client:
try:
# List Tagged Objects by Type
results =TaggedObjectsApi(api_client).list_tagged_objects_by_type(type, )
results = TaggedObjectsApi(api_client).list_tagged_objects_by_type(type=type)
# Below is a request that includes all optional parameters
# 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")
@@ -439,7 +438,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.tagged_objects_api import TaggedObjectsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.tagged_object import TaggedObject
@@ -447,23 +445,23 @@ 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 = {
tagged_object = '''{
"objectRef" : {
"name" : "William Wilson",
"id" : "2c91808568c529c60168cca6f90c1313",
"type" : "IDENTITY"
},
"tags" : [ "BU_FINANCE", "PCI" ]
} # TaggedObject |
}''' # TaggedObject |
try:
# Update Tagged Object
new_tagged_object = TaggedObject()
new_tagged_object.from_json(tagged_object)
results =TaggedObjectsApi(api_client).put_tagged_object(type, id, new_tagged_object)
new_tagged_object = TaggedObject.from_json(tagged_object)
results = TaggedObjectsApi(api_client).put_tagged_object(type=type, id=id, tagged_object=new_tagged_object)
# Below is a request that includes all optional parameters
# results = TaggedObjectsApi(api_client).put_tagged_object(type, id, new_tagged_object)
print("The response of TaggedObjectsApi->put_tagged_object:\n")
@@ -510,7 +508,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.tagged_objects_api import TaggedObjectsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.tagged_object import TaggedObject
@@ -518,21 +515,21 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
tagged_object = {
tagged_object = '''{
"objectRef" : {
"name" : "William Wilson",
"id" : "2c91808568c529c60168cca6f90c1313",
"type" : "IDENTITY"
},
"tags" : [ "BU_FINANCE", "PCI" ]
} # TaggedObject |
}''' # TaggedObject |
try:
# Add Tag to Object
new_tagged_object = TaggedObject()
new_tagged_object.from_json(tagged_object)
TaggedObjectsApi(api_client).set_tag_to_object(new_tagged_object)
new_tagged_object = TaggedObject.from_json(tagged_object)
TaggedObjectsApi(api_client).set_tag_to_object(tagged_object=new_tagged_object)
# Below is a request that includes all optional parameters
# TaggedObjectsApi(api_client).set_tag_to_object(new_tagged_object)
except Exception as e:
@@ -577,7 +574,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.tagged_objects_api import TaggedObjectsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.bulk_tagged_object import BulkTaggedObject
@@ -585,8 +581,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
bulk_tagged_object = {
bulk_tagged_object = '''{
"objectRefs" : [ {
"name" : "William Wilson",
"id" : "2c91808568c529c60168cca6f90c1313",
@@ -598,13 +595,12 @@ with ApiClient(configuration) as api_client:
} ],
"operation" : "MERGE",
"tags" : [ "BU_FINANCE", "PCI" ]
} # BulkTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
}''' # BulkTaggedObject | Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
try:
# Tag Multiple Objects
new_bulk_tagged_object = BulkTaggedObject()
new_bulk_tagged_object.from_json(bulk_tagged_object)
results =TaggedObjectsApi(api_client).set_tags_to_many_objects(new_bulk_tagged_object)
new_bulk_tagged_object = BulkTaggedObject.from_json(bulk_tagged_object)
results = TaggedObjectsApi(api_client).set_tags_to_many_objects(bulk_tagged_object=new_bulk_tagged_object)
# Below is a request that includes all optional parameters
# results = TaggedObjectsApi(api_client).set_tags_to_many_objects(new_bulk_tagged_object)
print("The response of TaggedObjectsApi->set_tags_to_many_objects:\n")

23
docs/tools/sdk/python/Reference/Beta/Methods/TagsApi.md
View File

@@ -55,7 +55,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.tags_api import TagsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.tag import Tag
@@ -63,8 +62,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
tag = {
tag = '''{
"created" : "2022-05-04T14:48:49Z",
"tagCategoryRefs" : [ {
"name" : "CN=entitlement.490efde5,OU=OrgCo,OU=ServiceDept,DC=HQAD,DC=local",
@@ -78,13 +78,12 @@ with ApiClient(configuration) as api_client:
"name" : "PCI",
"modified" : "2022-07-14T16:31:11Z",
"id" : "449ecdc0-d4ff-4341-acf6-92f6f7ce604f"
} # Tag |
}''' # Tag |
try:
# Create Tag
new_tag = Tag()
new_tag.from_json(tag)
results =TagsApi(api_client).create_tag(new_tag)
new_tag = Tag.from_json(tag)
results = TagsApi(api_client).create_tag(tag=new_tag)
# Below is a request that includes all optional parameters
# results = TagsApi(api_client).create_tag(new_tag)
print("The response of TagsApi->create_tag:\n")
@@ -132,20 +131,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.tags_api import TagsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '329d96cf-3bdb-40a9-988a-b5037ab89022' # str | The ID of the object reference to delete. # str | The ID of the object reference to delete.
try:
# Delete Tag
TagsApi(api_client).delete_tag_by_id(id)
TagsApi(api_client).delete_tag_by_id(id=id)
# Below is a request that includes all optional parameters
# TagsApi(api_client).delete_tag_by_id(id)
except Exception as e:
@@ -191,7 +190,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.tags_api import TagsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.tag import Tag
@@ -199,13 +197,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '329d96cf-3bdb-40a9-988a-b5037ab89022' # str | The ID of the object reference to retrieve. # str | The ID of the object reference to retrieve.
try:
# Get Tag By Id
results =TagsApi(api_client).get_tag_by_id(id)
results = TagsApi(api_client).get_tag_by_id(id=id)
# Below is a request that includes all optional parameters
# results = TagsApi(api_client).get_tag_by_id(id)
print("The response of TagsApi->get_tag_by_id:\n")
@@ -256,7 +255,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.tags_api import TagsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.tag import Tag
@@ -264,6 +262,7 @@ 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)
@@ -274,7 +273,7 @@ with ApiClient(configuration) as api_client:
try:
# List Tags
results =TagsApi(api_client).list_tags()
results = TagsApi(api_client).list_tags()
# Below is a request that includes all optional parameters
# results = TagsApi(api_client).list_tags(limit, offset, count, filters, sorters)
print("The response of TagsApi->list_tags:\n")

29
docs/tools/sdk/python/Reference/Beta/Methods/TaskManagementApi.md
View File

@@ -57,13 +57,13 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.task_management_api import TaskManagementApi
from sailpoint.beta.api_client import ApiClient
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)
@@ -118,7 +118,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.task_management_api import TaskManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.task_status import TaskStatus
@@ -126,6 +125,7 @@ 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)
@@ -134,7 +134,7 @@ with ApiClient(configuration) as api_client:
try:
# Retrieve Pending Task Status List
results =TaskManagementApi(api_client).get_pending_tasks()
results = TaskManagementApi(api_client).get_pending_tasks()
# Below is a request that includes all optional parameters
# results = TaskManagementApi(api_client).get_pending_tasks(offset, limit, count)
print("The response of TaskManagementApi->get_pending_tasks:\n")
@@ -180,7 +180,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.task_management_api import TaskManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.task_status import TaskStatus
@@ -188,13 +187,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID.
try:
# Get Task Status by ID
results =TaskManagementApi(api_client).get_task_status(id)
results = TaskManagementApi(api_client).get_task_status(id=id)
# Below is a request that includes all optional parameters
# results = TaskManagementApi(api_client).get_task_status(id)
print("The response of TaskManagementApi->get_task_status:\n")
@@ -245,7 +245,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.task_management_api import TaskManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.task_status import TaskStatus
@@ -253,6 +252,7 @@ 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)
@@ -263,7 +263,7 @@ with ApiClient(configuration) as api_client:
try:
# Retrieve Task Status List
results =TaskManagementApi(api_client).get_task_status_list()
results = TaskManagementApi(api_client).get_task_status_list()
# Below is a request that includes all optional parameters
# results = TaskManagementApi(api_client).get_task_status_list(limit, offset, count, filters, sorters)
print("The response of TaskManagementApi->get_task_status_list:\n")
@@ -310,7 +310,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.task_management_api import TaskManagementApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.json_patch_operation import JsonPatchOperation
@@ -319,21 +318,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '00eebcf881994e419d72e757fd30dc0e' # str | Task ID. # str | Task ID.
[sailpoint.beta.JsonPatchOperation()] # List[JsonPatchOperation] | The JSONPatch payload used to update the object.
json_patch_operation = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] | The JSONPatch payload used to update the object.
json_patch_operation = '''[sailpoint.beta.JsonPatchOperation()]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the object.
try:
# Update Task Status by ID
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =TaskManagementApi(api_client).update_task_status(id, new_json_patch_operation)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = TaskManagementApi(api_client).update_task_status(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = TaskManagementApi(api_client).update_task_status(id, new_json_patch_operation)
print("The response of TaskManagementApi->update_task_status:\n")

4
docs/tools/sdk/python/Reference/Beta/Methods/TenantApi.md
View File

@@ -48,7 +48,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.tenant_api import TenantApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.tenant import Tenant
@@ -56,12 +55,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Tenant Information.
results =TenantApi(api_client).get_tenant()
results = TenantApi(api_client).get_tenant()
# Below is a request that includes all optional parameters
# results = TenantApi(api_client).get_tenant()
print("The response of TenantApi->get_tenant:\n")

31
docs/tools/sdk/python/Reference/Beta/Methods/TransformsApi.md
View File

@@ -55,7 +55,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.transforms_api import TransformsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.transform import Transform
@@ -64,18 +63,18 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
transform = {
transform = '''{
"name" : "Timestamp To Date",
"attributes" : "{}",
"type" : "dateFormat"
} # Transform | The transform to be created.
}''' # Transform | The transform to be created.
try:
# Create transform
new_transform = Transform()
new_transform.from_json(transform)
results =TransformsApi(api_client).create_transform(new_transform)
new_transform = Transform.from_json(transform)
results = TransformsApi(api_client).create_transform(transform=new_transform)
# Below is a request that includes all optional parameters
# results = TransformsApi(api_client).create_transform(new_transform)
print("The response of TransformsApi->create_transform:\n")
@@ -122,20 +121,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.transforms_api import TransformsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '2cd78adghjkja34jh2b1hkjhasuecd' # str | ID of the transform to delete # str | ID of the transform to delete
try:
# Delete a transform
TransformsApi(api_client).delete_transform(id)
TransformsApi(api_client).delete_transform(id=id)
# Below is a request that includes all optional parameters
# TransformsApi(api_client).delete_transform(id)
except Exception as e:
@@ -180,7 +179,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.transforms_api import TransformsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.transform_read import TransformRead
@@ -188,13 +186,14 @@ 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
results =TransformsApi(api_client).get_transform(id)
results = TransformsApi(api_client).get_transform(id=id)
# Below is a request that includes all optional parameters
# results = TransformsApi(api_client).get_transform(id)
print("The response of TransformsApi->get_transform:\n")
@@ -245,7 +244,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.transforms_api import TransformsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.transform_read import TransformRead
@@ -253,6 +251,7 @@ 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)
@@ -263,7 +262,7 @@ with ApiClient(configuration) as api_client:
try:
# List transforms
results =TransformsApi(api_client).list_transforms()
results = TransformsApi(api_client).list_transforms()
# Below is a request that includes all optional parameters
# results = TransformsApi(api_client).list_transforms(offset, limit, count, name, filters)
print("The response of TransformsApi->list_transforms:\n")
@@ -311,7 +310,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.transforms_api import TransformsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.transform import Transform
@@ -320,18 +318,19 @@ 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 = {
transform = '''{
"name" : "Timestamp To Date",
"attributes" : "{}",
"type" : "dateFormat"
} # Transform | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. (optional)
}''' # Transform | The updated transform object. Must include \"name\", \"type\", and \"attributes\" fields, but \"name\" and \"type\" must not be modified. (optional)
try:
# Update a transform
results =TransformsApi(api_client).update_transform(id, )
results = TransformsApi(api_client).update_transform(id=id)
# Below is a request that includes all optional parameters
# results = TransformsApi(api_client).update_transform(id, new_transform)
print("The response of TransformsApi->update_transform:\n")

82
docs/tools/sdk/python/Reference/Beta/Methods/TriggersApi.md
View File

@@ -101,7 +101,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.triggers_api import TriggersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.complete_invocation import CompleteInvocation
@@ -109,21 +108,21 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | The ID of the invocation to complete. # str | The ID of the invocation to complete.
complete_invocation = {
complete_invocation = '''{
"output" : {
"approved" : false
},
"secret" : "0f11f2a4-7c94-4bf3-a2bd-742580fe3bde",
"error" : "Access request is denied."
} # CompleteInvocation |
}''' # CompleteInvocation |
try:
# Complete Trigger Invocation
new_complete_invocation = CompleteInvocation()
new_complete_invocation.from_json(complete_invocation)
TriggersApi(api_client).complete_trigger_invocation(id, new_complete_invocation)
new_complete_invocation = CompleteInvocation.from_json(complete_invocation)
TriggersApi(api_client).complete_trigger_invocation(id=id, complete_invocation=new_complete_invocation)
# Below is a request that includes all optional parameters
# TriggersApi(api_client).complete_trigger_invocation(id, new_complete_invocation)
except Exception as e:
@@ -168,7 +167,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.triggers_api import TriggersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.subscription import Subscription
@@ -177,8 +175,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
subscription_post_request = {
subscription_post_request = '''{
"filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]",
"httpConfig" : {
"bearerTokenAuthConfig" : {
@@ -202,13 +201,12 @@ with ApiClient(configuration) as api_client:
"responseDeadline" : "PT1H",
"type" : "HTTP",
"enabled" : true
} # SubscriptionPostRequest |
}''' # SubscriptionPostRequest |
try:
# Create a Subscription
new_subscription_post_request = SubscriptionPostRequest()
new_subscription_post_request.from_json(subscription_post_request)
results =TriggersApi(api_client).create_subscription(new_subscription_post_request)
new_subscription_post_request = SubscriptionPostRequest.from_json(subscription_post_request)
results = TriggersApi(api_client).create_subscription(subscription_post_request=new_subscription_post_request)
# Below is a request that includes all optional parameters
# results = TriggersApi(api_client).create_subscription(new_subscription_post_request)
print("The response of TriggersApi->create_subscription:\n")
@@ -254,20 +252,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.triggers_api import TriggersApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID
try:
# Delete a Subscription
TriggersApi(api_client).delete_subscription(id)
TriggersApi(api_client).delete_subscription(id=id)
# Below is a request that includes all optional parameters
# TriggersApi(api_client).delete_subscription(id)
except Exception as e:
@@ -314,7 +312,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.triggers_api import TriggersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.subscription import Subscription
@@ -322,6 +319,7 @@ 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)
@@ -332,7 +330,7 @@ with ApiClient(configuration) as api_client:
try:
# List Subscriptions
results =TriggersApi(api_client).list_subscriptions()
results = TriggersApi(api_client).list_subscriptions()
# Below is a request that includes all optional parameters
# results = TriggersApi(api_client).list_subscriptions(limit, offset, count, filters, sorters)
print("The response of TriggersApi->list_subscriptions:\n")
@@ -383,7 +381,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.triggers_api import TriggersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.invocation_status import InvocationStatus
@@ -391,6 +388,7 @@ 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)
@@ -401,7 +399,7 @@ with ApiClient(configuration) as api_client:
try:
# List Latest Invocation Statuses
results =TriggersApi(api_client).list_trigger_invocation_status()
results = TriggersApi(api_client).list_trigger_invocation_status()
# Below is a request that includes all optional parameters
# results = TriggersApi(api_client).list_trigger_invocation_status(limit, offset, count, filters, sorters)
print("The response of TriggersApi->list_trigger_invocation_status:\n")
@@ -450,7 +448,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.triggers_api import TriggersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.trigger import Trigger
@@ -458,6 +455,7 @@ 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)
@@ -468,7 +466,7 @@ with ApiClient(configuration) as api_client:
try:
# List Triggers
results =TriggersApi(api_client).list_triggers()
results = TriggersApi(api_client).list_triggers()
# Below is a request that includes all optional parameters
# results = TriggersApi(api_client).list_triggers(limit, offset, count, filters, sorters)
print("The response of TriggersApi->list_triggers:\n")
@@ -517,7 +515,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.triggers_api import TriggersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.subscription import Subscription
@@ -526,17 +523,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | ID of the Subscription to patch # str | ID of the Subscription to patch
[sailpoint.beta.SubscriptionPatchRequestInner()] # List[SubscriptionPatchRequestInner] |
subscription_patch_request_inner = [sailpoint.beta.SubscriptionPatchRequestInner()] # List[SubscriptionPatchRequestInner] |
subscription_patch_request_inner = '''[sailpoint.beta.SubscriptionPatchRequestInner()]''' # List[SubscriptionPatchRequestInner] |
try:
# Patch a Subscription
new_subscription_patch_request_inner = SubscriptionPatchRequestInner()
new_subscription_patch_request_inner.from_json(subscription_patch_request_inner)
results =TriggersApi(api_client).patch_subscription(id, new_subscription_patch_request_inner)
new_subscription_patch_request_inner = SubscriptionPatchRequestInner.from_json(subscription_patch_request_inner)
results = TriggersApi(api_client).patch_subscription(id=id, subscription_patch_request_inner=new_subscription_patch_request_inner)
# Below is a request that includes all optional parameters
# results = TriggersApi(api_client).patch_subscription(id, new_subscription_patch_request_inner)
print("The response of TriggersApi->patch_subscription:\n")
@@ -582,7 +577,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.triggers_api import TriggersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.invocation import Invocation
@@ -591,8 +585,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
test_invocation = {
test_invocation = '''{
"input" : {
"identityId" : "201327fda1c44704ac01181e963d463c"
},
@@ -601,13 +596,12 @@ with ApiClient(configuration) as api_client:
"contentJson" : {
"workflowId" : 1234
}
} # TestInvocation |
}''' # TestInvocation |
try:
# Start a Test Invocation
new_test_invocation = TestInvocation()
new_test_invocation.from_json(test_invocation)
results =TriggersApi(api_client).start_test_trigger_invocation(new_test_invocation)
new_test_invocation = TestInvocation.from_json(test_invocation)
results = TriggersApi(api_client).start_test_trigger_invocation(test_invocation=new_test_invocation)
# Below is a request that includes all optional parameters
# results = TriggersApi(api_client).start_test_trigger_invocation(new_test_invocation)
print("The response of TriggersApi->start_test_trigger_invocation:\n")
@@ -653,7 +647,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.triggers_api import TriggersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.validate_filter_input_dto import ValidateFilterInputDto
@@ -662,19 +655,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
validate_filter_input_dto = {
validate_filter_input_dto = '''{
"filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]",
"input" : {
"identityId" : "201327fda1c44704ac01181e963d463c"
}
} # ValidateFilterInputDto |
}''' # ValidateFilterInputDto |
try:
# Validate a Subscription Filter
new_validate_filter_input_dto = ValidateFilterInputDto()
new_validate_filter_input_dto.from_json(validate_filter_input_dto)
results =TriggersApi(api_client).test_subscription_filter(new_validate_filter_input_dto)
new_validate_filter_input_dto = ValidateFilterInputDto.from_json(validate_filter_input_dto)
results = TriggersApi(api_client).test_subscription_filter(validate_filter_input_dto=new_validate_filter_input_dto)
# Below is a request that includes all optional parameters
# results = TriggersApi(api_client).test_subscription_filter(new_validate_filter_input_dto)
print("The response of TriggersApi->test_subscription_filter:\n")
@@ -730,7 +723,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.triggers_api import TriggersApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.subscription import Subscription
@@ -739,9 +731,10 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde' # str | Subscription ID # str | Subscription ID
subscription_put_request = {
subscription_put_request = '''{
"filter" : "$[?($.identityId == \"201327fda1c44704ac01181e963d463c\")]",
"httpConfig" : {
"bearerTokenAuthConfig" : {
@@ -764,13 +757,12 @@ with ApiClient(configuration) as api_client:
"responseDeadline" : "PT1H",
"type" : "HTTP",
"enabled" : true
} # SubscriptionPutRequest |
}''' # SubscriptionPutRequest |
try:
# Update a Subscription
new_subscription_put_request = SubscriptionPutRequest()
new_subscription_put_request.from_json(subscription_put_request)
results =TriggersApi(api_client).update_subscription(id, new_subscription_put_request)
new_subscription_put_request = SubscriptionPutRequest.from_json(subscription_put_request)
results = TriggersApi(api_client).update_subscription(id=id, subscription_put_request=new_subscription_put_request)
# Below is a request that includes all optional parameters
# results = TriggersApi(api_client).update_subscription(id, new_subscription_put_request)
print("The response of TriggersApi->update_subscription:\n")

15
docs/tools/sdk/python/Reference/Beta/Methods/UIMetadataApi.md
View File

@@ -51,7 +51,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.ui_metadata_api import UIMetadataApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.tenant_ui_metadata_item_response import TenantUiMetadataItemResponse
@@ -59,12 +58,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get a tenant UI metadata
results =UIMetadataApi(api_client).get_tenant_ui_metadata()
results = UIMetadataApi(api_client).get_tenant_ui_metadata()
# Below is a request that includes all optional parameters
# results = UIMetadataApi(api_client).get_tenant_ui_metadata()
print("The response of UIMetadataApi->get_tenant_ui_metadata:\n")
@@ -111,7 +111,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.ui_metadata_api import UIMetadataApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.tenant_ui_metadata_item_response import TenantUiMetadataItemResponse
@@ -120,18 +119,18 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
tenant_ui_metadata_item_update_request = {
tenant_ui_metadata_item_update_request = '''{
"usernameEmptyText" : "Please provide your work email address...",
"usernameLabel" : "Email",
"iframeWhiteList" : "http://example.com http://example2.com"
} # TenantUiMetadataItemUpdateRequest |
}''' # TenantUiMetadataItemUpdateRequest |
try:
# Update tenant UI metadata
new_tenant_ui_metadata_item_update_request = TenantUiMetadataItemUpdateRequest()
new_tenant_ui_metadata_item_update_request.from_json(tenant_ui_metadata_item_update_request)
results =UIMetadataApi(api_client).set_tenant_ui_metadata(new_tenant_ui_metadata_item_update_request)
new_tenant_ui_metadata_item_update_request = TenantUiMetadataItemUpdateRequest.from_json(tenant_ui_metadata_item_update_request)
results = UIMetadataApi(api_client).set_tenant_ui_metadata(tenant_ui_metadata_item_update_request=new_tenant_ui_metadata_item_update_request)
# Below is a request that includes all optional parameters
# results = UIMetadataApi(api_client).set_tenant_ui_metadata(new_tenant_ui_metadata_item_update_request)
print("The response of UIMetadataApi->set_tenant_ui_metadata:\n")

26
docs/tools/sdk/python/Reference/Beta/Methods/VendorConnectorMappingsApi.md
View File

@@ -58,7 +58,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.vendor_connector_mappings_api import VendorConnectorMappingsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.vendor_connector_mapping import VendorConnectorMapping
@@ -66,8 +65,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
vendor_connector_mapping = {
vendor_connector_mapping = '''{
"createdAt" : "2024-03-13T12:56:19.391294Z",
"deletedAt" : {
"Valid" : false,
@@ -89,13 +89,12 @@ with ApiClient(configuration) as api_client:
"Valid" : true,
"Time" : "2024-03-14T12:56:19.391294Z"
}
} # VendorConnectorMapping |
}''' # VendorConnectorMapping |
try:
# Create Vendor Connector Mapping
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)
new_vendor_connector_mapping = VendorConnectorMapping.from_json(vendor_connector_mapping)
results = VendorConnectorMappingsApi(api_client).create_vendor_connector_mapping(vendor_connector_mapping=new_vendor_connector_mapping)
# Below is a request that includes all optional parameters
# results = VendorConnectorMappingsApi(api_client).create_vendor_connector_mapping(new_vendor_connector_mapping)
print("The response of VendorConnectorMappingsApi->create_vendor_connector_mapping:\n")
@@ -142,7 +141,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.vendor_connector_mappings_api import VendorConnectorMappingsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.delete_vendor_connector_mapping200_response import DeleteVendorConnectorMapping200Response
@@ -151,8 +149,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
vendor_connector_mapping = {
vendor_connector_mapping = '''{
"createdAt" : "2024-03-13T12:56:19.391294Z",
"deletedAt" : {
"Valid" : false,
@@ -174,13 +173,12 @@ with ApiClient(configuration) as api_client:
"Valid" : true,
"Time" : "2024-03-14T12:56:19.391294Z"
}
} # VendorConnectorMapping |
}''' # VendorConnectorMapping |
try:
# Delete Vendor Connector Mapping
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)
new_vendor_connector_mapping = VendorConnectorMapping.from_json(vendor_connector_mapping)
results = VendorConnectorMappingsApi(api_client).delete_vendor_connector_mapping(vendor_connector_mapping=new_vendor_connector_mapping)
# Below is a request that includes all optional parameters
# results = VendorConnectorMappingsApi(api_client).delete_vendor_connector_mapping(new_vendor_connector_mapping)
print("The response of VendorConnectorMappingsApi->delete_vendor_connector_mapping:\n")
@@ -224,7 +222,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.vendor_connector_mappings_api import VendorConnectorMappingsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.vendor_connector_mapping import VendorConnectorMapping
@@ -232,12 +229,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Vendor Connector Mappings
results =VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings()
results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings()
# Below is a request that includes all optional parameters
# results = VendorConnectorMappingsApi(api_client).get_vendor_connector_mappings()
print("The response of VendorConnectorMappingsApi->get_vendor_connector_mappings:\n")

83
docs/tools/sdk/python/Reference/Beta/Methods/WorkItemsApi.md
View File

@@ -75,7 +75,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.work_items_api import WorkItemsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.work_items import WorkItems
@@ -83,6 +82,7 @@ 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.
@@ -90,7 +90,7 @@ with ApiClient(configuration) as api_client:
try:
# Approve an Approval Item
results =WorkItemsApi(api_client).approve_approval_item(id, approval_item_id)
results = WorkItemsApi(api_client).approve_approval_item(id=id, approval_item_id=approval_item_id)
# Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).approve_approval_item(id, approval_item_id)
print("The response of WorkItemsApi->approve_approval_item:\n")
@@ -133,7 +133,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.work_items_api import WorkItemsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.work_items import WorkItems
@@ -141,13 +140,14 @@ 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
results =WorkItemsApi(api_client).approve_approval_items_in_bulk(id)
results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id=id)
# Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).approve_approval_items_in_bulk(id)
print("The response of WorkItemsApi->approve_approval_items_in_bulk:\n")
@@ -171,6 +171,7 @@ This API completes a work item. Either an admin, or the owning/current user must
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | The ID of the work item
Body | body | **str** | (optional) | Body is the request payload to create form definition request
### Return type
[**WorkItems**](../models/work-items)
@@ -180,17 +181,19 @@ Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | A WorkItems object | WorkItems | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response | - |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.work_items_api import WorkItemsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.work_items import WorkItems
@@ -198,15 +201,17 @@ 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
body = 'body_example' # str | Body is the request payload to create form definition request (optional) # str | Body is the request payload to create form definition request (optional)
try:
# Complete a Work Item
results =WorkItemsApi(api_client).complete_work_item(id)
results = WorkItemsApi(api_client).complete_work_item(id=id)
# Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).complete_work_item(id)
# results = WorkItemsApi(api_client).complete_work_item(id, new_body)
print("The response of WorkItemsApi->complete_work_item:\n")
pprint(results)
except Exception as e:
@@ -250,7 +255,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.work_items_api import WorkItemsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.work_item_forward import WorkItemForward
@@ -258,19 +262,19 @@ 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 = {
work_item_forward = '''{
"targetOwnerId" : "2c9180835d2e5168015d32f890ca1581",
"comment" : "I'm going on vacation.",
"sendNotifications" : true
} # WorkItemForward |
}''' # WorkItemForward |
try:
# Forward a Work Item
new_work_item_forward = WorkItemForward()
new_work_item_forward.from_json(work_item_forward)
WorkItemsApi(api_client).forward_work_item(id, new_work_item_forward)
new_work_item_forward = WorkItemForward.from_json(work_item_forward)
WorkItemsApi(api_client).forward_work_item(id=id, work_item_forward=new_work_item_forward)
# Below is a request that includes all optional parameters
# WorkItemsApi(api_client).forward_work_item(id, new_work_item_forward)
except Exception as e:
@@ -314,7 +318,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.work_items_api import WorkItemsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.work_items import WorkItems
@@ -322,6 +325,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = 'owner_id_example' # 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)
@@ -331,7 +335,7 @@ with ApiClient(configuration) as api_client:
try:
# Completed Work Items
results =WorkItemsApi(api_client).get_completed_work_items()
results = WorkItemsApi(api_client).get_completed_work_items()
# Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).get_completed_work_items(owner_id, limit, offset, count)
print("The response of WorkItemsApi->get_completed_work_items:\n")
@@ -374,7 +378,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.work_items_api import WorkItemsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.work_items_count import WorkItemsCount
@@ -382,13 +385,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
try:
# Count Completed Work Items
results =WorkItemsApi(api_client).get_count_completed_work_items()
results = WorkItemsApi(api_client).get_count_completed_work_items()
# Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id)
print("The response of WorkItemsApi->get_count_completed_work_items:\n")
@@ -431,7 +435,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.work_items_api import WorkItemsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.work_items_count import WorkItemsCount
@@ -439,13 +442,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
try:
# Count Work Items
results =WorkItemsApi(api_client).get_count_work_items()
results = WorkItemsApi(api_client).get_count_work_items()
# Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).get_count_work_items(owner_id)
print("The response of WorkItemsApi->get_count_work_items:\n")
@@ -472,15 +476,18 @@ Path | id | **str** | True | ID of the work item.
Query | owner_id | **str** | (optional) | ID of the work item owner.
### Return type
[**List[WorkItems]**](../models/work-items)
**object**
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | The work item with the given ID. | List[WorkItems] | - |
200 | The work item with the given ID. | object | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response | - |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
### HTTP request headers
- **Content-Type**: Not defined
@@ -489,22 +496,21 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.work_items_api import WorkItemsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.work_items import WorkItems
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'id_example' # str | ID of the work item. # str | ID of the work item.
owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item. # str | ID of the work item.
owner_id = '2c9180835d191a86015d28455b4a2329' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
try:
# Get a Work Item
results =WorkItemsApi(api_client).get_work_item(id, )
results = WorkItemsApi(api_client).get_work_item(id=id)
# Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).get_work_item(id, owner_id)
print("The response of WorkItemsApi->get_work_item:\n")
@@ -547,7 +553,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.work_items_api import WorkItemsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.work_items_summary import WorkItemsSummary
@@ -555,13 +560,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
try:
# Work Items Summary
results =WorkItemsApi(api_client).get_work_items_summary()
results = WorkItemsApi(api_client).get_work_items_summary()
# Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).get_work_items_summary(owner_id)
print("The response of WorkItemsApi->get_work_items_summary:\n")
@@ -607,7 +613,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.work_items_api import WorkItemsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.work_items import WorkItems
@@ -615,6 +620,7 @@ 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)
@@ -624,7 +630,7 @@ with ApiClient(configuration) as api_client:
try:
# List Work Items
results =WorkItemsApi(api_client).list_work_items()
results = WorkItemsApi(api_client).list_work_items()
# Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).list_work_items(limit, offset, count, owner_id)
print("The response of WorkItemsApi->list_work_items:\n")
@@ -668,7 +674,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.work_items_api import WorkItemsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.work_items import WorkItems
@@ -676,6 +681,7 @@ 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.
@@ -683,7 +689,7 @@ with ApiClient(configuration) as api_client:
try:
# Reject an Approval Item
results =WorkItemsApi(api_client).reject_approval_item(id, approval_item_id)
results = WorkItemsApi(api_client).reject_approval_item(id=id, approval_item_id=approval_item_id)
# Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).reject_approval_item(id, approval_item_id)
print("The response of WorkItemsApi->reject_approval_item:\n")
@@ -726,7 +732,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.work_items_api import WorkItemsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.work_items import WorkItems
@@ -734,13 +739,14 @@ 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
results =WorkItemsApi(api_client).reject_approval_items_in_bulk(id)
results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id=id)
# Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).reject_approval_items_in_bulk(id)
print("The response of WorkItemsApi->reject_approval_items_in_bulk:\n")
@@ -784,7 +790,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.work_items_api import WorkItemsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.work_items import WorkItems
@@ -792,15 +797,15 @@ 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
new_request_body = RequestBody()
new_request_body.from_json(request_body)
results =WorkItemsApi(api_client).submit_account_selection(id, new_request_body)
new_request_body = RequestBody.from_json(request_body)
results = WorkItemsApi(api_client).submit_account_selection(id=id, request_body=new_request_body)
# Below is a request that includes all optional parameters
# results = WorkItemsApi(api_client).submit_account_selection(id, new_request_body)
print("The response of WorkItemsApi->submit_account_selection:\n")

61
docs/tools/sdk/python/Reference/Beta/Methods/WorkReassignmentApi.md
View File

@@ -68,7 +68,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.configuration_item_request import ConfigurationItemRequest
@@ -77,20 +76,20 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
configuration_item_request = {
configuration_item_request = '''{
"endDate" : "2022-07-30T17:00:00Z",
"reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e",
"configType" : "ACCESS_REQUESTS",
"reassignedToId" : "2c91808781a71ddb0181b9090b53504a",
"startDate" : "2022-07-21T11:13:12.345Z"
} # ConfigurationItemRequest |
}''' # ConfigurationItemRequest |
try:
# Create a Reassignment Configuration
new_configuration_item_request = ConfigurationItemRequest()
new_configuration_item_request.from_json(configuration_item_request)
results =WorkReassignmentApi(api_client).create_reassignment_configuration(new_configuration_item_request)
new_configuration_item_request = ConfigurationItemRequest.from_json(configuration_item_request)
results = WorkReassignmentApi(api_client).create_reassignment_configuration(configuration_item_request=new_configuration_item_request)
# Below is a request that includes all optional parameters
# results = WorkReassignmentApi(api_client).create_reassignment_configuration(new_configuration_item_request)
print("The response of WorkReassignmentApi->create_reassignment_configuration:\n")
@@ -136,7 +135,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.config_type_enum import ConfigTypeEnum
@@ -144,6 +142,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id
config_type = sailpoint.beta.ConfigTypeEnum() # ConfigTypeEnum | # ConfigTypeEnum |
@@ -151,7 +150,7 @@ with ApiClient(configuration) as api_client:
try:
# Delete Reassignment Configuration
WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id, config_type)
WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id=identity_id, config_type=config_type)
# Below is a request that includes all optional parameters
# WorkReassignmentApi(api_client).delete_reassignment_configuration(identity_id, config_type)
except Exception as e:
@@ -196,7 +195,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.config_type_enum import ConfigTypeEnum
@@ -205,17 +203,16 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id
config_type = sailpoint.beta.ConfigTypeEnum() # ConfigTypeEnum | Reassignment work type # ConfigTypeEnum | Reassignment work type
exclusion_filters = ['SELF_REVIEW_DELEGATION'] # List[str] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional)
exclusion_filters = ['SELF_REVIEW_DELEGATION'] # List[str] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional)
exclusion_filters = '''['SELF_REVIEW_DELEGATION']''' # List[str] | Exclusion filters that disable parts of the reassignment evaluation. Possible values are listed below: - `SELF_REVIEW_DELEGATION`: This will exclude delegations of self-review reassignments (optional)
try:
# Evaluate Reassignment Configuration
results =WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, )
results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id=identity_id, config_type=config_type)
# Below is a request that includes all optional parameters
# results = WorkReassignmentApi(api_client).get_evaluate_reassignment_configuration(identity_id, config_type, exclusion_filters)
print("The response of WorkReassignmentApi->get_evaluate_reassignment_configuration:\n")
@@ -257,7 +254,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.config_type import ConfigType
@@ -265,12 +261,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Reassignment Config Types
results =WorkReassignmentApi(api_client).get_reassignment_config_types()
results = WorkReassignmentApi(api_client).get_reassignment_config_types()
# Below is a request that includes all optional parameters
# results = WorkReassignmentApi(api_client).get_reassignment_config_types()
print("The response of WorkReassignmentApi->get_reassignment_config_types:\n")
@@ -316,7 +313,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.configuration_response import ConfigurationResponse
@@ -324,13 +320,14 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = '2c91808781a71ddb0181b9090b5c504f' # str | unique identity id # str | unique identity id
try:
# Get Reassignment Configuration
results =WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id)
results = WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id=identity_id)
# Below is a request that includes all optional parameters
# results = WorkReassignmentApi(api_client).get_reassignment_configuration(identity_id)
print("The response of WorkReassignmentApi->get_reassignment_configuration:\n")
@@ -373,7 +370,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.tenant_configuration_response import TenantConfigurationResponse
@@ -381,12 +377,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Tenant-wide Reassignment Configuration settings
results =WorkReassignmentApi(api_client).get_tenant_config_configuration()
results = WorkReassignmentApi(api_client).get_tenant_config_configuration()
# Below is a request that includes all optional parameters
# results = WorkReassignmentApi(api_client).get_tenant_config_configuration()
print("The response of WorkReassignmentApi->get_tenant_config_configuration:\n")
@@ -433,7 +430,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.configuration_response import ConfigurationResponse
@@ -441,6 +437,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
limit = 20 # int | Max number of results to return. (optional) (default to 20) # int | Max number of results to return. (optional) (default to 20)
offset = 10 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional)
@@ -448,7 +445,7 @@ with ApiClient(configuration) as api_client:
try:
# List Reassignment Configurations
results =WorkReassignmentApi(api_client).list_reassignment_configurations()
results = WorkReassignmentApi(api_client).list_reassignment_configurations()
# Below is a request that includes all optional parameters
# results = WorkReassignmentApi(api_client).list_reassignment_configurations(limit, offset)
print("The response of WorkReassignmentApi->list_reassignment_configurations:\n")
@@ -494,7 +491,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.configuration_item_request import ConfigurationItemRequest
@@ -503,21 +499,21 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = '2c91808781a71ddb0181b9090b5c504e' # str | unique identity id # str | unique identity id
configuration_item_request = {
configuration_item_request = '''{
"endDate" : "2022-07-30T17:00:00Z",
"reassignedFromId" : "2c91808781a71ddb0181b9090b5c504e",
"configType" : "ACCESS_REQUESTS",
"reassignedToId" : "2c91808781a71ddb0181b9090b53504a",
"startDate" : "2022-07-21T11:13:12.345Z"
} # ConfigurationItemRequest |
}''' # ConfigurationItemRequest |
try:
# Update Reassignment Configuration
new_configuration_item_request = ConfigurationItemRequest()
new_configuration_item_request.from_json(configuration_item_request)
results =WorkReassignmentApi(api_client).put_reassignment_config(identity_id, new_configuration_item_request)
new_configuration_item_request = ConfigurationItemRequest.from_json(configuration_item_request)
results = WorkReassignmentApi(api_client).put_reassignment_config(identity_id=identity_id, configuration_item_request=new_configuration_item_request)
# Below is a request that includes all optional parameters
# results = WorkReassignmentApi(api_client).put_reassignment_config(identity_id, new_configuration_item_request)
print("The response of WorkReassignmentApi->put_reassignment_config:\n")
@@ -562,7 +558,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.work_reassignment_api import WorkReassignmentApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.tenant_configuration_request import TenantConfigurationRequest
@@ -571,18 +566,18 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
tenant_configuration_request = {
tenant_configuration_request = '''{
"configDetails" : {
"disabled" : true
}
} # TenantConfigurationRequest |
}''' # TenantConfigurationRequest |
try:
# Update Tenant-wide Reassignment Configuration settings
new_tenant_configuration_request = TenantConfigurationRequest()
new_tenant_configuration_request.from_json(tenant_configuration_request)
results =WorkReassignmentApi(api_client).put_tenant_configuration(new_tenant_configuration_request)
new_tenant_configuration_request = TenantConfigurationRequest.from_json(tenant_configuration_request)
results = WorkReassignmentApi(api_client).put_tenant_configuration(tenant_configuration_request=new_tenant_configuration_request)
# Below is a request that includes all optional parameters
# results = WorkReassignmentApi(api_client).put_tenant_configuration(new_tenant_configuration_request)
print("The response of WorkReassignmentApi->put_tenant_configuration:\n")

104
docs/tools/sdk/python/Reference/Beta/Methods/WorkflowsApi.md
View File

@@ -69,20 +69,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.workflows_api import WorkflowsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | The workflow execution ID # str | The workflow execution ID
try:
# Cancel Workflow Execution by ID
WorkflowsApi(api_client).cancel_workflow_execution(id)
WorkflowsApi(api_client).cancel_workflow_execution(id=id)
# Below is a request that includes all optional parameters
# WorkflowsApi(api_client).cancel_workflow_execution(id)
except Exception as e:
@@ -125,7 +125,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.workflows_api import WorkflowsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.create_workflow_request import CreateWorkflowRequest
@@ -134,14 +133,14 @@ 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 |
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
new_create_workflow_request = CreateWorkflowRequest()
new_create_workflow_request.from_json(create_workflow_request)
results =WorkflowsApi(api_client).create_workflow(new_create_workflow_request)
new_create_workflow_request = CreateWorkflowRequest.from_json(create_workflow_request)
results = WorkflowsApi(api_client).create_workflow(create_workflow_request=new_create_workflow_request)
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).create_workflow(new_create_workflow_request)
print("The response of WorkflowsApi->create_workflow:\n")
@@ -186,20 +185,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.workflows_api import WorkflowsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Id of the Workflow # str | Id of the Workflow
try:
# Delete Workflow By Id
WorkflowsApi(api_client).delete_workflow(id)
WorkflowsApi(api_client).delete_workflow(id=id)
# Below is a request that includes all optional parameters
# WorkflowsApi(api_client).delete_workflow(id)
except Exception as e:
@@ -242,7 +241,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.workflows_api import WorkflowsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.workflow import Workflow
@@ -250,13 +248,14 @@ 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
results =WorkflowsApi(api_client).get_workflow(id)
results = WorkflowsApi(api_client).get_workflow(id=id)
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).get_workflow(id)
print("The response of WorkflowsApi->get_workflow:\n")
@@ -302,20 +301,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.workflows_api import WorkflowsApi
from sailpoint.beta.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'c17bea3a-574d-453c-9e04-4365fbf5af0b' # str | Workflow execution ID. # str | Workflow execution ID.
try:
# Get Workflow Execution
results =WorkflowsApi(api_client).get_workflow_execution(id)
results = WorkflowsApi(api_client).get_workflow_execution(id=id)
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).get_workflow_execution(id)
print("The response of WorkflowsApi->get_workflow_execution:\n")
@@ -361,7 +360,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.workflows_api import WorkflowsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.workflow_execution_event import WorkflowExecutionEvent
@@ -369,13 +367,14 @@ 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
results =WorkflowsApi(api_client).get_workflow_execution_history(id)
results = WorkflowsApi(api_client).get_workflow_execution_history(id=id)
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).get_workflow_execution_history(id)
print("The response of WorkflowsApi->get_workflow_execution_history:\n")
@@ -435,7 +434,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.workflows_api import WorkflowsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.workflow_execution import WorkflowExecution
@@ -443,6 +441,7 @@ 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)
@@ -453,7 +452,7 @@ with ApiClient(configuration) as api_client:
try:
# List Workflow Executions
results =WorkflowsApi(api_client).get_workflow_executions(id, )
results = WorkflowsApi(api_client).get_workflow_executions(id=id)
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).get_workflow_executions(id, limit, offset, count, filters)
print("The response of WorkflowsApi->get_workflow_executions:\n")
@@ -499,7 +498,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.workflows_api import WorkflowsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.list_complete_workflow_library200_response_inner import ListCompleteWorkflowLibrary200ResponseInner
@@ -507,6 +505,7 @@ 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)
@@ -514,7 +513,7 @@ with ApiClient(configuration) as api_client:
try:
# List Complete Workflow Library
results =WorkflowsApi(api_client).list_complete_workflow_library()
results = WorkflowsApi(api_client).list_complete_workflow_library()
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).list_complete_workflow_library(limit, offset)
print("The response of WorkflowsApi->list_complete_workflow_library:\n")
@@ -561,7 +560,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.workflows_api import WorkflowsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.workflow_library_action import WorkflowLibraryAction
@@ -569,6 +567,7 @@ 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)
@@ -577,7 +576,7 @@ with ApiClient(configuration) as api_client:
try:
# List Workflow Library Actions
results =WorkflowsApi(api_client).list_workflow_library_actions()
results = WorkflowsApi(api_client).list_workflow_library_actions()
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).list_workflow_library_actions(limit, offset, filters)
print("The response of WorkflowsApi->list_workflow_library_actions:\n")
@@ -619,7 +618,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.workflows_api import WorkflowsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.workflow_library_operator import WorkflowLibraryOperator
@@ -627,12 +625,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Workflow Library Operators
results =WorkflowsApi(api_client).list_workflow_library_operators()
results = WorkflowsApi(api_client).list_workflow_library_operators()
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).list_workflow_library_operators()
print("The response of WorkflowsApi->list_workflow_library_operators:\n")
@@ -679,7 +678,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.workflows_api import WorkflowsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.workflow_library_trigger import WorkflowLibraryTrigger
@@ -687,6 +685,7 @@ 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)
@@ -695,7 +694,7 @@ with ApiClient(configuration) as api_client:
try:
# List Workflow Library Triggers
results =WorkflowsApi(api_client).list_workflow_library_triggers()
results = WorkflowsApi(api_client).list_workflow_library_triggers()
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).list_workflow_library_triggers(limit, offset, filters)
print("The response of WorkflowsApi->list_workflow_library_triggers:\n")
@@ -737,7 +736,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.workflows_api import WorkflowsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.workflow import Workflow
@@ -745,12 +743,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Workflows
results =WorkflowsApi(api_client).list_workflows()
results = WorkflowsApi(api_client).list_workflows()
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).list_workflows()
print("The response of WorkflowsApi->list_workflows:\n")
@@ -796,7 +795,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.workflows_api import WorkflowsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.json_patch_operation import JsonPatchOperation
@@ -805,21 +803,15 @@ 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 = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] |
json_patch_operation = '''[{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] |
try:
# Patch Workflow
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)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = WorkflowsApi(api_client).patch_workflow(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).patch_workflow(id, new_json_patch_operation)
print("The response of WorkflowsApi->patch_workflow:\n")
@@ -865,7 +857,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.workflows_api import WorkflowsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.post_external_execute_workflow200_response import PostExternalExecuteWorkflow200Response
@@ -874,14 +865,15 @@ 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
post_external_execute_workflow_request = sailpoint.beta.PostExternalExecuteWorkflowRequest() # PostExternalExecuteWorkflowRequest | (optional)
post_external_execute_workflow_request = '''sailpoint.beta.PostExternalExecuteWorkflowRequest()''' # PostExternalExecuteWorkflowRequest | (optional)
try:
# Execute Workflow via External Trigger
results =WorkflowsApi(api_client).post_external_execute_workflow(id, )
results = WorkflowsApi(api_client).post_external_execute_workflow(id=id)
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).post_external_execute_workflow(id, new_post_external_execute_workflow_request)
print("The response of WorkflowsApi->post_external_execute_workflow:\n")
@@ -926,7 +918,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.workflows_api import WorkflowsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.workflow_o_auth_client import WorkflowOAuthClient
@@ -934,13 +925,14 @@ 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
results =WorkflowsApi(api_client).post_workflow_external_trigger(id)
results = WorkflowsApi(api_client).post_workflow_external_trigger(id=id)
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).post_workflow_external_trigger(id)
print("The response of WorkflowsApi->post_workflow_external_trigger:\n")
@@ -986,7 +978,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.workflows_api import WorkflowsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.test_external_execute_workflow200_response import TestExternalExecuteWorkflow200Response
@@ -995,14 +986,15 @@ 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.beta.TestExternalExecuteWorkflowRequest() # TestExternalExecuteWorkflowRequest | (optional)
test_external_execute_workflow_request = '''sailpoint.beta.TestExternalExecuteWorkflowRequest()''' # TestExternalExecuteWorkflowRequest | (optional)
try:
# Test Workflow via External Trigger
results =WorkflowsApi(api_client).test_external_execute_workflow(id, )
results = WorkflowsApi(api_client).test_external_execute_workflow(id=id)
# Below is a request that includes all optional parameters
# 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")
@@ -1050,7 +1042,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.workflows_api import WorkflowsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.test_workflow200_response import TestWorkflow200Response
@@ -1059,15 +1050,15 @@ 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 |
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
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)
new_test_workflow_request = TestWorkflowRequest.from_json(test_workflow_request)
results = WorkflowsApi(api_client).test_workflow(id=id, test_workflow_request=new_test_workflow_request)
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).test_workflow(id, new_test_workflow_request)
print("The response of WorkflowsApi->test_workflow:\n")
@@ -1113,7 +1104,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.workflows_api import WorkflowsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.workflow import Workflow
@@ -1122,9 +1112,10 @@ 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 = {
workflow_body = '''{
"owner" : {
"name" : "William Wilson",
"id" : "2c91808568c529c60168cca6f90c1313",
@@ -1161,13 +1152,12 @@ with ApiClient(configuration) as api_client:
"type" : "EVENT"
},
"enabled" : false
} # WorkflowBody |
}''' # WorkflowBody |
try:
# Update Workflow
new_workflow_body = WorkflowBody()
new_workflow_body.from_json(workflow_body)
results =WorkflowsApi(api_client).update_workflow(id, new_workflow_body)
new_workflow_body = WorkflowBody.from_json(workflow_body)
results = WorkflowsApi(api_client).update_workflow(id=id, workflow_body=new_workflow_body)
# Below is a request that includes all optional parameters
# results = WorkflowsApi(api_client).update_workflow(id, new_workflow_body)
print("The response of WorkflowsApi->update_workflow:\n")

4
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestTracking.md
View File

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**requested_for** | **str** | The identity id in which the access request is for. | [optional]
**requested_items_details** | [**[]RequestedItemDetails**](requested-item-details) | The details of the item requested. | [optional]
**attributes_hash** | **str** | a hash representation of the access requested, useful for longer term tracking client side. | [optional]
**attributes_hash** | **int** | a hash representation of the access requested, useful for longer term tracking client side. | [optional]
**access_request_ids** | **[]str** | a list of access request identifiers, generally only one will be populated, but high volume requested may result in multiple ids. | [optional]
}
@@ -33,7 +33,7 @@ requested_items_details={
"type": "ENTITLEMENT",
"id": "779c6fd7171540bba1184e5946112c28"
},
attributes_hash='-1928438224',
attributes_hash=-1928438224,
access_request_ids=[5d3118c518a44ec7805450d53479ccdb]
)

2
docs/tools/sdk/python/Reference/Beta/Models/FormDefinitionInput.md
View File

@@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'FormDefinitionInput', 'BetaFormDefini
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Unique identifier for the form input. | [optional]
**type** | **Enum** [ 'STRING' ] | FormDefinitionInputType value. STRING FormDefinitionInputTypeString | [optional]
**type** | **Enum** [ 'STRING', 'ARRAY' ] | FormDefinitionInputType value. STRING FormDefinitionInputTypeString | [optional]
**label** | **str** | Name for the form input. | [optional]
**description** | **str** | Form input's description. | [optional]
}

4
docs/tools/sdk/python/Reference/Beta/Models/PendingApproval.md
View File

@@ -35,6 +35,7 @@ Name | Type | Description | Notes
**remove_date_update_requested** | **bool** | If true, then the request is to change the remove date or sunset date. | [optional] [default to False]
**current_remove_date** | **datetime** | The remove date or sunset date that was assigned at the time of the request. | [optional]
**sod_violation_context** | [**SodViolationContextCheckCompleted1**](sod-violation-context-check-completed1) | | [optional]
**client_metadata** | **map[string]str** | Arbitrary key-value pairs, if any were included in the corresponding access request item | [optional]
}
## Example
@@ -126,7 +127,8 @@ sod_violation_context=sailpoint.beta.models.sod_violation_context_check_complete
sailpoint.beta.models.sod_policy_dto.SodPolicyDto(
id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde',
name = 'Business SOD Policy', )
], ), )
], ), ),
client_metadata={customKey1=custom value 1, customKey2=custom value 2}
)
```

52
docs/tools/sdk/python/Reference/V2024/Methods/AccessModelMetadataApi.md
View File

@@ -35,6 +35,14 @@ Method | HTTP request | Description
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Get Access Model Metadata Attribute
Get single Access Model Metadata Attribute
@@ -67,7 +75,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_model_metadata_api import AccessModelMetadataApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.attribute_dto import AttributeDTO
@@ -75,6 +82,8 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
@@ -82,7 +91,7 @@ with ApiClient(configuration) as api_client:
try:
# Get Access Model Metadata Attribute
results =AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key, x_sail_point_experimental)
results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key=key, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key, x_sail_point_experimental)
print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute:\n")
@@ -99,6 +108,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Get Access Model Metadata Value
Get single Access Model Metadata Attribute Value
@@ -132,7 +149,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_model_metadata_api import AccessModelMetadataApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.attribute_value_dto import AttributeValueDTO
@@ -140,6 +156,8 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
value = 'public' # str | Technical name of the Attribute value. # str | Technical name of the Attribute value.
@@ -148,7 +166,7 @@ with ApiClient(configuration) as api_client:
try:
# Get Access Model Metadata Value
results =AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key, value, x_sail_point_experimental)
results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key=key, value=value, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key, value, x_sail_point_experimental)
print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute_value:\n")
@@ -165,6 +183,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
List Access Model Metadata Attributes
Get a list of Access Model Metadata Attributes
@@ -197,7 +223,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_model_metadata_api import AccessModelMetadataApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.attribute_dto import AttributeDTO
@@ -205,6 +230,8 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
filters = 'name eq \"Privacy\"' # 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**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (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**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional)
@@ -212,7 +239,7 @@ with ApiClient(configuration) as api_client:
try:
# List Access Model Metadata Attributes
results =AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental, )
results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental, filters)
print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n")
@@ -229,6 +256,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
List Access Model Metadata Values
Get a list of Access Model Metadata Attribute Values
@@ -261,7 +296,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_model_metadata_api import AccessModelMetadataApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.attribute_value_dto import AttributeValueDTO
@@ -269,6 +303,8 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
@@ -276,7 +312,7 @@ with ApiClient(configuration) as api_client:
try:
# List Access Model Metadata Values
results =AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key, x_sail_point_experimental)
results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key=key, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key, x_sail_point_experimental)
print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n")

73
docs/tools/sdk/python/Reference/V2024/Methods/AccessProfilesApi.md
View File

@@ -93,7 +93,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_profiles_api import AccessProfilesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_profile import AccessProfile
@@ -101,8 +100,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
access_profile = {
access_profile = '''{
"owner" : {
"name" : "support",
"id" : "2c9180a46faadee4016fb4e018c20639",
@@ -186,13 +186,12 @@ with ApiClient(configuration) as api_client:
"modified" : "2021-03-02T20:22:28.104Z",
"id" : "2c91808a7190d06e01719938fcd20792",
"requestable" : true
} # AccessProfile |
}''' # AccessProfile |
try:
# Create Access Profile
new_access_profile = AccessProfile()
new_access_profile.from_json(access_profile)
results =AccessProfilesApi(api_client).create_access_profile(new_access_profile)
new_access_profile = AccessProfile.from_json(access_profile)
results = AccessProfilesApi(api_client).create_access_profile(access_profile=new_access_profile)
# Below is a request that includes all optional parameters
# results = AccessProfilesApi(api_client).create_access_profile(new_access_profile)
print("The response of AccessProfilesApi->create_access_profile:\n")
@@ -241,20 +240,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_profiles_api import AccessProfilesApi
from sailpoint.v2024.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
AccessProfilesApi(api_client).delete_access_profile(id)
AccessProfilesApi(api_client).delete_access_profile(id=id)
# Below is a request that includes all optional parameters
# AccessProfilesApi(api_client).delete_access_profile(id)
except Exception as e:
@@ -302,7 +301,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_profiles_api import AccessProfilesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_profile_bulk_delete_request import AccessProfileBulkDeleteRequest
@@ -311,17 +309,17 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
access_profile_bulk_delete_request = {
access_profile_bulk_delete_request = '''{
"accessProfileIds" : [ "2c9180847812e0b1017817051919ecca", "2c9180887812e0b201781e129f151816" ],
"bestEffortOnly" : true
} # AccessProfileBulkDeleteRequest |
}''' # AccessProfileBulkDeleteRequest |
try:
# Delete Access Profile(s)
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)
new_access_profile_bulk_delete_request = AccessProfileBulkDeleteRequest.from_json(access_profile_bulk_delete_request)
results = AccessProfilesApi(api_client).delete_access_profiles_in_bulk(access_profile_bulk_delete_request=new_access_profile_bulk_delete_request)
# Below is a request that includes all optional parameters
# 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")
@@ -366,7 +364,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_profiles_api import AccessProfilesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_profile import AccessProfile
@@ -374,13 +371,14 @@ 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
results =AccessProfilesApi(api_client).get_access_profile(id)
results = AccessProfilesApi(api_client).get_access_profile(id=id)
# Below is a request that includes all optional parameters
# results = AccessProfilesApi(api_client).get_access_profile(id)
print("The response of AccessProfilesApi->get_access_profile:\n")
@@ -432,7 +430,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_profiles_api import AccessProfilesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.entitlement import Entitlement
@@ -440,6 +437,7 @@ 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)
@@ -451,7 +449,7 @@ with ApiClient(configuration) as api_client:
try:
# List Access Profile's Entitlements
results =AccessProfilesApi(api_client).get_access_profile_entitlements(id, )
results = AccessProfilesApi(api_client).get_access_profile_entitlements(id=id)
# Below is a request that includes all optional parameters
# results = AccessProfilesApi(api_client).get_access_profile_entitlements(id, limit, offset, count, filters, sorters)
print("The response of AccessProfilesApi->get_access_profile_entitlements:\n")
@@ -504,7 +502,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_profiles_api import AccessProfilesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_profile import AccessProfile
@@ -512,6 +509,7 @@ 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)
@@ -525,7 +523,7 @@ with ApiClient(configuration) as api_client:
try:
# List Access Profiles
results =AccessProfilesApi(api_client).list_access_profiles()
results = AccessProfilesApi(api_client).list_access_profiles()
# Below is a request that includes all optional parameters
# 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")
@@ -600,7 +598,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_profiles_api import AccessProfilesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_profile import AccessProfile
@@ -609,21 +606,15 @@ 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 = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] |
json_patch_operation = '''[{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}]''' # List[JsonPatchOperation] |
try:
# Patch a specified Access Profile
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)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = AccessProfilesApi(api_client).patch_access_profile(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = AccessProfilesApi(api_client).patch_access_profile(id, new_json_patch_operation)
print("The response of AccessProfilesApi->patch_access_profile:\n")
@@ -640,6 +631,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Update Access Profile(s) requestable field.
This API initiates a bulk update of field requestable for one or more Access Profiles.
@@ -679,7 +678,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_profiles_api import AccessProfilesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_profile_bulk_update_request_inner import AccessProfileBulkUpdateRequestInner
@@ -688,17 +686,16 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}] # List[AccessProfileBulkUpdateRequestInner] |
access_profile_bulk_update_request_inner = [{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}] # List[AccessProfileBulkUpdateRequestInner] |
access_profile_bulk_update_request_inner = '''[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]''' # List[AccessProfileBulkUpdateRequestInner] |
try:
# Update Access Profile(s) requestable field.
new_access_profile_bulk_update_request_inner = AccessProfileBulkUpdateRequestInner()
new_access_profile_bulk_update_request_inner.from_json(access_profile_bulk_update_request_inner)
results =AccessProfilesApi(api_client).update_access_profiles_in_bulk(x_sail_point_experimental, new_access_profile_bulk_update_request_inner)
new_access_profile_bulk_update_request_inner = AccessProfileBulkUpdateRequestInner.from_json(access_profile_bulk_update_request_inner)
results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(x_sail_point_experimental=x_sail_point_experimental, access_profile_bulk_update_request_inner=new_access_profile_bulk_update_request_inner)
# Below is a request that includes all optional parameters
# results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(x_sail_point_experimental, new_access_profile_bulk_update_request_inner)
print("The response of AccessProfilesApi->update_access_profiles_in_bulk:\n")

46
docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestApprovalsApi.md
View File

@@ -75,7 +75,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.comment_dto import CommentDto
@@ -83,9 +82,10 @@ 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 = {
comment_dto = '''{
"created" : "2017-07-11T18:45:37.098Z",
"author" : {
"name" : "john.doe",
@@ -93,12 +93,12 @@ with ApiClient(configuration) as api_client:
"type" : "IDENTITY"
},
"comment" : "This is a comment."
} # CommentDto | Reviewer's comment. (optional)
}''' # CommentDto | Reviewer's comment. (optional)
try:
# Approve Access Request Approval
results =AccessRequestApprovalsApi(api_client).approve_access_request(approval_id, )
results = AccessRequestApprovalsApi(api_client).approve_access_request(approval_id=approval_id)
# Below is a request that includes all optional parameters
# results = AccessRequestApprovalsApi(api_client).approve_access_request(approval_id, new_comment_dto)
print("The response of AccessRequestApprovalsApi->approve_access_request:\n")
@@ -145,7 +145,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.forward_approval_dto import ForwardApprovalDto
@@ -153,18 +152,18 @@ 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 = {
forward_approval_dto = '''{
"newOwnerId" : "2c91808568c529c60168cca6f90c1314",
"comment" : "2c91808568c529c60168cca6f90c1313"
} # ForwardApprovalDto | Information about the forwarded approval.
}''' # ForwardApprovalDto | Information about the forwarded approval.
try:
# Forward Access Request Approval
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)
new_forward_approval_dto = ForwardApprovalDto.from_json(forward_approval_dto)
results = AccessRequestApprovalsApi(api_client).forward_access_request(approval_id=approval_id, forward_approval_dto=new_forward_approval_dto)
# Below is a request that includes all optional parameters
# results = AccessRequestApprovalsApi(api_client).forward_access_request(approval_id, new_forward_approval_dto)
print("The response of AccessRequestApprovalsApi->forward_access_request:\n")
@@ -210,7 +209,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.approval_summary import ApprovalSummary
@@ -218,6 +216,7 @@ 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)
@@ -225,7 +224,7 @@ with ApiClient(configuration) as api_client:
try:
# Get Access Requests Approvals Number
results =AccessRequestApprovalsApi(api_client).get_access_request_approval_summary()
results = AccessRequestApprovalsApi(api_client).get_access_request_approval_summary()
# Below is a request that includes all optional parameters
# results = AccessRequestApprovalsApi(api_client).get_access_request_approval_summary(owner_id, from_date)
print("The response of AccessRequestApprovalsApi->get_access_request_approval_summary:\n")
@@ -275,7 +274,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_request_approvers_list_response import AccessRequestApproversListResponse
@@ -283,6 +281,7 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
access_request_id = '2c91808568c529c60168cca6f90c1313' # str | Access Request ID. # str | Access Request ID.
limit = 250 # int | Max number of results to return. (optional) (default to 250) # int | Max number of results to return. (optional) (default to 250)
@@ -292,7 +291,7 @@ with ApiClient(configuration) as api_client:
try:
# Access Request Approvers
results =AccessRequestApprovalsApi(api_client).list_access_request_approvers(access_request_id, )
results = AccessRequestApprovalsApi(api_client).list_access_request_approvers(access_request_id=access_request_id)
# Below is a request that includes all optional parameters
# results = AccessRequestApprovalsApi(api_client).list_access_request_approvers(access_request_id, limit, offset, count)
print("The response of AccessRequestApprovalsApi->list_access_request_approvers:\n")
@@ -342,7 +341,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.completed_approval import CompletedApproval
@@ -350,6 +348,7 @@ 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)
@@ -361,7 +360,7 @@ with ApiClient(configuration) as api_client:
try:
# Completed Access Request Approvals List
results =AccessRequestApprovalsApi(api_client).list_completed_approvals()
results = AccessRequestApprovalsApi(api_client).list_completed_approvals()
# Below is a request that includes all optional parameters
# results = AccessRequestApprovalsApi(api_client).list_completed_approvals(owner_id, limit, offset, count, filters, sorters)
print("The response of AccessRequestApprovalsApi->list_completed_approvals:\n")
@@ -411,7 +410,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.pending_approval import PendingApproval
@@ -419,6 +417,7 @@ 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)
@@ -430,7 +429,7 @@ with ApiClient(configuration) as api_client:
try:
# Pending Access Request Approvals List
results =AccessRequestApprovalsApi(api_client).list_pending_approvals()
results = AccessRequestApprovalsApi(api_client).list_pending_approvals()
# Below is a request that includes all optional parameters
# results = AccessRequestApprovalsApi(api_client).list_pending_approvals(owner_id, limit, offset, count, filters, sorters)
print("The response of AccessRequestApprovalsApi->list_pending_approvals:\n")
@@ -477,7 +476,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_request_approvals_api import AccessRequestApprovalsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.comment_dto import CommentDto
@@ -485,9 +483,10 @@ 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 = {
comment_dto = '''{
"created" : "2017-07-11T18:45:37.098Z",
"author" : {
"name" : "john.doe",
@@ -495,13 +494,12 @@ with ApiClient(configuration) as api_client:
"type" : "IDENTITY"
},
"comment" : "This is a comment."
} # CommentDto | Reviewer's comment.
}''' # CommentDto | Reviewer's comment.
try:
# Reject Access Request Approval
new_comment_dto = CommentDto()
new_comment_dto.from_json(comment_dto)
results =AccessRequestApprovalsApi(api_client).reject_access_request(approval_id, new_comment_dto)
new_comment_dto = CommentDto.from_json(comment_dto)
results = AccessRequestApprovalsApi(api_client).reject_access_request(approval_id=approval_id, comment_dto=new_comment_dto)
# Below is a request that includes all optional parameters
# results = AccessRequestApprovalsApi(api_client).reject_access_request(approval_id, new_comment_dto)
print("The response of AccessRequestApprovalsApi->reject_access_request:\n")

4
docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestIdentityMetricsApi.md
View File

@@ -56,13 +56,13 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_request_identity_metrics_api import AccessRequestIdentityMetricsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_id = '7025c863-c270-4ba6-beea-edf3cb091573' # str | Manager's identity ID. # str | Manager's identity ID.
requested_object_id = '2db501be-f0fb-4cc5-a695-334133c52891' # str | Requested access item's ID. # str | Requested access item's ID.
@@ -71,7 +71,7 @@ with ApiClient(configuration) as api_client:
try:
# Return access request identity metrics
results =AccessRequestIdentityMetricsApi(api_client).get_access_request_identity_metrics(identity_id, requested_object_id, type)
results = AccessRequestIdentityMetricsApi(api_client).get_access_request_identity_metrics(identity_id=identity_id, requested_object_id=requested_object_id, type=type)
# Below is a request that includes all optional parameters
# results = AccessRequestIdentityMetricsApi(api_client).get_access_request_identity_metrics(identity_id, requested_object_id, type)
print("The response of AccessRequestIdentityMetricsApi->get_access_request_identity_metrics:\n")

87
docs/tools/sdk/python/Reference/V2024/Methods/AccessRequestsApi.md
View File

@@ -74,7 +74,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.bulk_approve_access_request import BulkApproveAccessRequest
@@ -82,17 +81,17 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
bulk_approve_access_request = {
bulk_approve_access_request = '''{
"comment" : "I approve these request items",
"approvalIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ]
} # BulkApproveAccessRequest |
}''' # BulkApproveAccessRequest |
try:
# Bulk Approve Access Request
new_bulk_approve_access_request = BulkApproveAccessRequest()
new_bulk_approve_access_request.from_json(bulk_approve_access_request)
results =AccessRequestsApi(api_client).approve_bulk_access_request(new_bulk_approve_access_request)
new_bulk_approve_access_request = BulkApproveAccessRequest.from_json(bulk_approve_access_request)
results = AccessRequestsApi(api_client).approve_bulk_access_request(bulk_approve_access_request=new_bulk_approve_access_request)
# Below is a request that includes all optional parameters
# results = AccessRequestsApi(api_client).approve_bulk_access_request(new_bulk_approve_access_request)
print("The response of AccessRequestsApi->approve_bulk_access_request:\n")
@@ -139,7 +138,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.cancel_access_request import CancelAccessRequest
@@ -147,17 +145,17 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
cancel_access_request = {
cancel_access_request = '''{
"accountActivityId" : "2c9180835d2e5168015d32f890ca1581",
"comment" : "I requested this role by mistake."
} # CancelAccessRequest |
}''' # CancelAccessRequest |
try:
# Cancel Access Request
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)
new_cancel_access_request = CancelAccessRequest.from_json(cancel_access_request)
results = AccessRequestsApi(api_client).cancel_access_request(cancel_access_request=new_cancel_access_request)
# Below is a request that includes all optional parameters
# results = AccessRequestsApi(api_client).cancel_access_request(new_cancel_access_request)
print("The response of AccessRequestsApi->cancel_access_request:\n")
@@ -204,7 +202,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.bulk_cancel_access_request import BulkCancelAccessRequest
@@ -212,17 +209,17 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
bulk_cancel_access_request = {
bulk_cancel_access_request = '''{
"accessRequestIds" : [ "2c9180835d2e5168015d32f890ca1581", "2c9180835d2e5168015d32f890ca1582" ],
"comment" : "I requested this role by mistake."
} # BulkCancelAccessRequest |
}''' # BulkCancelAccessRequest |
try:
# Bulk Cancel Access Request
new_bulk_cancel_access_request = BulkCancelAccessRequest()
new_bulk_cancel_access_request.from_json(bulk_cancel_access_request)
results =AccessRequestsApi(api_client).cancel_access_request_in_bulk(new_bulk_cancel_access_request)
new_bulk_cancel_access_request = BulkCancelAccessRequest.from_json(bulk_cancel_access_request)
results = AccessRequestsApi(api_client).cancel_access_request_in_bulk(bulk_cancel_access_request=new_bulk_cancel_access_request)
# Below is a request that includes all optional parameters
# results = AccessRequestsApi(api_client).cancel_access_request_in_bulk(new_bulk_cancel_access_request)
print("The response of AccessRequestsApi->cancel_access_request_in_bulk:\n")
@@ -239,6 +236,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Close Access Request
This endpoint closes access requests that are stuck in a pending state. It can be used throughout a request's lifecycle even after the approval state, unlike the [Cancel Access Request endpoint](https://developer.sailpoint.com/idn/api/v3/cancel-access-request/).
@@ -282,7 +287,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.close_access_request import CloseAccessRequest
@@ -290,20 +294,21 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
close_access_request = {
close_access_request = '''{
"executionStatus" : "Terminated",
"accessRequestIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
"completionStatus" : "Failure",
"message" : "The IdentityNow Administrator manually closed this request."
} # CloseAccessRequest |
}''' # CloseAccessRequest |
try:
# Close Access Request
new_close_access_request = CloseAccessRequest()
new_close_access_request.from_json(close_access_request)
results =AccessRequestsApi(api_client).close_access_request(x_sail_point_experimental, new_close_access_request)
new_close_access_request = CloseAccessRequest.from_json(close_access_request)
results = AccessRequestsApi(api_client).close_access_request(x_sail_point_experimental=x_sail_point_experimental, close_access_request=new_close_access_request)
# Below is a request that includes all optional parameters
# results = AccessRequestsApi(api_client).close_access_request(x_sail_point_experimental, new_close_access_request)
print("The response of AccessRequestsApi->close_access_request:\n")
@@ -378,7 +383,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_request import AccessRequest
@@ -387,8 +391,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
access_request = {
access_request = '''{
"requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ],
"clientMetadata" : {
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1",
@@ -441,13 +446,12 @@ with ApiClient(configuration) as api_client:
"id" : "2c9180835d2e5168015d32f890ca1581",
"type" : "ACCESS_PROFILE"
} ]
} # AccessRequest |
}''' # AccessRequest |
try:
# Submit Access Request
new_access_request = AccessRequest()
new_access_request.from_json(access_request)
results =AccessRequestsApi(api_client).create_access_request(new_access_request)
new_access_request = AccessRequest.from_json(access_request)
results = AccessRequestsApi(api_client).create_access_request(access_request=new_access_request)
# Below is a request that includes all optional parameters
# results = AccessRequestsApi(api_client).create_access_request(new_access_request)
print("The response of AccessRequestsApi->create_access_request:\n")
@@ -489,7 +493,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_request_config import AccessRequestConfig
@@ -497,12 +500,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Access Request Configuration
results =AccessRequestsApi(api_client).get_access_request_config()
results = AccessRequestsApi(api_client).get_access_request_config()
# Below is a request that includes all optional parameters
# results = AccessRequestsApi(api_client).get_access_request_config()
print("The response of AccessRequestsApi->get_access_request_config:\n")
@@ -558,7 +562,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.requested_item_status import RequestedItemStatus
@@ -566,6 +569,7 @@ 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)
@@ -581,7 +585,7 @@ with ApiClient(configuration) as api_client:
try:
# Access Request Status
results =AccessRequestsApi(api_client).list_access_request_status()
results = AccessRequestsApi(api_client).list_access_request_status()
# Below is a request that includes all optional parameters
# 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")
@@ -636,7 +640,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_request_admin_item_status import AccessRequestAdminItemStatus
@@ -644,6 +647,7 @@ 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)
@@ -659,7 +663,7 @@ with ApiClient(configuration) as api_client:
try:
# Access Request Status for Administrators
results =AccessRequestsApi(api_client).list_administrators_access_request_status()
results = AccessRequestsApi(api_client).list_administrators_access_request_status()
# Below is a request that includes all optional parameters
# results = AccessRequestsApi(api_client).list_administrators_access_request_status(requested_for, requested_by, regarding_identity, assigned_to, count, limit, offset, filters, sorters, request_state)
print("The response of AccessRequestsApi->list_administrators_access_request_status:\n")
@@ -704,7 +708,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.access_requests_api import AccessRequestsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_request_config import AccessRequestConfig
@@ -712,8 +715,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
access_request_config = {
access_request_config = '''{
"requestOnBehalfOfConfig" : {
"allowRequestOnBehalfOfEmployeeByManager" : true,
"allowRequestOnBehalfOfAnyoneByAnyone" : true
@@ -738,13 +742,12 @@ with ApiClient(configuration) as api_client:
},
"reauthorizationEnabled" : true,
"approvalsMustBeExternal" : true
} # AccessRequestConfig |
}''' # AccessRequestConfig |
try:
# Update Access Request Configuration
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)
new_access_request_config = AccessRequestConfig.from_json(access_request_config)
results = AccessRequestsApi(api_client).set_access_request_config(access_request_config=new_access_request_config)
# Below is a request that includes all optional parameters
# results = AccessRequestsApi(api_client).set_access_request_config(new_access_request_config)
print("The response of AccessRequestsApi->set_access_request_config:\n")

8
docs/tools/sdk/python/Reference/V2024/Methods/AccountActivitiesApi.md
View File

@@ -85,7 +85,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.account_activities_api import AccountActivitiesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.account_activity import AccountActivity
@@ -93,13 +92,14 @@ 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
results =AccountActivitiesApi(api_client).get_account_activity(id)
results = AccountActivitiesApi(api_client).get_account_activity(id=id)
# Below is a request that includes all optional parameters
# results = AccountActivitiesApi(api_client).get_account_activity(id)
print("The response of AccountActivitiesApi->get_account_activity:\n")
@@ -151,7 +151,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.account_activities_api import AccountActivitiesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.account_activity import AccountActivity
@@ -159,6 +158,7 @@ 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)
@@ -172,7 +172,7 @@ with ApiClient(configuration) as api_client:
try:
# List Account Activities
results =AccountActivitiesApi(api_client).list_account_activities()
results = AccountActivitiesApi(api_client).list_account_activities()
# Below is a request that includes all optional parameters
# 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")

13
docs/tools/sdk/python/Reference/V2024/Methods/AccountAggregationsApi.md
View File

@@ -32,6 +32,14 @@ Method | HTTP request | Description
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
In-progress Account Aggregation status
This API returns the status of an *in-progress* account aggregation, along with the total number of **NEW**, **CHANGED** and **DELETED** accounts found since the previous aggregation, and the number of those accounts that have been processed so far.
@@ -71,7 +79,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.account_aggregations_api import AccountAggregationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.account_aggregation_status import AccountAggregationStatus
@@ -79,6 +86,8 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
id = '2c91808477a6b0c60177a81146b8110b' # str | The account aggregation id # str | The account aggregation id
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
@@ -86,7 +95,7 @@ with ApiClient(configuration) as api_client:
try:
# In-progress Account Aggregation status
results =AccountAggregationsApi(api_client).get_account_aggregation_status(id, x_sail_point_experimental)
results = AccountAggregationsApi(api_client).get_account_aggregation_status(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = AccountAggregationsApi(api_client).get_account_aggregation_status(id, x_sail_point_experimental)
print("The response of AccountAggregationsApi->get_account_aggregation_status:\n")

4
docs/tools/sdk/python/Reference/V2024/Methods/AccountUsagesApi.md
View File

@@ -57,7 +57,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.account_usages_api import AccountUsagesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.account_usage import AccountUsage
@@ -65,6 +64,7 @@ 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)
@@ -75,7 +75,7 @@ with ApiClient(configuration) as api_client:
try:
# Returns account usage insights
results =AccountUsagesApi(api_client).get_usages_by_account_id(account_id, )
results = AccountUsagesApi(api_client).get_usages_by_account_id(account_id=account_id)
# Below is a request that includes all optional parameters
# 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")

165
docs/tools/sdk/python/Reference/V2024/Methods/AccountsApi.md
View File

@@ -103,7 +103,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.account_attributes_create import AccountAttributesCreate
@@ -112,8 +111,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
account_attributes_create = {
account_attributes_create = '''{
"attributes" : {
"sourceId" : "34bfcbe116c9407464af37acbaf7a4dc",
"city" : "Austin",
@@ -122,13 +122,12 @@ with ApiClient(configuration) as api_client:
"sAMAccountName" : "jDoe",
"mail" : "john.doe@sailpoint.com"
}
} # AccountAttributesCreate |
}''' # AccountAttributesCreate |
try:
# Create Account
new_account_attributes_create = AccountAttributesCreate()
new_account_attributes_create.from_json(account_attributes_create)
results =AccountsApi(api_client).create_account(new_account_attributes_create)
new_account_attributes_create = AccountAttributesCreate.from_json(account_attributes_create)
results = AccountsApi(api_client).create_account(account_attributes_create=new_account_attributes_create)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).create_account(new_account_attributes_create)
print("The response of AccountsApi->create_account:\n")
@@ -177,7 +176,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.accounts_async_result import AccountsAsyncResult
@@ -185,13 +183,14 @@ 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
results =AccountsApi(api_client).delete_account(id)
results = AccountsApi(api_client).delete_account(id=id)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).delete_account(id)
print("The response of AccountsApi->delete_account:\n")
@@ -208,6 +207,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Remove Account
Use this endpoint to remove accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation.
@@ -246,7 +253,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.task_result_dto import TaskResultDto
@@ -254,6 +260,8 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
id = 'c350d6aa4f104c61b062cb632421ad10' # str | The account id # str | The account id
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
@@ -261,7 +269,7 @@ with ApiClient(configuration) as api_client:
try:
# Remove Account
results =AccountsApi(api_client).delete_account_async(id, x_sail_point_experimental)
results = AccountsApi(api_client).delete_account_async(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).delete_account_async(id, x_sail_point_experimental)
print("The response of AccountsApi->delete_account_async:\n")
@@ -308,7 +316,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.account_toggle_request import AccountToggleRequest
@@ -317,18 +324,18 @@ 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 = {
account_toggle_request = '''{
"forceProvisioning" : false,
"externalVerificationId" : "3f9180835d2e5168015d32f890ca1581"
} # AccountToggleRequest |
}''' # AccountToggleRequest |
try:
# Disable Account
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)
new_account_toggle_request = AccountToggleRequest.from_json(account_toggle_request)
results = AccountsApi(api_client).disable_account(id=id, account_toggle_request=new_account_toggle_request)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).disable_account(id, new_account_toggle_request)
print("The response of AccountsApi->disable_account:\n")
@@ -345,6 +352,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Disable IDN Account for Identity
This API submits a task to disable IDN account for a single identity.
@@ -378,13 +393,14 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id.
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
@@ -392,7 +408,7 @@ with ApiClient(configuration) as api_client:
try:
# Disable IDN Account for Identity
results =AccountsApi(api_client).disable_account_for_identity(id, x_sail_point_experimental)
results = AccountsApi(api_client).disable_account_for_identity(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).disable_account_for_identity(id, x_sail_point_experimental)
print("The response of AccountsApi->disable_account_for_identity:\n")
@@ -409,6 +425,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Disable IDN Accounts for Identities
This API submits tasks to disable IDN account for each identity provided in the request body.
@@ -441,7 +465,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.bulk_identities_accounts_response import BulkIdentitiesAccountsResponse
@@ -450,17 +473,18 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
identities_accounts_bulk_request = {
identities_accounts_bulk_request = '''{
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
} # IdentitiesAccountsBulkRequest |
}''' # IdentitiesAccountsBulkRequest |
try:
# Disable IDN Accounts for Identities
new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest()
new_identities_accounts_bulk_request.from_json(identities_accounts_bulk_request)
results =AccountsApi(api_client).disable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request)
new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest.from_json(identities_accounts_bulk_request)
results = AccountsApi(api_client).disable_accounts_for_identities(x_sail_point_experimental=x_sail_point_experimental, identities_accounts_bulk_request=new_identities_accounts_bulk_request)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).disable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request)
print("The response of AccountsApi->disable_accounts_for_identities:\n")
@@ -507,7 +531,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.account_toggle_request import AccountToggleRequest
@@ -516,18 +539,18 @@ 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 = {
account_toggle_request = '''{
"forceProvisioning" : false,
"externalVerificationId" : "3f9180835d2e5168015d32f890ca1581"
} # AccountToggleRequest |
}''' # AccountToggleRequest |
try:
# Enable Account
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)
new_account_toggle_request = AccountToggleRequest.from_json(account_toggle_request)
results = AccountsApi(api_client).enable_account(id=id, account_toggle_request=new_account_toggle_request)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).enable_account(id, new_account_toggle_request)
print("The response of AccountsApi->enable_account:\n")
@@ -544,6 +567,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Enable IDN Account for Identity
This API submits a task to enable IDN account for a single identity.
@@ -577,13 +608,14 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
id = '2c91808384203c2d018437e631158309' # str | The identity id. # str | The identity id.
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
@@ -591,7 +623,7 @@ with ApiClient(configuration) as api_client:
try:
# Enable IDN Account for Identity
results =AccountsApi(api_client).enable_account_for_identity(id, x_sail_point_experimental)
results = AccountsApi(api_client).enable_account_for_identity(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).enable_account_for_identity(id, x_sail_point_experimental)
print("The response of AccountsApi->enable_account_for_identity:\n")
@@ -608,6 +640,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Enable IDN Accounts for Identities
This API submits tasks to enable IDN account for each identity provided in the request body.
@@ -640,7 +680,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.bulk_identities_accounts_response import BulkIdentitiesAccountsResponse
@@ -649,17 +688,18 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
identities_accounts_bulk_request = {
identities_accounts_bulk_request = '''{
"identityIds" : [ "2c91808384203c2d018437e631158308", "2c9180858082150f0180893dbaf553fe" ]
} # IdentitiesAccountsBulkRequest |
}''' # IdentitiesAccountsBulkRequest |
try:
# Enable IDN Accounts for Identities
new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest()
new_identities_accounts_bulk_request.from_json(identities_accounts_bulk_request)
results =AccountsApi(api_client).enable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request)
new_identities_accounts_bulk_request = IdentitiesAccountsBulkRequest.from_json(identities_accounts_bulk_request)
results = AccountsApi(api_client).enable_accounts_for_identities(x_sail_point_experimental=x_sail_point_experimental, identities_accounts_bulk_request=new_identities_accounts_bulk_request)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).enable_accounts_for_identities(x_sail_point_experimental, new_identities_accounts_bulk_request)
print("The response of AccountsApi->enable_accounts_for_identities:\n")
@@ -705,7 +745,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.account import Account
@@ -713,13 +752,14 @@ 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
results =AccountsApi(api_client).get_account(id)
results = AccountsApi(api_client).get_account(id=id)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).get_account(id)
print("The response of AccountsApi->get_account:\n")
@@ -768,7 +808,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.entitlement import Entitlement
@@ -776,6 +815,7 @@ 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)
@@ -785,7 +825,7 @@ with ApiClient(configuration) as api_client:
try:
# Account Entitlements
results =AccountsApi(api_client).get_account_entitlements(id, )
results = AccountsApi(api_client).get_account_entitlements(id=id)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).get_account_entitlements(id, limit, offset, count)
print("The response of AccountsApi->get_account_entitlements:\n")
@@ -835,7 +875,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.account import Account
@@ -843,6 +882,7 @@ 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)
@@ -854,7 +894,7 @@ with ApiClient(configuration) as api_client:
try:
# Accounts List
results =AccountsApi(api_client).list_accounts()
results = AccountsApi(api_client).list_accounts()
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).list_accounts(limit, offset, count, detail_level, filters, sorters)
print("The response of AccountsApi->list_accounts:\n")
@@ -906,7 +946,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.account_attributes import AccountAttributes
@@ -915,9 +954,10 @@ 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 = {
account_attributes = '''{
"attributes" : {
"city" : "Austin",
"displayName" : "John Doe",
@@ -925,13 +965,12 @@ with ApiClient(configuration) as api_client:
"sAMAccountName" : "jDoe",
"mail" : "john.doe@sailpoint.com"
}
} # AccountAttributes |
}''' # AccountAttributes |
try:
# Update Account
new_account_attributes = AccountAttributes()
new_account_attributes.from_json(account_attributes)
results =AccountsApi(api_client).put_account(id, new_account_attributes)
new_account_attributes = AccountAttributes.from_json(account_attributes)
results = AccountsApi(api_client).put_account(id=id, account_attributes=new_account_attributes)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).put_account(id, new_account_attributes)
print("The response of AccountsApi->put_account:\n")
@@ -977,7 +1016,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.accounts_async_result import AccountsAsyncResult
@@ -985,13 +1023,14 @@ 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
results =AccountsApi(api_client).submit_reload_account(id)
results = AccountsApi(api_client).submit_reload_account(id=id)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).submit_reload_account(id)
print("The response of AccountsApi->submit_reload_account:\n")
@@ -1039,7 +1078,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.account_unlock_request import AccountUnlockRequest
@@ -1048,19 +1086,19 @@ 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 = {
account_unlock_request = '''{
"forceProvisioning" : false,
"externalVerificationId" : "3f9180835d2e5168015d32f890ca1581",
"unlockIDNAccount" : false
} # AccountUnlockRequest |
}''' # AccountUnlockRequest |
try:
# Unlock Account
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)
new_account_unlock_request = AccountUnlockRequest.from_json(account_unlock_request)
results = AccountsApi(api_client).unlock_account(id=id, account_unlock_request=new_account_unlock_request)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).unlock_account(id, new_account_unlock_request)
print("The response of AccountsApi->unlock_account:\n")
@@ -1117,24 +1155,21 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.accounts_api import AccountsApi
from sailpoint.v2024.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.
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.
try:
# Update Account
new_request_body = RequestBody()
new_request_body.from_json(request_body)
results =AccountsApi(api_client).update_account(id, new_request_body)
new_request_body = RequestBody.from_json(request_body)
results = AccountsApi(api_client).update_account(id=id, request_body=new_request_body)
# Below is a request that includes all optional parameters
# results = AccountsApi(api_client).update_account(id, new_request_body)
print("The response of AccountsApi->update_account:\n")

12
docs/tools/sdk/python/Reference/V2024/Methods/ApplicationDiscoveryApi.md
View File

@@ -59,7 +59,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.application_discovery_api import ApplicationDiscoveryApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.get_discovered_applications200_response_inner import GetDiscoveredApplications200ResponseInner
@@ -67,6 +66,7 @@ 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)
@@ -77,7 +77,7 @@ with ApiClient(configuration) as api_client:
try:
# Get Discovered Applications for Tenant
results =ApplicationDiscoveryApi(api_client).get_discovered_applications()
results = ApplicationDiscoveryApi(api_client).get_discovered_applications()
# Below is a request that includes all optional parameters
# results = ApplicationDiscoveryApi(api_client).get_discovered_applications(limit, offset, detail, filter, sorters)
print("The response of ApplicationDiscoveryApi->get_discovered_applications:\n")
@@ -122,7 +122,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.application_discovery_api import ApplicationDiscoveryApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.manual_discover_applications_template import ManualDiscoverApplicationsTemplate
@@ -130,12 +129,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Download CSV Template for Discovery
results =ApplicationDiscoveryApi(api_client).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
# results = ApplicationDiscoveryApi(api_client).get_manual_discover_applications_csv_template()
print("The response of ApplicationDiscoveryApi->get_manual_discover_applications_csv_template:\n")
@@ -181,20 +181,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.application_discovery_api import ApplicationDiscoveryApi
from sailpoint.v2024.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
ApplicationDiscoveryApi(api_client).send_manual_discover_applications_csv_template(file)
ApplicationDiscoveryApi(api_client).send_manual_discover_applications_csv_template(file=file)
# Below is a request that includes all optional parameters
# ApplicationDiscoveryApi(api_client).send_manual_discover_applications_csv_template(file)
except Exception as e:

26
docs/tools/sdk/python/Reference/V2024/Methods/ApprovalsApi.md
View File

@@ -26,6 +26,14 @@ Method | HTTP request | Description
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Get an approval
Retrieve a single approval for a given approval ID. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals.
@@ -58,7 +66,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.approvals_api import ApprovalsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.approval import Approval
@@ -66,6 +73,8 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
id = '38453251-6be2-5f8f-df93-5ce19e295837' # str | ID of the approval that is to be returned # str | ID of the approval that is to be returned
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
@@ -73,7 +82,7 @@ with ApiClient(configuration) as api_client:
try:
# Get an approval
results =ApprovalsApi(api_client).get_approval(id, x_sail_point_experimental)
results = ApprovalsApi(api_client).get_approval(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = ApprovalsApi(api_client).get_approval(id, x_sail_point_experimental)
print("The response of ApprovalsApi->get_approval:\n")
@@ -90,6 +99,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Get Approvals
Retrieve a list of approvals, which can be filtered by requester ID, status, or reference type. "Mine" query parameter can be used and it will return all approvals for the current approver. This endpoint is for generic approvals, different than the access-request-approval endpoint and does not include access-request-approvals.
Absence of all query parameters will will default to mine=true.
@@ -125,7 +142,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.approvals_api import ApprovalsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.approval import Approval
@@ -133,6 +149,8 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
mine = true # bool | Returns the list of approvals for the current caller (optional) # bool | Returns the list of approvals for the current caller (optional)
@@ -142,7 +160,7 @@ with ApiClient(configuration) as api_client:
try:
# Get Approvals
results =ApprovalsApi(api_client).get_approvals(x_sail_point_experimental, )
results = ApprovalsApi(api_client).get_approvals(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = ApprovalsApi(api_client).get_approvals(x_sail_point_experimental, mine, requester_id, filters)
print("The response of ApprovalsApi->get_approvals:\n")

216
docs/tools/sdk/python/Reference/V2024/Methods/AppsApi.md
View File

@@ -37,6 +37,14 @@ Method | HTTP request | Description
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Create source app
This endpoint creates a source app using the given source app payload
@@ -69,7 +77,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.source_app import SourceApp
@@ -78,9 +85,11 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
source_app_create_dto = {
source_app_create_dto = '''{
"name" : "my app",
"description" : "the source app for engineers",
"accountSource" : {
@@ -89,13 +98,12 @@ with ApiClient(configuration) as api_client:
"type" : "SOURCE"
},
"matchAllAccounts" : true
} # SourceAppCreateDto |
}''' # SourceAppCreateDto |
try:
# Create source app
new_source_app_create_dto = SourceAppCreateDto()
new_source_app_create_dto.from_json(source_app_create_dto)
results =AppsApi(api_client).create_source_app(x_sail_point_experimental, new_source_app_create_dto)
new_source_app_create_dto = SourceAppCreateDto.from_json(source_app_create_dto)
results = AppsApi(api_client).create_source_app(x_sail_point_experimental=x_sail_point_experimental, source_app_create_dto=new_source_app_create_dto)
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).create_source_app(x_sail_point_experimental, new_source_app_create_dto)
print("The response of AppsApi->create_source_app:\n")
@@ -112,6 +120,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Bulk remove access profiles from the specified source app
This API returns the final list of access profiles for the specified source app after removing
@@ -146,7 +162,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_profile_details import AccessProfileDetails
@@ -154,19 +169,18 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
request_body = [c9575abb5e3a4e3db82b2f989a738aa2, c9dc28e148a24d65b3ccb5fb8ca5ddd9] # List[str] |
request_body = [c9575abb5e3a4e3db82b2f989a738aa2, c9dc28e148a24d65b3ccb5fb8ca5ddd9] # List[str] |
request_body = '''[c9575abb5e3a4e3db82b2f989a738aa2, c9dc28e148a24d65b3ccb5fb8ca5ddd9]''' # List[str] |
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)
try:
# Bulk remove access profiles from the specified source app
new_request_body = RequestBody()
new_request_body.from_json(request_body)
results =AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id, x_sail_point_experimental, new_request_body, )
new_request_body = RequestBody.from_json(request_body)
results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id=id, x_sail_point_experimental=x_sail_point_experimental, request_body=new_request_body)
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).delete_access_profiles_from_source_app_by_bulk(id, x_sail_point_experimental, new_request_body, limit)
print("The response of AppsApi->delete_access_profiles_from_source_app_by_bulk:\n")
@@ -183,6 +197,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Delete source app by ID
Use this API to delete a specific source app
@@ -215,7 +237,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.source_app import SourceApp
@@ -223,6 +244,8 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
id = '2c9180835d191a86015d28455b4a2329' # str | source app ID. # str | source app ID.
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
@@ -230,7 +253,7 @@ with ApiClient(configuration) as api_client:
try:
# Delete source app by ID
results =AppsApi(api_client).delete_source_app(id, x_sail_point_experimental)
results = AppsApi(api_client).delete_source_app(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).delete_source_app(id, x_sail_point_experimental)
print("The response of AppsApi->delete_source_app:\n")
@@ -247,6 +270,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Get source app by ID
This API returns a source app by its ID.
@@ -280,7 +311,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.source_app import SourceApp
@@ -288,6 +318,8 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
@@ -295,7 +327,7 @@ with ApiClient(configuration) as api_client:
try:
# Get source app by ID
results =AppsApi(api_client).get_source_app(id, x_sail_point_experimental)
results = AppsApi(api_client).get_source_app(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).get_source_app(id, x_sail_point_experimental)
print("The response of AppsApi->get_source_app:\n")
@@ -312,6 +344,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
List access profiles for the specified source app
This API returns the list of access profiles for the specified source app
@@ -347,7 +387,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_profile_details import AccessProfileDetails
@@ -355,6 +394,8 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the source app # str | ID of the source app
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
@@ -365,7 +406,7 @@ with ApiClient(configuration) as api_client:
try:
# List access profiles for the specified source app
results =AppsApi(api_client).list_access_profiles_for_source_app(id, x_sail_point_experimental, )
results = AppsApi(api_client).list_access_profiles_for_source_app(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).list_access_profiles_for_source_app(id, x_sail_point_experimental, limit, offset, filters)
print("The response of AppsApi->list_access_profiles_for_source_app:\n")
@@ -382,6 +423,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
List all source apps
This API returns the list of all source apps for the org.
@@ -418,7 +467,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.source_app import SourceApp
@@ -426,6 +474,8 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
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)
@@ -437,7 +487,7 @@ with ApiClient(configuration) as api_client:
try:
# List all source apps
results =AppsApi(api_client).list_all_source_app(x_sail_point_experimental, )
results = AppsApi(api_client).list_all_source_app(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).list_all_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters)
print("The response of AppsApi->list_all_source_app:\n")
@@ -454,6 +504,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
List all user apps
This API returns the list of all user apps with specified filters.
This API must be used with **filters** query parameter.
@@ -490,7 +548,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.user_app import UserApp
@@ -498,6 +555,8 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
filters = 'name eq \"user app name\"' # 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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq* # 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* **ownerId**: *eq* **ownerName**: *eq, sw* **ownerAlias**: *eq, sw* **accountId**: *eq* **sourceAppId**: *eq*
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
@@ -508,7 +567,7 @@ with ApiClient(configuration) as api_client:
try:
# List all user apps
results =AppsApi(api_client).list_all_user_apps(filters, x_sail_point_experimental, )
results = AppsApi(api_client).list_all_user_apps(filters=filters, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).list_all_user_apps(filters, x_sail_point_experimental, limit, count, offset)
print("The response of AppsApi->list_all_user_apps:\n")
@@ -525,6 +584,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
List assigned source apps
This API returns the list of source apps assigned for logged in user.
@@ -561,7 +628,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.source_app import SourceApp
@@ -569,6 +635,8 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
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)
@@ -580,7 +648,7 @@ with ApiClient(configuration) as api_client:
try:
# List assigned source apps
results =AppsApi(api_client).list_assigned_source_app(x_sail_point_experimental, )
results = AppsApi(api_client).list_assigned_source_app(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).list_assigned_source_app(x_sail_point_experimental, limit, count, offset, sorters, filters)
print("The response of AppsApi->list_assigned_source_app:\n")
@@ -597,6 +665,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
List available accounts for user app
This API returns the list of available accounts for the specified user app. The user app needs to belong lo logged in user.
@@ -631,7 +707,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.app_account_details import AppAccountDetails
@@ -639,6 +714,8 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the user app # str | ID of the user app
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
@@ -648,7 +725,7 @@ with ApiClient(configuration) as api_client:
try:
# List available accounts for user app
results =AppsApi(api_client).list_available_accounts_for_user_app(id, x_sail_point_experimental, )
results = AppsApi(api_client).list_available_accounts_for_user_app(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).list_available_accounts_for_user_app(id, x_sail_point_experimental, limit, count)
print("The response of AppsApi->list_available_accounts_for_user_app:\n")
@@ -665,6 +742,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
List available source apps
This API returns the list of source apps available for access request.
@@ -701,7 +786,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.source_app import SourceApp
@@ -709,6 +793,8 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
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)
@@ -720,7 +806,7 @@ with ApiClient(configuration) as api_client:
try:
# List available source apps
results =AppsApi(api_client).list_available_source_apps(x_sail_point_experimental, )
results = AppsApi(api_client).list_available_source_apps(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).list_available_source_apps(x_sail_point_experimental, limit, count, offset, sorters, filters)
print("The response of AppsApi->list_available_source_apps:\n")
@@ -737,6 +823,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
List owned user apps
This API returns the list of user apps assigned to logged in user
@@ -772,7 +866,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.user_app import UserApp
@@ -780,6 +873,8 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
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)
@@ -790,7 +885,7 @@ with ApiClient(configuration) as api_client:
try:
# List owned user apps
results =AppsApi(api_client).list_owned_user_apps(x_sail_point_experimental, )
results = AppsApi(api_client).list_owned_user_apps(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).list_owned_user_apps(x_sail_point_experimental, limit, count, offset, filters)
print("The response of AppsApi->list_owned_user_apps:\n")
@@ -807,6 +902,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Patch source app by ID
This API updates an existing source app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
The following fields are patchable: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts** and **accessProfiles**.
@@ -843,7 +946,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
@@ -852,21 +954,17 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the source app to patch # str | ID of the source app to patch
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
[{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}] # List[JsonPatchOperation] | (optional)
json_patch_operation = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] | (optional)
json_patch_operation = '''[{op=replace, path=/enabled, value=true}, {op=replace, path=/matchAllAccounts, value=true}]''' # List[JsonPatchOperation] | (optional)
try:
# Patch source app by ID
results =AppsApi(api_client).patch_source_app(id, x_sail_point_experimental, )
results = AppsApi(api_client).patch_source_app(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).patch_source_app(id, x_sail_point_experimental, new_json_patch_operation)
print("The response of AppsApi->patch_source_app:\n")
@@ -883,6 +981,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Patch user app by ID
This API updates an existing user app using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
The following fields are patchable: **account**
@@ -918,7 +1024,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
@@ -927,21 +1032,17 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the user app to patch # str | ID of the user app to patch
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
[sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | (optional)
json_patch_operation = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] | (optional)
json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | (optional)
try:
# Patch user app by ID
results =AppsApi(api_client).patch_user_app(id, x_sail_point_experimental, )
results = AppsApi(api_client).patch_user_app(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = AppsApi(api_client).patch_user_app(id, x_sail_point_experimental, new_json_patch_operation)
print("The response of AppsApi->patch_user_app:\n")
@@ -958,6 +1059,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Bulk update source apps
This API updates source apps using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. It can update up to 50 source apps in a batch.
The following fields can be updated: **name**, **description**, **enabled**, **owner**, **provisionRequestEnabled**, **appCenterEnabled**, **accountSource**, **matchAllAccounts**, and **accessProfiles**.
@@ -993,7 +1102,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.apps_api import AppsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.source_app_bulk_update_request import SourceAppBulkUpdateRequest
@@ -1001,9 +1109,11 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
source_app_bulk_update_request = {
source_app_bulk_update_request = '''{
"appIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ],
"jsonPatch" : [ {
"op" : "replace",
@@ -1014,12 +1124,12 @@ with ApiClient(configuration) as api_client:
"path" : "/matchAllAccounts",
"value" : false
} ]
} # SourceAppBulkUpdateRequest | (optional)
}''' # SourceAppBulkUpdateRequest | (optional)
try:
# Bulk update source apps
AppsApi(api_client).update_source_apps_in_bulk(x_sail_point_experimental, )
AppsApi(api_client).update_source_apps_in_bulk(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# AppsApi(api_client).update_source_apps_in_bulk(x_sail_point_experimental, new_source_app_bulk_update_request)
except Exception as e:

50
docs/tools/sdk/python/Reference/V2024/Methods/AuthProfileApi.md
View File

@@ -30,6 +30,14 @@ Method | HTTP request | Description
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Get Auth Profile
This API returns auth profile information.
@@ -63,7 +71,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.auth_profile_api import AuthProfileApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.auth_profile import AuthProfile
@@ -71,6 +78,8 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch.
@@ -78,7 +87,7 @@ with ApiClient(configuration) as api_client:
try:
# Get Auth Profile
results =AuthProfileApi(api_client).get_profile_config(x_sail_point_experimental, id)
results = AuthProfileApi(api_client).get_profile_config(x_sail_point_experimental=x_sail_point_experimental, id=id)
# Below is a request that includes all optional parameters
# results = AuthProfileApi(api_client).get_profile_config(x_sail_point_experimental, id)
print("The response of AuthProfileApi->get_profile_config:\n")
@@ -95,6 +104,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Get list of Auth Profiles
This API returns a list of auth profiles.
@@ -126,7 +143,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.auth_profile_api import AuthProfileApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.auth_profile_summary import AuthProfileSummary
@@ -134,13 +150,15 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
try:
# Get list of Auth Profiles
results =AuthProfileApi(api_client).get_profile_config_list(x_sail_point_experimental)
results = AuthProfileApi(api_client).get_profile_config_list(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = AuthProfileApi(api_client).get_profile_config_list(x_sail_point_experimental)
print("The response of AuthProfileApi->get_profile_config_list:\n")
@@ -157,6 +175,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Patch a specified Auth Profile
This API updates an existing Auth Profile. The following fields are patchable:
**offNetwork**, **untrustedGeography**, **applicationId**, **applicationName**, **type**
@@ -191,7 +217,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.auth_profile_api import AuthProfileApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.auth_profile import AuthProfile
@@ -200,22 +225,17 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch.
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
[sailpoint.v2024.JsonPatchOperation()] # List[JsonPatchOperation] |
json_patch_operation = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] |
json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] |
try:
# Patch a specified Auth Profile
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =AuthProfileApi(api_client).patch_profile_config(id, x_sail_point_experimental, new_json_patch_operation)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = AuthProfileApi(api_client).patch_profile_config(id=id, x_sail_point_experimental=x_sail_point_experimental, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = AuthProfileApi(api_client).patch_profile_config(id, x_sail_point_experimental, new_json_patch_operation)
print("The response of AuthProfileApi->patch_profile_config:\n")

19
docs/tools/sdk/python/Reference/V2024/Methods/AuthUsersApi.md
View File

@@ -57,7 +57,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.auth_users_api import AuthUsersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.auth_user import AuthUser
@@ -65,13 +64,14 @@ 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
results =AuthUsersApi(api_client).get_auth_user(id)
results = AuthUsersApi(api_client).get_auth_user(id=id)
# Below is a request that includes all optional parameters
# results = AuthUsersApi(api_client).get_auth_user(id)
print("The response of AuthUsersApi->get_auth_user:\n")
@@ -122,7 +122,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.auth_users_api import AuthUsersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.auth_user import AuthUser
@@ -131,21 +130,15 @@ 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 = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
json_patch_operation = '''[{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.
try:
# Auth User Update
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)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = AuthUsersApi(api_client).patch_auth_user(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = AuthUsersApi(api_client).patch_auth_user(id, new_json_patch_operation)
print("The response of AuthUsersApi->patch_auth_user:\n")

20
docs/tools/sdk/python/Reference/V2024/Methods/BrandingApi.md
View File

@@ -66,7 +66,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.branding_api import BrandingApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.branding_item import BrandingItem
@@ -74,6 +73,7 @@ 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
@@ -87,7 +87,7 @@ with ApiClient(configuration) as api_client:
try:
# Create a branding item
results =BrandingApi(api_client).create_branding_item(name, product_name, )
results = BrandingApi(api_client).create_branding_item(name=name, product_name=product_name)
# Below is a request that includes all optional parameters
# 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")
@@ -133,20 +133,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.branding_api import BrandingApi
from sailpoint.v2024.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
BrandingApi(api_client).delete_branding(name)
BrandingApi(api_client).delete_branding(name=name)
# Below is a request that includes all optional parameters
# BrandingApi(api_client).delete_branding(name)
except Exception as e:
@@ -190,7 +190,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.branding_api import BrandingApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.branding_item import BrandingItem
@@ -198,13 +197,14 @@ 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
results =BrandingApi(api_client).get_branding(name)
results = BrandingApi(api_client).get_branding(name=name)
# Below is a request that includes all optional parameters
# results = BrandingApi(api_client).get_branding(name)
print("The response of BrandingApi->get_branding:\n")
@@ -246,7 +246,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.branding_api import BrandingApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.branding_item import BrandingItem
@@ -254,12 +253,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List of branding items
results =BrandingApi(api_client).get_branding_list()
results = BrandingApi(api_client).get_branding_list()
# Below is a request that includes all optional parameters
# results = BrandingApi(api_client).get_branding_list()
print("The response of BrandingApi->get_branding_list:\n")
@@ -313,7 +313,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.branding_api import BrandingApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.branding_item import BrandingItem
@@ -321,6 +320,7 @@ 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
@@ -335,7 +335,7 @@ with ApiClient(configuration) as api_client:
try:
# Update a branding item
results =BrandingApi(api_client).set_branding_item(name, name2, product_name, )
results = BrandingApi(api_client).set_branding_item(name=name, name2=name2, product_name=product_name)
# Below is a request that includes all optional parameters
# 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")

41
docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignFiltersApi.md
View File

@@ -81,7 +81,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaign_filters_api import CertificationCampaignFiltersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign_filter_details import CampaignFilterDetails
@@ -89,8 +88,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
campaign_filter_details = {
campaign_filter_details = '''{
"owner" : "SailPoint Support",
"mode" : "INCLUSION",
"isSystemFilter" : false,
@@ -107,13 +107,12 @@ with ApiClient(configuration) as api_client:
"recordChildMatches" : false,
"suppressMatchedItems" : false
} ]
} # CampaignFilterDetails |
}''' # CampaignFilterDetails |
try:
# Create Campaign Filter
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)
new_campaign_filter_details = CampaignFilterDetails.from_json(campaign_filter_details)
results = CertificationCampaignFiltersApi(api_client).create_campaign_filter(campaign_filter_details=new_campaign_filter_details)
# Below is a request that includes all optional parameters
# results = CertificationCampaignFiltersApi(api_client).create_campaign_filter(new_campaign_filter_details)
print("The response of CertificationCampaignFiltersApi->create_campaign_filter:\n")
@@ -159,23 +158,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaign_filters_api import CertificationCampaignFiltersApi
from sailpoint.v2024.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.
with ApiClient(configuration) as api_client:
request_body = '''['request_body_example']''' # List[str] | A json list of IDs of campaign filters to delete.
try:
# Deletes Campaign Filters
new_request_body = RequestBody()
new_request_body.from_json(request_body)
CertificationCampaignFiltersApi(api_client).delete_campaign_filters(new_request_body)
new_request_body = RequestBody.from_json(request_body)
CertificationCampaignFiltersApi(api_client).delete_campaign_filters(request_body=new_request_body)
# Below is a request that includes all optional parameters
# CertificationCampaignFiltersApi(api_client).delete_campaign_filters(new_request_body)
except Exception as e:
@@ -219,7 +215,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaign_filters_api import CertificationCampaignFiltersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign_filter_details import CampaignFilterDetails
@@ -227,13 +222,14 @@ 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
results =CertificationCampaignFiltersApi(api_client).get_campaign_filter_by_id(id)
results = CertificationCampaignFiltersApi(api_client).get_campaign_filter_by_id(id=id)
# Below is a request that includes all optional parameters
# results = CertificationCampaignFiltersApi(api_client).get_campaign_filter_by_id(id)
print("The response of CertificationCampaignFiltersApi->get_campaign_filter_by_id:\n")
@@ -280,7 +276,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaign_filters_api import CertificationCampaignFiltersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.list_campaign_filters200_response import ListCampaignFilters200Response
@@ -288,6 +283,7 @@ 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)
@@ -296,7 +292,7 @@ with ApiClient(configuration) as api_client:
try:
# List Campaign Filters
results =CertificationCampaignFiltersApi(api_client).list_campaign_filters()
results = CertificationCampaignFiltersApi(api_client).list_campaign_filters()
# Below is a request that includes all optional parameters
# results = CertificationCampaignFiltersApi(api_client).list_campaign_filters(limit, start, include_system_filters)
print("The response of CertificationCampaignFiltersApi->list_campaign_filters:\n")
@@ -342,7 +338,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaign_filters_api import CertificationCampaignFiltersApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign_filter_details import CampaignFilterDetails
@@ -350,9 +345,10 @@ 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 = {
campaign_filter_details = '''{
"owner" : "SailPoint Support",
"mode" : "INCLUSION",
"isSystemFilter" : false,
@@ -369,13 +365,12 @@ with ApiClient(configuration) as api_client:
"recordChildMatches" : false,
"suppressMatchedItems" : false
} ]
} # CampaignFilterDetails | A campaign filter details with updated field values.
}''' # CampaignFilterDetails | A campaign filter details with updated field values.
try:
# Updates a Campaign Filter
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)
new_campaign_filter_details = CampaignFilterDetails.from_json(campaign_filter_details)
results = CertificationCampaignFiltersApi(api_client).update_campaign_filter(filter_id=filter_id, campaign_filter_details=new_campaign_filter_details)
# Below is a request that includes all optional parameters
# results = CertificationCampaignFiltersApi(api_client).update_campaign_filter(filter_id, new_campaign_filter_details)
print("The response of CertificationCampaignFiltersApi->update_campaign_filter:\n")

157
docs/tools/sdk/python/Reference/V2024/Methods/CertificationCampaignsApi.md
View File

@@ -148,7 +148,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign_complete_options import CampaignCompleteOptions
@@ -156,16 +155,17 @@ 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 = {
campaign_complete_options = '''{
"autoCompleteAction" : "REVOKE"
} # CampaignCompleteOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional)
}''' # CampaignCompleteOptions | Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE (optional)
try:
# Complete a Campaign
results =CertificationCampaignsApi(api_client).complete_campaign(id, )
results = CertificationCampaignsApi(api_client).complete_campaign(id=id)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).complete_campaign(id, new_campaign_complete_options)
print("The response of CertificationCampaignsApi->complete_campaign:\n")
@@ -211,7 +211,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign import Campaign
@@ -219,8 +218,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
campaign = {
campaign = '''{
"totalCertifications" : 100,
"sourcesWithOrphanEntitlements" : [ {
"name" : "Source with orphan entitlements",
@@ -329,13 +329,12 @@ with ApiClient(configuration) as api_client:
"deadline" : "2020-03-15T10:00:01.456Z",
"status" : "ACTIVE",
"correlatedStatus" : "CORRELATED"
} # Campaign |
}''' # Campaign |
try:
# Create a campaign
new_campaign = Campaign()
new_campaign.from_json(campaign)
results =CertificationCampaignsApi(api_client).create_campaign(new_campaign)
new_campaign = Campaign.from_json(campaign)
results = CertificationCampaignsApi(api_client).create_campaign(campaign=new_campaign)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).create_campaign(new_campaign)
print("The response of CertificationCampaignsApi->create_campaign:\n")
@@ -381,7 +380,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign_template import CampaignTemplate
@@ -389,8 +387,9 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
campaign_template = {
campaign_template = '''{
"ownerRef" : {
"name" : "Mister Manager",
"id" : "2c918086676d3e0601677611dbde220f",
@@ -514,13 +513,12 @@ with ApiClient(configuration) as api_client:
"correlatedStatus" : "CORRELATED"
},
"id" : "2c9079b270a266a60170a277bb960008"
} # CampaignTemplate |
}''' # CampaignTemplate |
try:
# Create a Campaign Template
new_campaign_template = CampaignTemplate()
new_campaign_template.from_json(campaign_template)
results =CertificationCampaignsApi(api_client).create_campaign_template(new_campaign_template)
new_campaign_template = CampaignTemplate.from_json(campaign_template)
results = CertificationCampaignsApi(api_client).create_campaign_template(campaign_template=new_campaign_template)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).create_campaign_template(new_campaign_template)
print("The response of CertificationCampaignsApi->create_campaign_template:\n")
@@ -567,20 +565,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.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
CertificationCampaignsApi(api_client).delete_campaign_template(id)
CertificationCampaignsApi(api_client).delete_campaign_template(id=id)
# Below is a request that includes all optional parameters
# CertificationCampaignsApi(api_client).delete_campaign_template(id)
except Exception as e:
@@ -625,20 +623,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.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
CertificationCampaignsApi(api_client).delete_campaign_template_schedule(id)
CertificationCampaignsApi(api_client).delete_campaign_template_schedule(id=id)
# Below is a request that includes all optional parameters
# CertificationCampaignsApi(api_client).delete_campaign_template_schedule(id)
except Exception as e:
@@ -683,7 +681,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaigns_delete_request import CampaignsDeleteRequest
@@ -691,16 +688,16 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
campaigns_delete_request = {
campaigns_delete_request = '''{
"ids" : [ "2c9180887335cee10173490db1776c26", "2c9180836a712436016a7125a90c0021" ]
} # CampaignsDeleteRequest | IDs of the campaigns to delete.
}''' # CampaignsDeleteRequest | IDs of the campaigns to delete.
try:
# Delete Campaigns
new_campaigns_delete_request = CampaignsDeleteRequest()
new_campaigns_delete_request.from_json(campaigns_delete_request)
results =CertificationCampaignsApi(api_client).delete_campaigns(new_campaigns_delete_request)
new_campaigns_delete_request = CampaignsDeleteRequest.from_json(campaigns_delete_request)
results = CertificationCampaignsApi(api_client).delete_campaigns(campaigns_delete_request=new_campaigns_delete_request)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).delete_campaigns(new_campaigns_delete_request)
print("The response of CertificationCampaignsApi->delete_campaigns:\n")
@@ -751,7 +748,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner
@@ -759,6 +755,7 @@ 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)
@@ -770,7 +767,7 @@ with ApiClient(configuration) as api_client:
try:
# List Campaigns
results =CertificationCampaignsApi(api_client).get_active_campaigns()
results = CertificationCampaignsApi(api_client).get_active_campaigns()
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).get_active_campaigns(detail, limit, offset, count, filters, sorters)
print("The response of CertificationCampaignsApi->get_active_campaigns:\n")
@@ -818,7 +815,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.get_active_campaigns200_response_inner import GetActiveCampaigns200ResponseInner
@@ -826,6 +822,7 @@ 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)
@@ -833,7 +830,7 @@ with ApiClient(configuration) as api_client:
try:
# Get Campaign
results =CertificationCampaignsApi(api_client).get_campaign(id, )
results = CertificationCampaignsApi(api_client).get_campaign(id=id)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).get_campaign(id, detail)
print("The response of CertificationCampaignsApi->get_campaign:\n")
@@ -880,7 +877,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign_report import CampaignReport
@@ -888,13 +884,14 @@ 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
results =CertificationCampaignsApi(api_client).get_campaign_reports(id)
results = CertificationCampaignsApi(api_client).get_campaign_reports(id=id)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).get_campaign_reports(id)
print("The response of CertificationCampaignsApi->get_campaign_reports:\n")
@@ -937,7 +934,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign_reports_config import CampaignReportsConfig
@@ -945,12 +941,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# Get Campaign Reports Configuration
results =CertificationCampaignsApi(api_client).get_campaign_reports_config()
results = CertificationCampaignsApi(api_client).get_campaign_reports_config()
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).get_campaign_reports_config()
print("The response of CertificationCampaignsApi->get_campaign_reports_config:\n")
@@ -997,7 +994,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign_template import CampaignTemplate
@@ -1005,13 +1001,14 @@ 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
results =CertificationCampaignsApi(api_client).get_campaign_template(id)
results = CertificationCampaignsApi(api_client).get_campaign_template(id=id)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).get_campaign_template(id)
print("The response of CertificationCampaignsApi->get_campaign_template:\n")
@@ -1058,7 +1055,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.schedule import Schedule
@@ -1066,13 +1062,14 @@ 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
results =CertificationCampaignsApi(api_client).get_campaign_template_schedule(id)
results = CertificationCampaignsApi(api_client).get_campaign_template_schedule(id=id)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).get_campaign_template_schedule(id)
print("The response of CertificationCampaignsApi->get_campaign_template_schedule:\n")
@@ -1124,7 +1121,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign_template import CampaignTemplate
@@ -1132,6 +1128,7 @@ 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)
@@ -1142,7 +1139,7 @@ with ApiClient(configuration) as api_client:
try:
# List Campaign Templates
results =CertificationCampaignsApi(api_client).get_campaign_templates()
results = CertificationCampaignsApi(api_client).get_campaign_templates()
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).get_campaign_templates(limit, offset, count, sorters, filters)
print("The response of CertificationCampaignsApi->get_campaign_templates:\n")
@@ -1190,7 +1187,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.admin_review_reassign import AdminReviewReassign
@@ -1199,22 +1195,22 @@ 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 = {
admin_review_reassign = '''{
"certificationIds" : [ "af3859464779471211bb8424a563abc1", "af3859464779471211bb8424a563abc2", "af3859464779471211bb8424a563abc3" ],
"reason" : "reassigned for some reason",
"reassignTo" : {
"id" : "ef38f94347e94562b5bb8424a56397d8",
"type" : "IDENTITY"
}
} # AdminReviewReassign |
}''' # AdminReviewReassign |
try:
# Reassign Certifications
new_admin_review_reassign = AdminReviewReassign()
new_admin_review_reassign.from_json(admin_review_reassign)
results =CertificationCampaignsApi(api_client).move(id, new_admin_review_reassign)
new_admin_review_reassign = AdminReviewReassign.from_json(admin_review_reassign)
results = CertificationCampaignsApi(api_client).move(id=id, admin_review_reassign=new_admin_review_reassign)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).move(id, new_admin_review_reassign)
print("The response of CertificationCampaignsApi->move:\n")
@@ -1262,7 +1258,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign_template import CampaignTemplate
@@ -1271,21 +1266,15 @@ 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 = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # 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 = '''[{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)
try:
# Update a Campaign Template
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)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = CertificationCampaignsApi(api_client).patch_campaign_template(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).patch_campaign_template(id, new_json_patch_operation)
print("The response of CertificationCampaignsApi->patch_campaign_template:\n")
@@ -1331,7 +1320,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign_reports_config import CampaignReportsConfig
@@ -1339,16 +1327,16 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
campaign_reports_config = {
campaign_reports_config = '''{
"identityAttributeColumns" : [ "firstname", "lastname" ]
} # CampaignReportsConfig | Campaign report configuration.
}''' # CampaignReportsConfig | Campaign report configuration.
try:
# Set Campaign Reports Configuration
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)
new_campaign_reports_config = CampaignReportsConfig.from_json(campaign_reports_config)
results = CertificationCampaignsApi(api_client).set_campaign_reports_config(campaign_reports_config=new_campaign_reports_config)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).set_campaign_reports_config(new_campaign_reports_config)
print("The response of CertificationCampaignsApi->set_campaign_reports_config:\n")
@@ -1396,7 +1384,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.schedule import Schedule
@@ -1404,9 +1391,10 @@ 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 = {
schedule = '''{
"hours" : {
"values" : [ "1" ],
"interval" : 2,
@@ -1425,12 +1413,12 @@ with ApiClient(configuration) as api_client:
},
"expiration" : "2000-01-23T04:56:07.000+00:00",
"type" : "WEEKLY"
} # Schedule | (optional)
}''' # Schedule | (optional)
try:
# Set Campaign Template Schedule
CertificationCampaignsApi(api_client).set_campaign_template_schedule(id, )
CertificationCampaignsApi(api_client).set_campaign_template_schedule(id=id)
# Below is a request that includes all optional parameters
# CertificationCampaignsApi(api_client).set_campaign_template_schedule(id, new_schedule)
except Exception as e:
@@ -1476,7 +1464,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.activate_campaign_options import ActivateCampaignOptions
@@ -1484,16 +1471,17 @@ 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 = {
activate_campaign_options = '''{
"timeZone" : "-05:00"
} # ActivateCampaignOptions | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. (optional)
}''' # ActivateCampaignOptions | Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller's timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format. (optional)
try:
# Activate a Campaign
results =CertificationCampaignsApi(api_client).start_campaign(id, )
results = CertificationCampaignsApi(api_client).start_campaign(id=id)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).start_campaign(id, new_activate_campaign_options)
print("The response of CertificationCampaignsApi->start_campaign:\n")
@@ -1540,20 +1528,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.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
results =CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id)
results = CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id=id)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).start_campaign_remediation_scan(id)
print("The response of CertificationCampaignsApi->start_campaign_remediation_scan:\n")
@@ -1601,7 +1589,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.report_type import ReportType
@@ -1609,6 +1596,7 @@ 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.v2024.ReportType() # ReportType | Type of the report to run. # ReportType | Type of the report to run.
@@ -1616,7 +1604,7 @@ with ApiClient(configuration) as api_client:
try:
# Run Campaign Report
results =CertificationCampaignsApi(api_client).start_campaign_report(id, type)
results = CertificationCampaignsApi(api_client).start_campaign_report(id=id, type=type)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).start_campaign_report(id, type)
print("The response of CertificationCampaignsApi->start_campaign_report:\n")
@@ -1672,7 +1660,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.campaign_reference import CampaignReference
@@ -1680,13 +1667,14 @@ 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
results =CertificationCampaignsApi(api_client).start_generate_campaign_template(id)
results = CertificationCampaignsApi(api_client).start_generate_campaign_template(id=id)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).start_generate_campaign_template(id)
print("The response of CertificationCampaignsApi->start_generate_campaign_template:\n")
@@ -1734,7 +1722,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_campaigns_api import CertificationCampaignsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
@@ -1743,21 +1730,15 @@ 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 = {
"op" : "replace",
"path" : "/description",
"value" : "New 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 = '''[{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
try:
# Update a Campaign
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)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = CertificationCampaignsApi(api_client).update_campaign(id=id, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = CertificationCampaignsApi(api_client).update_campaign(id, new_json_patch_operation)
print("The response of CertificationCampaignsApi->update_campaign:\n")

16
docs/tools/sdk/python/Reference/V2024/Methods/CertificationSummariesApi.md
View File

@@ -74,7 +74,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_summary import AccessSummary
@@ -82,6 +81,7 @@ 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
@@ -94,7 +94,7 @@ with ApiClient(configuration) as api_client:
try:
# Access Summaries
results =CertificationSummariesApi(api_client).get_identity_access_summaries(id, type, )
results = CertificationSummariesApi(api_client).get_identity_access_summaries(id=id, type=type)
# Below is a request that includes all optional parameters
# 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")
@@ -141,7 +141,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_cert_decision_summary import IdentityCertDecisionSummary
@@ -149,6 +148,7 @@ 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)
@@ -156,7 +156,7 @@ with ApiClient(configuration) as api_client:
try:
# Summary of Certification Decisions
results =CertificationSummariesApi(api_client).get_identity_decision_summary(id, )
results = CertificationSummariesApi(api_client).get_identity_decision_summary(id=id)
# Below is a request that includes all optional parameters
# results = CertificationSummariesApi(api_client).get_identity_decision_summary(id, filters)
print("The response of CertificationSummariesApi->get_identity_decision_summary:\n")
@@ -207,7 +207,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary
@@ -215,6 +214,7 @@ 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)
@@ -226,7 +226,7 @@ with ApiClient(configuration) as api_client:
try:
# Identity Summaries for Campaign Certification
results =CertificationSummariesApi(api_client).get_identity_summaries(id, )
results = CertificationSummariesApi(api_client).get_identity_summaries(id=id)
# Below is a request that includes all optional parameters
# results = CertificationSummariesApi(api_client).get_identity_summaries(id, limit, offset, count, filters, sorters)
print("The response of CertificationSummariesApi->get_identity_summaries:\n")
@@ -273,7 +273,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certification_summaries_api import CertificationSummariesApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.certification_identity_summary import CertificationIdentitySummary
@@ -281,6 +280,7 @@ 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
@@ -288,7 +288,7 @@ with ApiClient(configuration) as api_client:
try:
# Summary for Identity
results =CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id)
results = CertificationSummariesApi(api_client).get_identity_summary(id=id, identity_summary_id=identity_summary_id)
# Below is a request that includes all optional parameters
# results = CertificationSummariesApi(api_client).get_identity_summary(id, identity_summary_id)
print("The response of CertificationSummariesApi->get_identity_summary:\n")

76
docs/tools/sdk/python/Reference/V2024/Methods/CertificationsApi.md
View File

@@ -84,7 +84,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certifications_api import CertificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.certification_task import CertificationTask
@@ -92,13 +91,14 @@ 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
results =CertificationsApi(api_client).get_certification_task(id)
results = CertificationsApi(api_client).get_certification_task(id=id)
# Below is a request that includes all optional parameters
# results = CertificationsApi(api_client).get_certification_task(id)
print("The response of CertificationsApi->get_certification_task:\n")
@@ -144,7 +144,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certifications_api import CertificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_certification_dto import IdentityCertificationDto
@@ -152,13 +151,14 @@ 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
results =CertificationsApi(api_client).get_identity_certification(id)
results = CertificationsApi(api_client).get_identity_certification(id=id)
# Below is a request that includes all optional parameters
# results = CertificationsApi(api_client).get_identity_certification(id)
print("The response of CertificationsApi->get_identity_certification:\n")
@@ -209,7 +209,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certifications_api import CertificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.permission_dto import PermissionDto
@@ -217,6 +216,7 @@ 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
@@ -228,7 +228,7 @@ with ApiClient(configuration) as api_client:
try:
# Permissions for Entitlement Certification Item
results =CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id, item_id, )
results = CertificationsApi(api_client).get_identity_certification_item_permissions(certification_id=certification_id, item_id=item_id)
# Below is a request that includes all optional parameters
# 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")
@@ -278,7 +278,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certifications_api import CertificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.certification_task import CertificationTask
@@ -286,6 +285,7 @@ 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)
@@ -296,7 +296,7 @@ with ApiClient(configuration) as api_client:
try:
# List of Pending Certification Tasks
results =CertificationsApi(api_client).get_pending_certification_tasks()
results = CertificationsApi(api_client).get_pending_certification_tasks()
# Below is a request that includes all optional parameters
# results = CertificationsApi(api_client).get_pending_certification_tasks(reviewer_identity, limit, offset, count, filters)
print("The response of CertificationsApi->get_pending_certification_tasks:\n")
@@ -347,7 +347,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certifications_api import CertificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_reference_with_name_and_email import IdentityReferenceWithNameAndEmail
@@ -355,6 +354,7 @@ 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)
@@ -366,7 +366,7 @@ with ApiClient(configuration) as api_client:
try:
# List of Reviewers for certification
results =CertificationsApi(api_client).list_certification_reviewers(id, )
results = CertificationsApi(api_client).list_certification_reviewers(id=id)
# Below is a request that includes all optional parameters
# results = CertificationsApi(api_client).list_certification_reviewers(id, limit, offset, count, filters, sorters)
print("The response of CertificationsApi->list_certification_reviewers:\n")
@@ -420,7 +420,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certifications_api import CertificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.access_review_item import AccessReviewItem
@@ -428,6 +427,7 @@ 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)
@@ -442,7 +442,7 @@ with ApiClient(configuration) as api_client:
try:
# List of Access Review Items
results =CertificationsApi(api_client).list_identity_access_review_items(id, )
results = CertificationsApi(api_client).list_identity_access_review_items(id=id)
# Below is a request that includes all optional parameters
# 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")
@@ -492,7 +492,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certifications_api import CertificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_certification_dto import IdentityCertificationDto
@@ -500,6 +499,7 @@ 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)
@@ -511,7 +511,7 @@ with ApiClient(configuration) as api_client:
try:
# List Identity Campaign Certifications
results =CertificationsApi(api_client).list_identity_certifications()
results = CertificationsApi(api_client).list_identity_certifications()
# Below is a request that includes all optional parameters
# results = CertificationsApi(api_client).list_identity_certifications(reviewer_identity, limit, offset, count, filters, sorters)
print("The response of CertificationsApi->list_identity_certifications:\n")
@@ -558,7 +558,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certifications_api import CertificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_certification_dto import IdentityCertificationDto
@@ -567,28 +566,15 @@ 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 = {
"comments" : "This user no longer needs access to this source",
"decision" : "APPROVE",
"proposedEndDate" : "2017-07-11T18:45:37.098Z",
"recommendation" : {
"reasons" : [ "Reason 1", "Reason 2" ],
"recommendation" : "recommendation",
"timestamp" : "2020-06-01T13:49:37.385Z"
},
"id" : "ef38f94347e94562b5bb8424a56397d8",
"bulk" : true
} # List[ReviewDecision] | A non-empty array of decisions to be made.
review_decision = '''[{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.
try:
# Decide on a Certification Item
new_review_decision = ReviewDecision()
new_review_decision.from_json(review_decision)
results =CertificationsApi(api_client).make_identity_decision(id, new_review_decision)
new_review_decision = ReviewDecision.from_json(review_decision)
results = CertificationsApi(api_client).make_identity_decision(id=id, review_decision=new_review_decision)
# Below is a request that includes all optional parameters
# results = CertificationsApi(api_client).make_identity_decision(id, new_review_decision)
print("The response of CertificationsApi->make_identity_decision:\n")
@@ -635,7 +621,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certifications_api import CertificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_certification_dto import IdentityCertificationDto
@@ -644,9 +629,10 @@ 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 = {
review_reassign = '''{
"reason" : "reassigned for some reason",
"reassignTo" : "ef38f94347e94562b5bb8424a56397d8",
"reassign" : [ {
@@ -656,13 +642,12 @@ with ApiClient(configuration) as api_client:
"id" : "ef38f94347e94562b5bb8424a56397d8",
"type" : "ITEM"
} ]
} # ReviewReassign |
}''' # ReviewReassign |
try:
# Reassign Identities or Items
new_review_reassign = ReviewReassign()
new_review_reassign.from_json(review_reassign)
results =CertificationsApi(api_client).reassign_identity_certifications(id, new_review_reassign)
new_review_reassign = ReviewReassign.from_json(review_reassign)
results = CertificationsApi(api_client).reassign_identity_certifications(id=id, review_reassign=new_review_reassign)
# Below is a request that includes all optional parameters
# results = CertificationsApi(api_client).reassign_identity_certifications(id, new_review_reassign)
print("The response of CertificationsApi->reassign_identity_certifications:\n")
@@ -708,7 +693,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certifications_api import CertificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.identity_certification_dto import IdentityCertificationDto
@@ -716,13 +700,14 @@ 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
results =CertificationsApi(api_client).sign_off_identity_certification(id)
results = CertificationsApi(api_client).sign_off_identity_certification(id=id)
# Below is a request that includes all optional parameters
# results = CertificationsApi(api_client).sign_off_identity_certification(id)
print("The response of CertificationsApi->sign_off_identity_certification:\n")
@@ -774,7 +759,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.certifications_api import CertificationsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.certification_task import CertificationTask
@@ -783,9 +767,10 @@ 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 = {
review_reassign = '''{
"reason" : "reassigned for some reason",
"reassignTo" : "ef38f94347e94562b5bb8424a56397d8",
"reassign" : [ {
@@ -795,13 +780,12 @@ with ApiClient(configuration) as api_client:
"id" : "ef38f94347e94562b5bb8424a56397d8",
"type" : "ITEM"
} ]
} # ReviewReassign |
}''' # ReviewReassign |
try:
# Reassign Certifications Asynchronously
new_review_reassign = ReviewReassign()
new_review_reassign.from_json(review_reassign)
results =CertificationsApi(api_client).submit_reassign_certs_async(id, new_review_reassign)
new_review_reassign = ReviewReassign.from_json(review_reassign)
results = CertificationsApi(api_client).submit_reassign_certs_async(id=id, review_reassign=new_review_reassign)
# Below is a request that includes all optional parameters
# results = CertificationsApi(api_client).submit_reassign_certs_async(id, new_review_reassign)
print("The response of CertificationsApi->submit_reassign_certs_async:\n")

92
docs/tools/sdk/python/Reference/V2024/Methods/ConfigurationHubApi.md
View File

@@ -76,7 +76,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.deploy_request import DeployRequest
@@ -85,16 +84,16 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
deploy_request = {
deploy_request = '''{
"draftId" : "3d0fe04b-57df-4a46-a83b-8f04b0f9d10b"
} # DeployRequest | The deploy request body.
}''' # DeployRequest | The deploy request body.
try:
# Create a Deploy
new_deploy_request = DeployRequest()
new_deploy_request.from_json(deploy_request)
results =ConfigurationHubApi(api_client).create_deploy(new_deploy_request)
new_deploy_request = DeployRequest.from_json(deploy_request)
results = ConfigurationHubApi(api_client).create_deploy(deploy_request=new_deploy_request)
# Below is a request that includes all optional parameters
# results = ConfigurationHubApi(api_client).create_deploy(new_deploy_request)
print("The response of ConfigurationHubApi->create_deploy:\n")
@@ -144,7 +143,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.object_mapping_request import ObjectMappingRequest
@@ -153,21 +151,21 @@ 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 = {
object_mapping_request = '''{
"targetValue" : "My New Governance Group Name",
"jsonPath" : "$.name",
"sourceValue" : "My Governance Group Name",
"enabled" : false,
"objectType" : "IDENTITY"
} # ObjectMappingRequest | The object mapping request body.
}''' # ObjectMappingRequest | The object mapping request body.
try:
# Creates an object mapping
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)
new_object_mapping_request = ObjectMappingRequest.from_json(object_mapping_request)
results = ConfigurationHubApi(api_client).create_object_mapping(source_org=source_org, object_mapping_request=new_object_mapping_request)
# Below is a request that includes all optional parameters
# results = ConfigurationHubApi(api_client).create_object_mapping(source_org, new_object_mapping_request)
print("The response of ConfigurationHubApi->create_object_mapping:\n")
@@ -217,7 +215,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.object_mapping_bulk_create_request import ObjectMappingBulkCreateRequest
@@ -226,9 +223,10 @@ 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 = {
object_mapping_bulk_create_request = '''{
"newObjectsMappings" : [ {
"targetValue" : "My New Governance Group Name",
"jsonPath" : "$.name",
@@ -242,13 +240,12 @@ with ApiClient(configuration) as api_client:
"enabled" : false,
"objectType" : "IDENTITY"
} ]
} # ObjectMappingBulkCreateRequest | The bulk create object mapping request body.
}''' # ObjectMappingBulkCreateRequest | The bulk create object mapping request body.
try:
# Bulk creates object mappings
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)
new_object_mapping_bulk_create_request = ObjectMappingBulkCreateRequest.from_json(object_mapping_bulk_create_request)
results = ConfigurationHubApi(api_client).create_object_mappings(source_org=source_org, object_mapping_bulk_create_request=new_object_mapping_bulk_create_request)
# Below is a request that includes all optional parameters
# results = ConfigurationHubApi(api_client).create_object_mappings(source_org, new_object_mapping_bulk_create_request)
print("The response of ConfigurationHubApi->create_object_mappings:\n")
@@ -298,7 +295,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.backup_response import BackupResponse
@@ -306,6 +302,7 @@ 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.
@@ -313,7 +310,7 @@ with ApiClient(configuration) as api_client:
try:
# Upload a Configuration
results =ConfigurationHubApi(api_client).create_uploaded_configuration(data, name)
results = ConfigurationHubApi(api_client).create_uploaded_configuration(data=data, name=name)
# Below is a request that includes all optional parameters
# results = ConfigurationHubApi(api_client).create_uploaded_configuration(data, name)
print("The response of ConfigurationHubApi->create_uploaded_configuration:\n")
@@ -363,20 +360,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '07659d7d-2cce-47c0-9e49-185787ee565a' # str | The id of the backup to delete. # str | The id of the backup to delete.
try:
# Delete a Backup
ConfigurationHubApi(api_client).delete_backup(id)
ConfigurationHubApi(api_client).delete_backup(id=id)
# Below is a request that includes all optional parameters
# ConfigurationHubApi(api_client).delete_backup(id)
except Exception as e:
@@ -424,20 +421,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = '07659d7d-2cce-47c0-9e49-185787ee565a' # str | The id of the draft to delete. # str | The id of the draft to delete.
try:
# Delete a draft
ConfigurationHubApi(api_client).delete_draft(id)
ConfigurationHubApi(api_client).delete_draft(id=id)
# Below is a request that includes all optional parameters
# ConfigurationHubApi(api_client).delete_draft(id)
except Exception as e:
@@ -485,13 +482,13 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.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.
@@ -499,7 +496,7 @@ with ApiClient(configuration) as api_client:
try:
# Deletes an object mapping
ConfigurationHubApi(api_client).delete_object_mapping(source_org, object_mapping_id)
ConfigurationHubApi(api_client).delete_object_mapping(source_org=source_org, object_mapping_id=object_mapping_id)
# Below is a request that includes all optional parameters
# ConfigurationHubApi(api_client).delete_object_mapping(source_org, object_mapping_id)
except Exception as e:
@@ -547,20 +544,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.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
ConfigurationHubApi(api_client).delete_uploaded_configuration(id)
ConfigurationHubApi(api_client).delete_uploaded_configuration(id=id)
# Below is a request that includes all optional parameters
# ConfigurationHubApi(api_client).delete_uploaded_configuration(id)
except Exception as e:
@@ -604,7 +601,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.deploy_response import DeployResponse
@@ -612,13 +608,14 @@ 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 deploy. # str | The id of the deploy.
try:
# Get a Deploy
results =ConfigurationHubApi(api_client).get_deploy(id)
results = ConfigurationHubApi(api_client).get_deploy(id=id)
# Below is a request that includes all optional parameters
# results = ConfigurationHubApi(api_client).get_deploy(id)
print("The response of ConfigurationHubApi->get_deploy:\n")
@@ -667,7 +664,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.object_mapping_response import ObjectMappingResponse
@@ -675,13 +671,14 @@ 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
results =ConfigurationHubApi(api_client).get_object_mappings(source_org)
results = ConfigurationHubApi(api_client).get_object_mappings(source_org=source_org)
# Below is a request that includes all optional parameters
# results = ConfigurationHubApi(api_client).get_object_mappings(source_org)
print("The response of ConfigurationHubApi->get_object_mappings:\n")
@@ -727,7 +724,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.backup_response import BackupResponse
@@ -735,13 +731,14 @@ 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
results =ConfigurationHubApi(api_client).get_uploaded_configuration(id)
results = ConfigurationHubApi(api_client).get_uploaded_configuration(id=id)
# Below is a request that includes all optional parameters
# results = ConfigurationHubApi(api_client).get_uploaded_configuration(id)
print("The response of ConfigurationHubApi->get_uploaded_configuration:\n")
@@ -786,7 +783,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.backup_response import BackupResponse
@@ -794,13 +790,14 @@ 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 Backups
results =ConfigurationHubApi(api_client).list_backups()
results = ConfigurationHubApi(api_client).list_backups()
# Below is a request that includes all optional parameters
# results = ConfigurationHubApi(api_client).list_backups(filters)
print("The response of ConfigurationHubApi->list_backups:\n")
@@ -842,7 +839,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.list_deploys200_response import ListDeploys200Response
@@ -850,12 +846,13 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
try:
# List Deploys
results =ConfigurationHubApi(api_client).list_deploys()
results = ConfigurationHubApi(api_client).list_deploys()
# Below is a request that includes all optional parameters
# results = ConfigurationHubApi(api_client).list_deploys()
print("The response of ConfigurationHubApi->list_deploys:\n")
@@ -900,7 +897,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.draft_response import DraftResponse
@@ -908,13 +904,14 @@ 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* **approvalStatus**: *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* **approvalStatus**: *eq* (optional)
try:
# List Drafts
results =ConfigurationHubApi(api_client).list_drafts()
results = ConfigurationHubApi(api_client).list_drafts()
# Below is a request that includes all optional parameters
# results = ConfigurationHubApi(api_client).list_drafts(filters)
print("The response of ConfigurationHubApi->list_drafts:\n")
@@ -960,7 +957,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.backup_response import BackupResponse
@@ -968,13 +964,14 @@ 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
results =ConfigurationHubApi(api_client).list_uploaded_configurations()
results = ConfigurationHubApi(api_client).list_uploaded_configurations()
# Below is a request that includes all optional parameters
# results = ConfigurationHubApi(api_client).list_uploaded_configurations(filters)
print("The response of ConfigurationHubApi->list_uploaded_configurations:\n")
@@ -1024,7 +1021,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.object_mapping_bulk_patch_request import ObjectMappingBulkPatchRequest
@@ -1033,9 +1029,10 @@ 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 = {
object_mapping_bulk_patch_request = '''{
"patches" : {
"603b1a61-d03d-4ed1-864f-a508fbd1995d" : [ {
"op" : "replace",
@@ -1048,13 +1045,12 @@ with ApiClient(configuration) as api_client:
"value" : "New Target Value"
} ]
}
} # ObjectMappingBulkPatchRequest | The object mapping request body.
}''' # ObjectMappingBulkPatchRequest | The object mapping request body.
try:
# Bulk updates object mappings
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)
new_object_mapping_bulk_patch_request = ObjectMappingBulkPatchRequest.from_json(object_mapping_bulk_patch_request)
results = ConfigurationHubApi(api_client).update_object_mappings(source_org=source_org, object_mapping_bulk_patch_request=new_object_mapping_bulk_patch_request)
# Below is a request that includes all optional parameters
# results = ConfigurationHubApi(api_client).update_object_mappings(source_org, new_object_mapping_bulk_patch_request)
print("The response of ConfigurationHubApi->update_object_mappings:\n")

96
docs/tools/sdk/python/Reference/V2024/Methods/ConnectorRuleManagementApi.md
View File

@@ -34,6 +34,14 @@ Method | HTTP request | Description
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Create Connector Rule
Create a connector rule from the available types.
@@ -66,7 +74,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connector_rule_management_api import ConnectorRuleManagementApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.connector_rule_create_request import ConnectorRuleCreateRequest
@@ -75,9 +82,11 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
connector_rule_create_request = {
connector_rule_create_request = '''{
"sourceCode" : {
"version" : "1.0",
"script" : "return \"Mr. \" + firstName;"
@@ -102,13 +111,12 @@ with ApiClient(configuration) as api_client:
"description" : "This rule does that",
"attributes" : { },
"type" : "BuildMap"
} # ConnectorRuleCreateRequest | Connector rule to create.
}''' # ConnectorRuleCreateRequest | Connector rule to create.
try:
# Create Connector Rule
new_connector_rule_create_request = ConnectorRuleCreateRequest()
new_connector_rule_create_request.from_json(connector_rule_create_request)
results =ConnectorRuleManagementApi(api_client).create_connector_rule(x_sail_point_experimental, new_connector_rule_create_request)
new_connector_rule_create_request = ConnectorRuleCreateRequest.from_json(connector_rule_create_request)
results = ConnectorRuleManagementApi(api_client).create_connector_rule(x_sail_point_experimental=x_sail_point_experimental, connector_rule_create_request=new_connector_rule_create_request)
# Below is a request that includes all optional parameters
# results = ConnectorRuleManagementApi(api_client).create_connector_rule(x_sail_point_experimental, new_connector_rule_create_request)
print("The response of ConnectorRuleManagementApi->create_connector_rule:\n")
@@ -125,6 +133,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Delete Connector Rule
Delete the connector rule for the given ID.
@@ -158,13 +174,14 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connector_rule_management_api import ConnectorRuleManagementApi
from sailpoint.v2024.api_client import ApiClient
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to delete. # str | ID of the connector rule to delete.
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
@@ -172,7 +189,7 @@ with ApiClient(configuration) as api_client:
try:
# Delete Connector Rule
ConnectorRuleManagementApi(api_client).delete_connector_rule(id, x_sail_point_experimental)
ConnectorRuleManagementApi(api_client).delete_connector_rule(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# ConnectorRuleManagementApi(api_client).delete_connector_rule(id, x_sail_point_experimental)
except Exception as e:
@@ -187,6 +204,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Get Connector Rule
Get a connector rule by ID.
@@ -220,7 +245,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connector_rule_management_api import ConnectorRuleManagementApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.connector_rule_response import ConnectorRuleResponse
@@ -228,6 +252,8 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to get. # str | ID of the connector rule to get.
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
@@ -235,7 +261,7 @@ with ApiClient(configuration) as api_client:
try:
# Get Connector Rule
results =ConnectorRuleManagementApi(api_client).get_connector_rule(id, x_sail_point_experimental)
results = ConnectorRuleManagementApi(api_client).get_connector_rule(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = ConnectorRuleManagementApi(api_client).get_connector_rule(id, x_sail_point_experimental)
print("The response of ConnectorRuleManagementApi->get_connector_rule:\n")
@@ -252,6 +278,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
List Connector Rules
List existing connector rules.
@@ -286,7 +320,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connector_rule_management_api import ConnectorRuleManagementApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.connector_rule_response import ConnectorRuleResponse
@@ -294,6 +327,8 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
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)
@@ -303,7 +338,7 @@ with ApiClient(configuration) as api_client:
try:
# List Connector Rules
results =ConnectorRuleManagementApi(api_client).get_connector_rule_list(x_sail_point_experimental, )
results = ConnectorRuleManagementApi(api_client).get_connector_rule_list(x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = ConnectorRuleManagementApi(api_client).get_connector_rule_list(x_sail_point_experimental, limit, offset, count)
print("The response of ConnectorRuleManagementApi->get_connector_rule_list:\n")
@@ -320,6 +355,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Update Connector Rule
Update an existing connector rule with the one provided in the request body. These fields are immutable: `id`, `name`, `type`
@@ -354,7 +397,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connector_rule_management_api import ConnectorRuleManagementApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.connector_rule_response import ConnectorRuleResponse
@@ -363,10 +405,12 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
id = '8c190e6787aa4ed9a90bd9d5344523fb' # str | ID of the connector rule to update. # str | ID of the connector rule to update.
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
connector_rule_update_request = {
connector_rule_update_request = '''{
"sourceCode" : {
"version" : "1.0",
"script" : "return \"Mr. \" + firstName;"
@@ -392,12 +436,12 @@ with ApiClient(configuration) as api_client:
"attributes" : { },
"id" : "8113d48c0b914f17b4c6072d4dcb9dfe",
"type" : "BuildMap"
} # ConnectorRuleUpdateRequest | Connector rule with updated data. (optional)
}''' # ConnectorRuleUpdateRequest | Connector rule with updated data. (optional)
try:
# Update Connector Rule
results =ConnectorRuleManagementApi(api_client).put_connector_rule(id, x_sail_point_experimental, )
results = ConnectorRuleManagementApi(api_client).put_connector_rule(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
# results = ConnectorRuleManagementApi(api_client).put_connector_rule(id, x_sail_point_experimental, new_connector_rule_update_request)
print("The response of ConnectorRuleManagementApi->put_connector_rule:\n")
@@ -414,6 +458,14 @@ with ApiClient(configuration) as api_client:
:::warning experimental
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Validate Connector Rule
Detect issues within the connector rule's code to fix and list them.
@@ -446,7 +498,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connector_rule_management_api import ConnectorRuleManagementApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.connector_rule_validation_response import ConnectorRuleValidationResponse
@@ -455,18 +506,19 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = true
with ApiClient(configuration) as api_client:
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
source_code = {
source_code = '''{
"version" : "1.0",
"script" : "return \"Mr. \" + firstName;"
} # SourceCode | Code to validate.
}''' # SourceCode | Code to validate.
try:
# Validate Connector Rule
new_source_code = SourceCode()
new_source_code.from_json(source_code)
results =ConnectorRuleManagementApi(api_client).test_connector_rule(x_sail_point_experimental, new_source_code)
new_source_code = SourceCode.from_json(source_code)
results = ConnectorRuleManagementApi(api_client).test_connector_rule(x_sail_point_experimental=x_sail_point_experimental, source_code=new_source_code)
# Below is a request that includes all optional parameters
# results = ConnectorRuleManagementApi(api_client).test_connector_rule(x_sail_point_experimental, new_source_code)
print("The response of ConnectorRuleManagementApi->test_connector_rule:\n")

70
docs/tools/sdk/python/Reference/V2024/Methods/ConnectorsApi.md
View File

@@ -77,7 +77,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.v3_connector_dto import V3ConnectorDto
@@ -86,20 +85,20 @@ from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
v3_create_connector_dto = {
v3_create_connector_dto = '''{
"name" : "custom connector",
"directConnect" : true,
"className" : "sailpoint.connector.OpenConnectorAdapter",
"type" : "custom connector type",
"status" : "RELEASED"
} # V3CreateConnectorDto |
}''' # V3CreateConnectorDto |
try:
# Create Custom Connector
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)
new_v3_create_connector_dto = V3CreateConnectorDto.from_json(v3_create_connector_dto)
results = ConnectorsApi(api_client).create_custom_connector(v3_create_connector_dto=new_v3_create_connector_dto)
# Below is a request that includes all optional parameters
# results = ConnectorsApi(api_client).create_custom_connector(new_v3_create_connector_dto)
print("The response of ConnectorsApi->create_custom_connector:\n")
@@ -145,20 +144,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.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
ConnectorsApi(api_client).delete_custom_connector(script_name)
ConnectorsApi(api_client).delete_custom_connector(script_name=script_name)
# Below is a request that includes all optional parameters
# ConnectorsApi(api_client).delete_custom_connector(script_name)
except Exception as e:
@@ -203,7 +202,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.connector_detail import ConnectorDetail
@@ -211,6 +209,7 @@ 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)
@@ -218,7 +217,7 @@ with ApiClient(configuration) as api_client:
try:
# Get Connector by Script Name
results =ConnectorsApi(api_client).get_connector(script_name, )
results = ConnectorsApi(api_client).get_connector(script_name=script_name)
# Below is a request that includes all optional parameters
# results = ConnectorsApi(api_client).get_connector(script_name, locale)
print("The response of ConnectorsApi->get_connector:\n")
@@ -264,20 +263,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.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 Correlation Configuration
results =ConnectorsApi(api_client).get_connector_correlation_config(script_name)
results = ConnectorsApi(api_client).get_connector_correlation_config(script_name=script_name)
# Below is a request that includes all optional parameters
# results = ConnectorsApi(api_client).get_connector_correlation_config(script_name)
print("The response of ConnectorsApi->get_connector_correlation_config:\n")
@@ -327,7 +326,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.v3_connector_dto import V3ConnectorDto
@@ -335,6 +333,7 @@ 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)
@@ -345,7 +344,7 @@ with ApiClient(configuration) as api_client:
try:
# Get Connector List
results =ConnectorsApi(api_client).get_connector_list()
results = ConnectorsApi(api_client).get_connector_list()
# Below is a request that includes all optional parameters
# results = ConnectorsApi(api_client).get_connector_list(filters, limit, offset, count, locale)
print("The response of ConnectorsApi->get_connector_list:\n")
@@ -391,20 +390,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.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
results =ConnectorsApi(api_client).get_connector_source_config(script_name)
results = ConnectorsApi(api_client).get_connector_source_config(script_name=script_name)
# Below is a request that includes all optional parameters
# results = ConnectorsApi(api_client).get_connector_source_config(script_name)
print("The response of ConnectorsApi->get_connector_source_config:\n")
@@ -450,20 +449,20 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.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
results =ConnectorsApi(api_client).get_connector_source_template(script_name)
results = ConnectorsApi(api_client).get_connector_source_template(script_name=script_name)
# Below is a request that includes all optional parameters
# results = ConnectorsApi(api_client).get_connector_source_template(script_name)
print("The response of ConnectorsApi->get_connector_source_template:\n")
@@ -510,13 +509,13 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.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\"
@@ -524,7 +523,7 @@ with ApiClient(configuration) as api_client:
try:
# Get Connector Translations
results =ConnectorsApi(api_client).get_connector_translations(script_name, locale)
results = ConnectorsApi(api_client).get_connector_translations(script_name=script_name, locale=locale)
# Below is a request that includes all optional parameters
# results = ConnectorsApi(api_client).get_connector_translations(script_name, locale)
print("The response of ConnectorsApi->get_connector_translations:\n")
@@ -571,7 +570,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.update_detail import UpdateDetail
@@ -579,6 +577,7 @@ 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 correlation config xml file # bytearray | connector correlation config xml file
@@ -586,7 +585,7 @@ with ApiClient(configuration) as api_client:
try:
# Update Connector Correlation Configuration
results =ConnectorsApi(api_client).put_connector_correlation_config(script_name, file)
results = ConnectorsApi(api_client).put_connector_correlation_config(script_name=script_name, file=file)
# Below is a request that includes all optional parameters
# results = ConnectorsApi(api_client).put_connector_correlation_config(script_name, file)
print("The response of ConnectorsApi->put_connector_correlation_config:\n")
@@ -633,7 +632,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.update_detail import UpdateDetail
@@ -641,6 +639,7 @@ 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
@@ -648,7 +647,7 @@ with ApiClient(configuration) as api_client:
try:
# Update Connector Source Configuration
results =ConnectorsApi(api_client).put_connector_source_config(script_name, file)
results = ConnectorsApi(api_client).put_connector_source_config(script_name=script_name, file=file)
# Below is a request that includes all optional parameters
# results = ConnectorsApi(api_client).put_connector_source_config(script_name, file)
print("The response of ConnectorsApi->put_connector_source_config:\n")
@@ -695,7 +694,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.update_detail import UpdateDetail
@@ -703,6 +701,7 @@ 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
@@ -710,7 +709,7 @@ with ApiClient(configuration) as api_client:
try:
# Update Connector Source Template
results =ConnectorsApi(api_client).put_connector_source_template(script_name, file)
results = ConnectorsApi(api_client).put_connector_source_template(script_name=script_name, file=file)
# Below is a request that includes all optional parameters
# results = ConnectorsApi(api_client).put_connector_source_template(script_name, file)
print("The response of ConnectorsApi->put_connector_source_template:\n")
@@ -757,7 +756,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.update_detail import UpdateDetail
@@ -765,6 +763,7 @@ 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\"
@@ -772,7 +771,7 @@ with ApiClient(configuration) as api_client:
try:
# Update Connector Translations
results =ConnectorsApi(api_client).put_connector_translations(script_name, locale)
results = ConnectorsApi(api_client).put_connector_translations(script_name=script_name, locale=locale)
# Below is a request that includes all optional parameters
# results = ConnectorsApi(api_client).put_connector_translations(script_name, locale)
print("The response of ConnectorsApi->put_connector_translations:\n")
@@ -831,7 +830,6 @@ Code | Description | Data Type | Response headers |
### Example
```python
import sailpoint.v2024
from sailpoint.v2024.api.connectors_api import ConnectorsApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.connector_detail import ConnectorDetail
@@ -840,21 +838,15 @@ 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.v2024.JsonPatchOperation()] # List[JsonPatchOperation] | A list of connector detail update operations
json_patch_operation = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] | A list of connector detail update operations
json_patch_operation = '''[sailpoint.v2024.JsonPatchOperation()]''' # List[JsonPatchOperation] | A list of connector detail update operations
try:
# Update Connector by Script Name
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)
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
results = ConnectorsApi(api_client).update_connector(script_name=script_name, json_patch_operation=new_json_patch_operation)
# Below is a request that includes all optional parameters
# results = ConnectorsApi(api_client).update_connector(script_name, new_json_patch_operation)
print("The response of ConnectorsApi->update_connector:\n")

Some files were not shown because too many files have changed in this diff Show More