mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 20:37:46 +00:00
Update to python SDK docs: 14455009748
This commit is contained in:
developer-relations-sp
@@ -122,6 +122,7 @@ __GRANT_ACCESS__
|
||||
* Allows any authenticated token (except API) to call this endpoint to request to grant access to themselves. Depending on the configuration, a user can request access for others.
|
||||
* Roles, access profiles and entitlements can be requested.
|
||||
* While requesting entitlements, maximum of 25 entitlements and 10 recipients are allowed in a request.
|
||||
* Now supports an alternate field 'requestedForWithRequestedItems' for users to specify account selections while requesting items where they have more than one account on the source.
|
||||
|
||||
__REVOKE_ACCESS__
|
||||
* Can only be requested for a single identity at a time.
|
||||
@@ -132,6 +133,7 @@ __REVOKE_ACCESS__
|
||||
* Revoke requests for entitlements are limited to 1 entitlement per access request currently.
|
||||
* You can specify a `removeDate` if the access doesn't already have a sunset date. The `removeDate` must be a future date, in the UTC timezone.
|
||||
* Allows a manager to request to revoke access for direct employees. A user with ORG_ADMIN authority can also request to revoke access from anyone.
|
||||
* Now supports REVOKE_ACCESS requests for identities with multiple accounts on a single source, with the help of 'assignmentId' and 'nativeIdentity' fields.
|
||||
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-access-request)
|
||||
@@ -172,7 +174,7 @@ configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
access_request = '''{
|
||||
"requestedFor" : [ "2c918084660f45d6016617daa9210584", "2c918084660f45d6016617daa9210584" ],
|
||||
"requestedFor" : "2c918084660f45d6016617daa9210584",
|
||||
"clientMetadata" : {
|
||||
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1",
|
||||
"requestedAppName" : "test-app"
|
||||
@@ -233,6 +235,133 @@ with ApiClient(configuration) as api_client:
|
||||
"type" : "ACCESS_PROFILE",
|
||||
"assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc",
|
||||
"nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN"
|
||||
} ],
|
||||
"requestedForWithRequestedItems" : [ {
|
||||
"identityId" : "cb89bc2f1ee6445fbea12224c526ba3a",
|
||||
"requestedItems" : [ {
|
||||
"clientMetadata" : {
|
||||
"requestedAppName" : "test-app",
|
||||
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1"
|
||||
},
|
||||
"removeDate" : "2020-07-11T21:23:15Z",
|
||||
"accountSelection" : [ {
|
||||
"sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a",
|
||||
"accounts" : [ {
|
||||
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
|
||||
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
|
||||
}, {
|
||||
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
|
||||
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
|
||||
} ]
|
||||
}, {
|
||||
"sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a",
|
||||
"accounts" : [ {
|
||||
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
|
||||
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
|
||||
}, {
|
||||
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
|
||||
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
|
||||
} ]
|
||||
} ],
|
||||
"comment" : "Requesting access profile for John Doe",
|
||||
"id" : "2c9180835d2e5168015d32f890ca1581",
|
||||
"type" : "ACCESS_PROFILE",
|
||||
"assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc",
|
||||
"nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN"
|
||||
}, {
|
||||
"clientMetadata" : {
|
||||
"requestedAppName" : "test-app",
|
||||
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1"
|
||||
},
|
||||
"removeDate" : "2020-07-11T21:23:15Z",
|
||||
"accountSelection" : [ {
|
||||
"sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a",
|
||||
"accounts" : [ {
|
||||
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
|
||||
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
|
||||
}, {
|
||||
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
|
||||
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
|
||||
} ]
|
||||
}, {
|
||||
"sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a",
|
||||
"accounts" : [ {
|
||||
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
|
||||
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
|
||||
}, {
|
||||
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
|
||||
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
|
||||
} ]
|
||||
} ],
|
||||
"comment" : "Requesting access profile for John Doe",
|
||||
"id" : "2c9180835d2e5168015d32f890ca1581",
|
||||
"type" : "ACCESS_PROFILE",
|
||||
"assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc",
|
||||
"nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN"
|
||||
} ]
|
||||
}, {
|
||||
"identityId" : "cb89bc2f1ee6445fbea12224c526ba3a",
|
||||
"requestedItems" : [ {
|
||||
"clientMetadata" : {
|
||||
"requestedAppName" : "test-app",
|
||||
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1"
|
||||
},
|
||||
"removeDate" : "2020-07-11T21:23:15Z",
|
||||
"accountSelection" : [ {
|
||||
"sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a",
|
||||
"accounts" : [ {
|
||||
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
|
||||
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
|
||||
}, {
|
||||
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
|
||||
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
|
||||
} ]
|
||||
}, {
|
||||
"sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a",
|
||||
"accounts" : [ {
|
||||
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
|
||||
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
|
||||
}, {
|
||||
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
|
||||
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
|
||||
} ]
|
||||
} ],
|
||||
"comment" : "Requesting access profile for John Doe",
|
||||
"id" : "2c9180835d2e5168015d32f890ca1581",
|
||||
"type" : "ACCESS_PROFILE",
|
||||
"assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc",
|
||||
"nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN"
|
||||
}, {
|
||||
"clientMetadata" : {
|
||||
"requestedAppName" : "test-app",
|
||||
"requestedAppId" : "2c91808f7892918f0178b78da4a305a1"
|
||||
},
|
||||
"removeDate" : "2020-07-11T21:23:15Z",
|
||||
"accountSelection" : [ {
|
||||
"sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a",
|
||||
"accounts" : [ {
|
||||
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
|
||||
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
|
||||
}, {
|
||||
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
|
||||
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
|
||||
} ]
|
||||
}, {
|
||||
"sourceId" : "cb89bc2f1ee6445fbea12224c526ba3a",
|
||||
"accounts" : [ {
|
||||
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
|
||||
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
|
||||
}, {
|
||||
"accountUuid" : "{fab7119e-004f-4822-9c33-b8d570d6c6a6}",
|
||||
"nativeIdentity" : "CN=Glen 067da3248e914,OU=YOUROU,OU=org-data-service,DC=YOURDC,DC=local"
|
||||
} ]
|
||||
} ],
|
||||
"comment" : "Requesting access profile for John Doe",
|
||||
"id" : "2c9180835d2e5168015d32f890ca1581",
|
||||
"type" : "ACCESS_PROFILE",
|
||||
"assignmentId" : "ee48a191c00d49bf9264eb0a4fc3a9fc",
|
||||
"nativeIdentity" : "CN=User db3377de14bf,OU=YOURCONTAINER, DC=YOURDOMAIN"
|
||||
} ]
|
||||
} ]
|
||||
}''' # AccessRequest |
|
||||
|
||||
|
||||
@@ -336,6 +336,7 @@ Get a single workflow by id.
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | Id of the workflow
|
||||
Query | workflow_metrics | **bool** | (optional) (default to True) | disable workflow metrics
|
||||
|
||||
### Return type
|
||||
[**Workflow**](../models/workflow)
|
||||
@@ -366,13 +367,14 @@ 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_metrics = True # bool | disable workflow metrics (optional) (default to True) # bool | disable workflow metrics (optional) (default to True)
|
||||
|
||||
try:
|
||||
# Get Workflow By 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)
|
||||
# results = WorkflowsApi(api_client).get_workflow(id, workflow_metrics)
|
||||
print("The response of WorkflowsApi->get_workflow:\n")
|
||||
print(results.model_dump_json(by_alias=True, indent=4))
|
||||
except Exception as e:
|
||||
@@ -828,7 +830,13 @@ List all workflows in the tenant.
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-workflows)
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Query | trigger_id | **str** | (optional) | Trigger ID
|
||||
Query | connector_instance_id | **str** | (optional) | Connector Instance ID
|
||||
Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
Query | offset | **int** | (optional) (default to 0) | 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.
|
||||
|
||||
### Return type
|
||||
[**List[Workflow]**](../models/workflow)
|
||||
@@ -858,13 +866,17 @@ configuration = Configuration()
|
||||
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
trigger_id = 'idn:identity-created' # str | Trigger ID (optional) # str | Trigger ID (optional)
|
||||
connector_instance_id = '28541fec-bb81-4ad4-88ef-0f7d213adcad' # str | Connector Instance ID (optional) # str | Connector Instance ID (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)
|
||||
|
||||
try:
|
||||
# List Workflows
|
||||
|
||||
results = WorkflowsApi(api_client).list_workflows()
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = WorkflowsApi(api_client).list_workflows()
|
||||
# results = WorkflowsApi(api_client).list_workflows(trigger_id, connector_instance_id, limit, offset)
|
||||
print("The response of WorkflowsApi->list_workflows:\n")
|
||||
for item in results:
|
||||
print(item.model_dump_json(by_alias=True, indent=4))
|
||||
|
||||
Reference in New Issue
Block a user