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: 13984088294

Browse Source
This commit is contained in:
developer-relations-sp
2025-03-21 03:35:56 +00:00
parent ab8c7f65b5
commit 5109bc43f7
96 changed files with 598 additions and 488 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -23,7 +23,7 @@ When users only need Active Directory employee access, they can request access t
When users need both Active Directory employee and developer access, they can request access to the 'AD Developers' access profile.
Access profiles are the most important units of access in Identity Security Cloud. Identity Security Cloud uses access profiles in many features, including the following:
Identity Security Cloud uses access profiles in many features, including the following:
- Provisioning: When you use the Provisioning Service, lifecycle states and roles both grant access to users in the form of access profiles.
@@ -61,9 +61,9 @@ Method | HTTP request | Description
## create-access-profile
Create Access Profile
Use this API to create an access profile.
A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source.
The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters.
Create an access profile.
A user with only ROLE_SUBADMIN or SOURCE_SUBADMIN authority must be associated with the access profile's Source.
The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-access-profile)
@@ -462,8 +462,8 @@ with ApiClient(configuration) as api_client:
## list-access-profiles
List Access Profiles
Use this API to get a list of access profiles.
A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
Get a list of access profiles.
>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-access-profiles)
@@ -471,14 +471,14 @@ A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Query | for_subadmin | **str** | (optional) | 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.
Query | limit | **int** | (optional) (default to 50) | 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.
Query | for_subadmin | **str** | (optional) | 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. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error.
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.
Query | count | **bool** | (optional) (default to False) | 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.
Query | filters | **str** | (optional) | 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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names.
Query | sorters | **str** | (optional) | 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, created, modified**
Query | for_segment_ids | **str** | (optional) | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
Query | include_unsegmented | **bool** | (optional) (default to True) | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
Query | for_segment_ids | **str** | (optional) | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
Query | include_unsegmented | **bool** | (optional) (default to True) | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error.
### Return type
[**List[AccessProfile]**](../models/access-profile)
@@ -509,14 +509,14 @@ 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)
for_subadmin = '8c190e6787aa4ed9a90bd9d5344523fb' # str | 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. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (optional) # str | 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. If you specify an identity that isn't a subadmin, the API returns a 400 Bad Request error. (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)
filters = 'name eq \"SailPoint Support\"' # 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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (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* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the '+' symbol in their names. (optional)
sorters = 'name,-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-results) Sorting is supported for the following fields: **name, created, 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-results) Sorting is supported for the following fields: **name, created, modified** (optional)
for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional)
include_unsegmented = True # bool | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True)
for_segment_ids = '0b5c9f25-83c6-4762-9073-e38f7bb2ae26,2e8d8180-24bc-4d21-91c6-7affdb473b0d' # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional) # str | Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error. (optional)
include_unsegmented = True # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True)
try:
# List Access Profiles

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

@@ -57,7 +57,7 @@ Method | HTTP request | Description
[**delete-role**](#delete-role) | **DELETE** `/roles/{id}` | Delete a Role
[**get-role**](#get-role) | **GET** `/roles/{id}` | Get a Role
[**get-role-assigned-identities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | Identities assigned a Role
[**get-role-entitlements**](#get-role-entitlements) | **GET** `/roles/{id}/entitlements` | List role's Entitlements
[**get-role-entitlements**](#get-role-entitlements) | **GET** `/roles/{id}/entitlements` | List Role's Entitlements
[**list-roles**](#list-roles) | **GET** `/roles` | List Roles
[**patch-role**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified Role
@@ -537,10 +537,8 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-role-entitlements
List role's Entitlements
This API lists the Entitlements associated with a given role.
A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
List Role's Entitlements
Get a list of entitlements associated with a specified role.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-entitlements)
@@ -548,8 +546,8 @@ A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | ID of the containing role
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.
Path | id | **str** | True | Containing role's ID.
Query | limit | **int** | (optional) (default to 50) | 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.
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.
Query | count | **bool** | (optional) (default to False) | 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.
Query | filters | **str** | (optional) | 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in*
@@ -584,15 +582,15 @@ 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)
id = '2c91808a7813090a017814121919ecca' # str | Containing role's ID. # str | Containing role's ID.
limit = 50 # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50) # int | Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 50)
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
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 = 'attribute eq \"memberOf\"' # 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* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.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: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* (optional)
sorters = 'name,-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-results) Sorting is supported for the following fields: **name, attribute, value, created, 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-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional)
try:
# List role's Entitlements
# List Role's Entitlements
results = RolesApi(api_client).get_role_entitlements(id=id)
# Below is a request that includes all optional parameters

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

@@ -42,8 +42,8 @@ Method | HTTP request | Description
## create-search-attribute-config
Create Extended Search Attributes
Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create and attribute promotion configuration in the Link ObjectConfig.
A token with ORG_ADMIN authority is required to call this API.
Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create the attribute promotion configuration in the Link ObjectConfig.
>**Note: Give searchable attributes unique names. Do not give them the same names used for account attributes or source attributes. Also, do not give them the same names present in account schema for a current or future source, regardless of whether that source is included in the searchable attributes' `applicationAttributes`.**
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-search-attribute-config)
@@ -166,13 +166,17 @@ with ApiClient(configuration) as api_client:
## get-search-attribute-config
List Extended Search Attributes
Get a list of attribute/application associates currently configured in Identity Security Cloud (ISC).
Get a list of attribute/application attributes currently configured in Identity Security Cloud (ISC).
A token with ORG_ADMIN authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-search-attribute-config)
### Parameters
This endpoint does not need any parameter.
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
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[SearchAttributeConfig]**](../models/search-attribute-config)
@@ -181,6 +185,7 @@ This endpoint does not need any parameter.
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | List of attribute configurations in ISC. | List[SearchAttributeConfig] | - |
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 | - |
@@ -202,13 +207,15 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
try:
# List Extended Search Attributes
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()
# results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(limit, offset)
print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n")
pprint(results)
except Exception as e:

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

@@ -10,7 +10,12 @@ tags: ['SDK', 'Software Development Kit', 'Transforms', 'BetaTransforms']
---
# sailpoint.beta.TransformsApi
Operations for creating, managing, and deleting transforms.
The purpose of this API is to expose functionality for the manipulation of Transform objects.
Transforms are a form of configurable objects which define an easy way to manipulate attribute data without having
to write code.
Refer to [Transforms](https://developer.sailpoint.com/docs/extensibility/transforms/) for more information about transforms.
All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
Method | HTTP request | Description

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

@@ -1145,7 +1145,9 @@ with ApiClient(configuration) as api_client:
"trigger" : {
"displayName" : "displayName",
"attributes" : {
"description" : "description",
"description" : "Triggered when an identity's manager attribute changes",
"formDefinitionId" : "Admin_Access_Request_Form",
"attributeToFilter" : "LifecycleState",
"id" : "idn:identity-attributes-changed",
"filter.$" : "$.changes[?(@.attribute == 'manager')]"
},

7
docs/tools/sdk/python/Reference/Beta/Models/AccessItemApproverDto.md
View File

@@ -11,15 +11,14 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemApproverDto', 'BetaAccessIt
# AccessItemApproverDto
Identity who approved the access item request.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity who approved the access item request. | [optional]
**id** | **str** | ID of identity who approved the access item request. | [optional]
**name** | **str** | Human-readable display name of identity who approved the access item request. | [optional]
**type** | **Enum** [ 'IDENTITY' ] | DTO type of the identity who approved the access item request. | [optional]
**id** | **str** | ID of the identity who approved the access item request. | [optional]
**name** | **str** | Name of the identity who approved the access item request. | [optional]
}
## Example

38
docs/tools/sdk/python/Reference/Beta/Models/AccessItemRequestedForDto1.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: beta-access-item-requested-for-dto1
title: AccessItemRequestedForDto1
pagination_label: AccessItemRequestedForDto1
sidebar_label: AccessItemRequestedForDto1
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessItemRequestedForDto1', 'BetaAccessItemRequestedForDto1']
slug: /tools/sdk/python/beta/models/access-item-requested-for-dto1
tags: ['SDK', 'Software Development Kit', 'AccessItemRequestedForDto1', 'BetaAccessItemRequestedForDto1']
---
# AccessItemRequestedForDto1
Identity whom the access item is requested for.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | DTO type of the identity whom the access item is requested for. | [optional]
**id** | **str** | ID of the identity whom the access item is requested for. | [optional]
**name** | **str** | Name of the identity whom the access item is requested for. | [optional]
}
## Example
```python
from sailpoint.beta.models.access_item_requested_for_dto1 import AccessItemRequestedForDto1
access_item_requested_for_dto1 = AccessItemRequestedForDto1(
type='IDENTITY',
id='2c4180a46faadee4016fb4e018c20626',
name='Robert Robinson'
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/Beta/Models/AccessItemRequesterDto1.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: beta-access-item-requester-dto1
title: AccessItemRequesterDto1
pagination_label: AccessItemRequesterDto1
sidebar_label: AccessItemRequesterDto1
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessItemRequesterDto1', 'BetaAccessItemRequesterDto1']
slug: /tools/sdk/python/beta/models/access-item-requester-dto1
tags: ['SDK', 'Software Development Kit', 'AccessItemRequesterDto1', 'BetaAccessItemRequesterDto1']
---
# AccessItemRequesterDto1
Access item requester's identity.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | Access item requester's DTO type. | [optional]
**id** | **str** | Access item requester's identity ID. | [optional]
**name** | **str** | Access item requester's name. | [optional]
}
## Example
```python
from sailpoint.beta.models.access_item_requester_dto1 import AccessItemRequesterDto1
access_item_requester_dto1 = AccessItemRequesterDto1(
type='IDENTITY',
id='2c7180a46faadee4016fb4e018c20648',
name='William Wilson'
)
```
[[Back to top]](#)

12
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestDynamicApprover.md
View File

@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApprover', 'BetaA
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_request_id** | **str** | The unique ID of the access request object. Can be used with the [access request status endpoint](https://developer.sailpoint.com/idn/api/beta/list-access-request-status) to get the status of the request. | [required]
**requested_for** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required]
**requested_items** | [**[]AccessRequestDynamicApproverRequestedItemsInner**](access-request-dynamic-approver-requested-items-inner) | The access items that are being requested. | [required]
**requested_by** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required]
**access_request_id** | **str** | Unique ID of the access request object. You can use this ID with the [Access Request Status endpoint](https://developer.sailpoint.com/idn/api/beta/list-access-request-status) to get the request's status. | [required]
**requested_for** | [**[]AccessItemRequestedForDto1**](access-item-requested-for-dto1) | Identities access was requested for. | [required]
**requested_items** | [**[]AccessRequestDynamicApproverRequestedItemsInner**](access-request-dynamic-approver-requested-items-inner) | Requested access items. | [required]
**requested_by** | [**AccessItemRequesterDto1**](access-item-requester-dto1) | | [required]
}
## Example
@@ -30,7 +30,7 @@ from sailpoint.beta.models.access_request_dynamic_approver import AccessRequestD
access_request_dynamic_approver = AccessRequestDynamicApprover(
access_request_id='4b4d982dddff4267ab12f0f1e72b5a6d',
requested_for=[
sailpoint.beta.models.access_item_requested_for_dto.AccessItemRequestedForDto(
sailpoint.beta.models.access_item_requested_for_dto_1.AccessItemRequestedForDto_1(
type = 'IDENTITY',
id = '2c4180a46faadee4016fb4e018c20626',
name = 'Robert Robinson', )
@@ -44,7 +44,7 @@ requested_items=[
operation = Add,
comment = 'William needs this access for his day to day job activities.', )
],
requested_by=sailpoint.beta.models.access_item_requester_dto.AccessItemRequesterDto(
requested_by=sailpoint.beta.models.access_item_requester_dto_1.AccessItemRequesterDto_1(
type = 'IDENTITY',
id = '2c7180a46faadee4016fb4e018c20648',
name = 'William Wilson', )

12
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestDynamicApproverRequestedItemsInner.md
View File

@@ -16,12 +16,12 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestDynamicApproverRequested
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique ID of the access item. | [required]
**name** | **str** | Human friendly name of the access item. | [required]
**description** | **str** | Extended description of the access item. | [optional]
**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of access item being requested. | [required]
**operation** | **Enum** [ 'Add', 'Remove' ] | Grant or revoke the access item | [required]
**comment** | **str** | A comment from the requestor on why the access is needed. | [optional]
**id** | **str** | Access item's unique identifier. | [required]
**name** | **str** | Access item's name. | [required]
**description** | **str** | Access item's extended description. | [optional]
**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | Type of access item being requested. | [required]
**operation** | **Enum** [ 'Add', 'Remove' ] | Action to perform on the requested access item. | [required]
**comment** | **str** | Comment from the requester about why the access is necessary. | [optional]
}
## Example

17
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPostApproval.md
View File

@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApproval', 'BetaAcce
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_request_id** | **str** | The unique ID of the access request. | [required]
**requested_for** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required]
**requested_items_status** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details on the outcome of each access item. | [required]
**requested_by** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required]
**access_request_id** | **str** | Access request's unique ID. | [required]
**requested_for** | [**[]AccessItemRequestedForDto1**](access-item-requested-for-dto1) | Identities whom access was requested for. | [required]
**requested_items_status** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details about the outcome of each requested access item. | [required]
**requested_by** | [**AccessItemRequesterDto1**](access-item-requester-dto1) | | [required]
}
## Example
@@ -30,7 +30,7 @@ from sailpoint.beta.models.access_request_post_approval import AccessRequestPost
access_request_post_approval = AccessRequestPostApproval(
access_request_id='2c91808b6ef1d43e016efba0ce470904',
requested_for=[
sailpoint.beta.models.access_item_requested_for_dto.AccessItemRequestedForDto(
sailpoint.beta.models.access_item_requested_for_dto_1.AccessItemRequestedForDto_1(
type = 'IDENTITY',
id = '2c4180a46faadee4016fb4e018c20626',
name = 'Robert Robinson', )
@@ -46,14 +46,13 @@ requested_items_status=[
client_metadata = {applicationName=My application},
approval_info = [
sailpoint.beta.models.access_request_post_approval_requested_items_status_inner_approval_info_inner.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner(
approval_comment = 'This access looks good. Approved.',
approval_comment = 'This access looks good. Approved.',
approval_decision = APPROVED,
approver_name = 'Stephen.Austin',
approver = sailpoint.beta.models.access_request_post_approval_requested_items_status_inner_approval_info_inner_approver.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner_approver(
type = IDENTITY, ), )
approver = null, )
], )
],
requested_by=sailpoint.beta.models.access_item_requester_dto.AccessItemRequesterDto(
requested_by=sailpoint.beta.models.access_item_requester_dto_1.AccessItemRequesterDto_1(
type = 'IDENTITY',
id = '2c7180a46faadee4016fb4e018c20648',
name = 'William Wilson', )

19
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInner.md
View File

@@ -16,14 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedIte
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique ID of the access item being requested. | [required]
**name** | **str** | The human friendly name of the access item. | [required]
**description** | **str** | Detailed description of the access item. | [optional]
**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of access item. | [required]
**operation** | **Enum** [ 'Add', 'Remove' ] | The action to perform on the access item. | [required]
**comment** | **str** | A comment from the identity requesting the access. | [optional]
**id** | **str** | Access item's unique ID. | [required]
**name** | **str** | Access item's name. | [required]
**description** | **str** | Access item's description. | [optional]
**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | Access item's type. | [required]
**operation** | **Enum** [ 'Add', 'Remove' ] | Action to perform on the requested access item. | [required]
**comment** | **str** | Comment from the identity requesting access. | [optional]
**client_metadata** | **map[string]object** | Additional customer defined metadata about the access item. | [optional]
**approval_info** | [**[]AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner**](access-request-post-approval-requested-items-status-inner-approval-info-inner) | A list of one or more approvers for the access request. | [required]
**approval_info** | [**[]AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner**](access-request-post-approval-requested-items-status-inner-approval-info-inner) | List of approvers for the access request. | [required]
}
## Example
@@ -41,11 +41,10 @@ comment='William needs this access to do his job.',
client_metadata={applicationName=My application},
approval_info=[
sailpoint.beta.models.access_request_post_approval_requested_items_status_inner_approval_info_inner.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner(
approval_comment = 'This access looks good. Approved.',
approval_comment = 'This access looks good. Approved.',
approval_decision = APPROVED,
approver_name = 'Stephen.Austin',
approver = sailpoint.beta.models.access_request_post_approval_requested_items_status_inner_approval_info_inner_approver.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner_approver(
type = IDENTITY, ), )
approver = null, )
]
)

16
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner.md
View File

@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedIte
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**approval_comment** | **str** | A comment left by the approver. | [optional]
**approval_decision** | **Enum** [ 'APPROVED', 'DENIED' ] | The final decision of the approver. | [required]
**approver_name** | **str** | The name of the approver | [required]
**approver** | [**AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover**](access-request-post-approval-requested-items-status-inner-approval-info-inner-approver) | | [required]
**approval_comment** | **str** | Approver's comment. | [optional]
**approval_decision** | **Enum** [ 'APPROVED', 'DENIED' ] | Approver's final decision. | [required]
**approver_name** | **str** | Approver's name. | [required]
**approver** | [**AccessItemApproverDto**](access-item-approver-dto) | Approver's identity. | [required]
}
## Example
@@ -28,11 +28,13 @@ Name | Type | Description | Notes
from sailpoint.beta.models.access_request_post_approval_requested_items_status_inner_approval_info_inner import AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner
access_request_post_approval_requested_items_status_inner_approval_info_inner = AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInner(
approval_comment='This access looks good. Approved.',
approval_comment='This access looks good. Approved.',
approval_decision=APPROVED,
approver_name='Stephen.Austin',
approver=sailpoint.beta.models.access_request_post_approval_requested_items_status_inner_approval_info_inner_approver.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner_approver(
type = IDENTITY, )
approver=sailpoint.beta.models.access_item_approver_dto.AccessItemApproverDto(
type = 'IDENTITY',
id = '2c3780a46faadee4016fb4e018c20652',
name = 'Allen Albertson', )
)
```

38
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover.md
View File

@@ -1,38 +0,0 @@
---
id: beta-access-request-post-approval-requested-items-status-inner-approval-info-inner-approver
title: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover
pagination_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover
sidebar_label: AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover', 'BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover']
slug: /tools/sdk/python/beta/models/access-request-post-approval-requested-items-status-inner-approval-info-inner-approver
tags: ['SDK', 'Software Development Kit', 'AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover', 'BetaAccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover']
---
# AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover
The identity of the approver.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | The type of object that is referenced | [required]
**id** | **str** | ID of identity who approved the access item request. | [required]
**name** | **str** | Human-readable display name of identity who approved the access item request. | [required]
}
## Example
```python
from sailpoint.beta.models.access_request_post_approval_requested_items_status_inner_approval_info_inner_approver import AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover
access_request_post_approval_requested_items_status_inner_approval_info_inner_approver = AccessRequestPostApprovalRequestedItemsStatusInnerApprovalInfoInnerApprover(
type=IDENTITY,
id='2c3780a46faadee4016fb4e018c20652',
name='Allen Albertson'
)
```
[[Back to top]](#)

12
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPreApproval.md
View File

@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApproval', 'BetaAcces
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_request_id** | **str** | The unique ID of the access request. | [required]
**requested_for** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required]
**requested_items** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details of the access items being requested. | [required]
**requested_by** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required]
**access_request_id** | **str** | Access request's unique ID. | [required]
**requested_for** | [**[]AccessItemRequestedForDto1**](access-item-requested-for-dto1) | Identities whom access was requested for. | [required]
**requested_items** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details about each requested access item. | [required]
**requested_by** | [**AccessItemRequesterDto1**](access-item-requester-dto1) | | [required]
}
## Example
@@ -30,7 +30,7 @@ from sailpoint.beta.models.access_request_pre_approval import AccessRequestPreAp
access_request_pre_approval = AccessRequestPreApproval(
access_request_id='2c91808b6ef1d43e016efba0ce470904',
requested_for=[
sailpoint.beta.models.access_item_requested_for_dto.AccessItemRequestedForDto(
sailpoint.beta.models.access_item_requested_for_dto_1.AccessItemRequestedForDto_1(
type = 'IDENTITY',
id = '2c4180a46faadee4016fb4e018c20626',
name = 'Robert Robinson', )
@@ -44,7 +44,7 @@ requested_items=[
operation = Add,
comment = 'William needs this access to do his job.', )
],
requested_by=sailpoint.beta.models.access_item_requester_dto.AccessItemRequesterDto(
requested_by=sailpoint.beta.models.access_item_requester_dto_1.AccessItemRequesterDto_1(
type = 'IDENTITY',
id = '2c7180a46faadee4016fb4e018c20648',
name = 'William Wilson', )

12
docs/tools/sdk/python/Reference/Beta/Models/AccessRequestPreApprovalRequestedItemsInner.md
View File

@@ -16,12 +16,12 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestPreApprovalRequestedItem
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique ID of the access item being requested. | [required]
**name** | **str** | The human friendly name of the access item. | [required]
**description** | **str** | Detailed description of the access item. | [optional]
**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | The type of access item. | [required]
**operation** | **Enum** [ 'Add', 'Remove' ] | The action to perform on the access item. | [required]
**comment** | **str** | A comment from the identity requesting the access. | [optional]
**id** | **str** | Access item's unique ID. | [required]
**name** | **str** | Access item's name. | [required]
**description** | **str** | Access item's description. | [optional]
**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | Access item's type. | [required]
**operation** | **Enum** [ 'Add', 'Remove' ] | Action to perform on the access item. | [required]
**comment** | **str** | Comment from the identity requesting access. | [optional]
}
## Example

10
docs/tools/sdk/python/Reference/Beta/Models/AccountAggregationCompleted.md
View File

@@ -17,11 +17,11 @@ tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompleted', 'BetaAc
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**source** | [**AccountAggregationCompletedSource**](account-aggregation-completed-source) | | [required]
**status** | **Enum** [ 'Success', 'Failed', 'Terminated' ] | The overall status of the aggregation. | [required]
**started** | **datetime** | The date and time when the account aggregation started. | [required]
**completed** | **datetime** | The date and time when the account aggregation finished. | [required]
**errors** | **[]str** | A list of errors that occurred during the aggregation. | [required]
**warnings** | **[]str** | A list of warnings that occurred during the aggregation. | [required]
**status** | **Enum** [ 'Success', 'Failed', 'Terminated' ] | Aggregation's overall status. | [required]
**started** | **datetime** | Date and time when the account aggregation started. | [required]
**completed** | **datetime** | Date and time when the account aggregation finished. | [required]
**errors** | **[]str** | List of errors that occurred during the aggregation. | [required]
**warnings** | **[]str** | List of warnings that occurred during the aggregation. | [required]
**stats** | [**AccountAggregationCompletedStats**](account-aggregation-completed-stats) | | [required]
}

8
docs/tools/sdk/python/Reference/Beta/Models/AccountAggregationCompletedSource.md
View File

@@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'AccountAggregationCompletedSource', '
# AccountAggregationCompletedSource
The source the accounts are being aggregated from.
Source ISC is aggregating accounts from.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'SOURCE' ] | The DTO type of the source the accounts are being aggregated from. | [required]
**id** | **str** | The ID of the source the accounts are being aggregated from. | [required]
**name** | **str** | Display name of the source the accounts are being aggregated from. | [required]
**type** | **Enum** [ 'SOURCE' ] | Source's DTO type. | [required]
**id** | **str** | Source's unique ID. | [required]
**name** | **str** | Source's name. | [required]
}
## Example

10
docs/tools/sdk/python/Reference/Beta/Models/AccountAggregationCompletedStats.md
View File

@@ -17,11 +17,11 @@ Overall statistics about the account aggregation.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**scanned** | **int** | The number of accounts which were scanned / iterated over. | [required]
**unchanged** | **int** | The number of accounts which existed before, but had no changes. | [required]
**changed** | **int** | The number of accounts which existed before, but had changes. | [required]
**added** | **int** | The number of accounts which are new - have not existed before. | [required]
**removed** | **int** | The number accounts which existed before, but no longer exist (thus getting removed). | [required]
**scanned** | **int** | Number of accounts scanned/iterated over. | [required]
**unchanged** | **int** | Number of accounts that existed before but had no changes. | [required]
**changed** | **int** | Number of accounts that existed before but had changes. | [required]
**added** | **int** | Number of accounts that are new and didn't previously exist. | [required]
**removed** | **int** | Number accounts that existed before but were removed and no longer exist. | [required]
}
## Example

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

@@ -35,8 +35,8 @@ campaign=sailpoint.beta.models.campaign_activated_campaign.CampaignActivated_cam
type = MANAGER,
campaign_owner = sailpoint.beta.models.campaign_activated_campaign_campaign_owner.CampaignActivated_campaign_campaignOwner(
id = '37f080867702c1910177031320c40n27',
display_name = 'John Snow',
email = 'john.snow@example.com', ),
display_name = 'Albert Albertson',
email = 'albert.albertson@example.com', ),
status = ACTIVE, )
)

20
docs/tools/sdk/python/Reference/Beta/Models/CampaignActivatedCampaign.md
View File

@@ -17,15 +17,15 @@ Details about the certification campaign that was activated.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Unique ID for the campaign. | [required]
**name** | **str** | The human friendly name of the campaign. | [required]
**description** | **str** | Extended description of the campaign. | [required]
**created** | **datetime** | The date and time the campaign was created. | [required]
**modified** | **datetime** | The date and time the campaign was last modified. | [optional]
**deadline** | **datetime** | The date and time the campaign is due. | [required]
**type** | **Enum** [ 'MANAGER', 'SOURCE_OWNER', 'SEARCH', 'ROLE_COMPOSITION' ] | The type of campaign. | [required]
**id** | **str** | Campaign's unique ID. | [required]
**name** | **str** | Campaign's name. | [required]
**description** | **str** | Campaign's extended description. | [required]
**created** | **datetime** | Date and time when the campaign was created. | [required]
**modified** | **datetime** | Date and time when the campaign was last modified. | [optional]
**deadline** | **datetime** | Date and time when the campaign is due. | [required]
**type** | **Enum** [ 'MANAGER', 'SOURCE_OWNER', 'SEARCH', 'ROLE_COMPOSITION' ] | Campaign's type. | [required]
**campaign_owner** | [**CampaignActivatedCampaignCampaignOwner**](campaign-activated-campaign-campaign-owner) | | [required]
**status** | **Enum** [ 'ACTIVE' ] | The current status of the campaign. | [required]
**status** | **Enum** [ 'ACTIVE' ] | Campaign's current status. | [required]
}
## Example
@@ -43,8 +43,8 @@ deadline='2021-03-16T03:04:45.815Z',
type=MANAGER,
campaign_owner=sailpoint.beta.models.campaign_activated_campaign_campaign_owner.CampaignActivated_campaign_campaignOwner(
id = '37f080867702c1910177031320c40n27',
display_name = 'John Snow',
email = 'john.snow@example.com', ),
display_name = 'Albert Albertson',
email = 'albert.albertson@example.com', ),
status=ACTIVE
)

12
docs/tools/sdk/python/Reference/Beta/Models/CampaignActivatedCampaignCampaignOwner.md
View File

@@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'CampaignActivatedCampaignCampaignOwne
# CampaignActivatedCampaignCampaignOwner
Details of the identity that owns the campaign.
Details of the identity who owns the campaign.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique ID of the identity. | [required]
**display_name** | **str** | The human friendly name of the identity. | [required]
**email** | **str** | The primary email address of the identity. | [required]
**id** | **str** | Identity's unique ID. | [required]
**display_name** | **str** | Identity's name. | [required]
**email** | **str** | Identity's primary email address. | [required]
}
## Example
@@ -29,8 +29,8 @@ from sailpoint.beta.models.campaign_activated_campaign_campaign_owner import Cam
campaign_activated_campaign_campaign_owner = CampaignActivatedCampaignCampaignOwner(
id='37f080867702c1910177031320c40n27',
display_name='John Snow',
email='john.snow@example.com'
display_name='Albert Albertson',
email='albert.albertson@example.com'
)
```

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

@@ -35,8 +35,8 @@ campaign=sailpoint.beta.models.campaign_ended_campaign.CampaignEnded_campaign(
type = MANAGER,
campaign_owner = sailpoint.beta.models.campaign_activated_campaign_campaign_owner.CampaignActivated_campaign_campaignOwner(
id = '37f080867702c1910177031320c40n27',
display_name = 'John Snow',
email = 'john.snow@example.com', ),
display_name = 'Albert Albertson',
email = 'albert.albertson@example.com', ),
status = COMPLETED, )
)

20
docs/tools/sdk/python/Reference/Beta/Models/CampaignEndedCampaign.md
View File

@@ -17,15 +17,15 @@ Details about the certification campaign that ended.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Unique ID for the campaign. | [required]
**name** | **str** | The human friendly name of the campaign. | [required]
**description** | **str** | Extended description of the campaign. | [required]
**created** | **datetime** | The date and time the campaign was created. | [required]
**modified** | **datetime** | The date and time the campaign was last modified. | [optional]
**deadline** | **datetime** | The date and time the campaign is due. | [required]
**type** | **Enum** [ 'MANAGER', 'SOURCE_OWNER', 'SEARCH', 'ROLE_COMPOSITION' ] | The type of campaign. | [required]
**id** | **str** | Campaign's unique ID for the campaign. | [required]
**name** | **str** | Campaign's unique ID. | [required]
**description** | **str** | Campaign's extended description. | [required]
**created** | **datetime** | Date and time when the campaign was created. | [required]
**modified** | **datetime** | Date and time when the campaign was last modified. | [optional]
**deadline** | **datetime** | Date and time when the campaign is due. | [required]
**type** | **Enum** [ 'MANAGER', 'SOURCE_OWNER', 'SEARCH', 'ROLE_COMPOSITION' ] | Campaign's type. | [required]
**campaign_owner** | [**CampaignActivatedCampaignCampaignOwner**](campaign-activated-campaign-campaign-owner) | | [required]
**status** | **Enum** [ 'COMPLETED' ] | The current status of the campaign. | [required]
**status** | **Enum** [ 'COMPLETED' ] | Campaign's current status. | [required]
}
## Example
@@ -43,8 +43,8 @@ deadline='2021-03-16T03:04:45.815Z',
type=MANAGER,
campaign_owner=sailpoint.beta.models.campaign_activated_campaign_campaign_owner.CampaignActivated_campaign_campaignOwner(
id = '37f080867702c1910177031320c40n27',
display_name = 'John Snow',
email = 'john.snow@example.com', ),
display_name = 'Albert Albertson',
email = 'albert.albertson@example.com', ),
status=COMPLETED
)

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

@@ -35,8 +35,8 @@ campaign=sailpoint.beta.models.campaign_generated_campaign.CampaignGenerated_cam
type = MANAGER,
campaign_owner = sailpoint.beta.models.campaign_generated_campaign_campaign_owner.CampaignGenerated_campaign_campaignOwner(
id = '37f080867702c1910177031320c40n27',
display_name = 'John Snow',
email = 'john.snow@example.com', ),
display_name = 'Albert Albertson',
email = 'albert.albertson@example.com', ),
status = STAGED, )
)

20
docs/tools/sdk/python/Reference/Beta/Models/CampaignGeneratedCampaign.md
View File

@@ -17,15 +17,15 @@ Details about the campaign that was generated.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique ID of the campaign. | [required]
**name** | **str** | Human friendly name of the campaign. | [required]
**description** | **str** | Extended description of the campaign. | [required]
**created** | **datetime** | The date and time the campaign was created. | [required]
**modified** | **str** | The date and time the campaign was last modified. | [optional]
**deadline** | **str** | The date and time when the campaign must be finished by. | [optional]
**type** | **Enum** [ 'MANAGER', 'SOURCE_OWNER', 'SEARCH', 'ROLE_COMPOSITION' ] | The type of campaign that was generated. | [required]
**id** | **str** | Campaign's unique ID. | [required]
**name** | **str** | Campaign's name. | [required]
**description** | **str** | Campaign's extended description. | [required]
**created** | **datetime** | Date and time when the campaign was created. | [required]
**modified** | **str** | Date and time when the campaign was last modified. | [optional]
**deadline** | **str** | Date and time when the campaign must be finished. | [optional]
**type** | **Enum** [ 'MANAGER', 'SOURCE_OWNER', 'SEARCH', 'ROLE_COMPOSITION' ] | Campaign's type. | [required]
**campaign_owner** | [**CampaignGeneratedCampaignCampaignOwner**](campaign-generated-campaign-campaign-owner) | | [required]
**status** | **Enum** [ 'STAGED', 'ACTIVATING', 'ACTIVE' ] | The current status of the campaign. | [required]
**status** | **Enum** [ 'STAGED', 'ACTIVATING', 'ACTIVE' ] | Campaign's current status. | [required]
}
## Example
@@ -43,8 +43,8 @@ deadline='2021-02-18T03:04:45.815Z',
type=MANAGER,
campaign_owner=sailpoint.beta.models.campaign_generated_campaign_campaign_owner.CampaignGenerated_campaign_campaignOwner(
id = '37f080867702c1910177031320c40n27',
display_name = 'John Snow',
email = 'john.snow@example.com', ),
display_name = 'Albert Albertson',
email = 'albert.albertson@example.com', ),
status=STAGED
)

12
docs/tools/sdk/python/Reference/Beta/Models/CampaignGeneratedCampaignCampaignOwner.md
View File

@@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'CampaignGeneratedCampaignCampaignOwne
# CampaignGeneratedCampaignCampaignOwner
The identity that owns the campaign.
Identity who owns the campaign.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique ID of the identity. | [required]
**display_name** | **str** | The display name of the identity. | [required]
**email** | **str** | The primary email address of the identity. | [required]
**id** | **str** | Identity's unique ID. | [required]
**display_name** | **str** | Identity's name. | [required]
**email** | **str** | Identity's primary email address. | [required]
}
## Example
@@ -29,8 +29,8 @@ from sailpoint.beta.models.campaign_generated_campaign_campaign_owner import Cam
campaign_generated_campaign_campaign_owner = CampaignGeneratedCampaignCampaignOwner(
id='37f080867702c1910177031320c40n27',
display_name='John Snow',
email='john.snow@example.com'
display_name='Albert Albertson',
email='albert.albertson@example.com'
)
```

18
docs/tools/sdk/python/Reference/Beta/Models/CertificationDto.md
View File

@@ -18,17 +18,17 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**campaign_ref** | [**CampaignReference**](campaign-reference) | | [required]
**phase** | [**CertificationPhase**](certification-phase) | | [required]
**due** | **datetime** | The due date of the certification. | [required]
**signed** | **datetime** | The date the reviewer signed off on the certification. | [required]
**due** | **datetime** | Date and time when the certification is due. | [required]
**signed** | **datetime** | Date and time when the reviewer signed off on the certification. | [required]
**reviewer** | [**Reviewer**](reviewer) | | [required]
**reassignment** | [**Reassignment**](reassignment) | | [optional]
**has_errors** | **bool** | Indicates it the certification has any errors. | [required]
**error_message** | **str** | A message indicating what the error is. | [optional]
**completed** | **bool** | Indicates if all certification decisions have been made. | [required]
**decisions_made** | **int** | The number of approve/revoke/acknowledge decisions that have been made by the reviewer. | [required]
**decisions_total** | **int** | The total number of approve/revoke/acknowledge decisions for the certification. | [required]
**entities_completed** | **int** | The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. | [required]
**entities_total** | **int** | The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | [required]
**has_errors** | **bool** | Indicates whether the certification has any errors. | [required]
**error_message** | **str** | Message indicating what the error is. | [optional]
**completed** | **bool** | Indicates whether all certification decisions have been made. | [required]
**decisions_made** | **int** | Number of approve/revoke/acknowledge decisions the reviewer has made. | [required]
**decisions_total** | **int** | Total number of approve/revoke/acknowledge decisions for the certification. | [required]
**entities_completed** | **int** | Number of entities (identities, access profiles, roles, etc.) that are complete and all decisions have been made for. | [required]
**entities_total** | **int** | Total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | [required]
}
## Example

28
docs/tools/sdk/python/Reference/Beta/Models/CertificationSignedOffCertification.md
View File

@@ -11,29 +11,29 @@ tags: ['SDK', 'Software Development Kit', 'CertificationSignedOffCertification',
# CertificationSignedOffCertification
The certification campaign that was signed off on.
Certification campaign that was signed off on.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Unique ID of the certification. | [required]
**name** | **str** | The name of the certification. | [required]
**created** | **datetime** | The date and time the certification was created. | [required]
**modified** | **datetime** | The date and time the certification was last modified. | [optional]
**id** | **str** | Certification's unique ID. | [required]
**name** | **str** | Certification's name. | [required]
**created** | **datetime** | Date and time when the certification was created. | [required]
**modified** | **datetime** | Date and time when the certification was last modified. | [optional]
**campaign_ref** | [**CampaignReference**](campaign-reference) | | [required]
**phase** | [**CertificationPhase**](certification-phase) | | [required]
**due** | **datetime** | The due date of the certification. | [required]
**signed** | **datetime** | The date the reviewer signed off on the certification. | [required]
**due** | **datetime** | Date and time when the certification is due. | [required]
**signed** | **datetime** | Date and time when the reviewer signed off on the certification. | [required]
**reviewer** | [**Reviewer**](reviewer) | | [required]
**reassignment** | [**Reassignment**](reassignment) | | [optional]
**has_errors** | **bool** | Indicates it the certification has any errors. | [required]
**error_message** | **str** | A message indicating what the error is. | [optional]
**completed** | **bool** | Indicates if all certification decisions have been made. | [required]
**decisions_made** | **int** | The number of approve/revoke/acknowledge decisions that have been made by the reviewer. | [required]
**decisions_total** | **int** | The total number of approve/revoke/acknowledge decisions for the certification. | [required]
**entities_completed** | **int** | The number of entities (identities, access profiles, roles, etc.) for which all decisions have been made and are complete. | [required]
**entities_total** | **int** | The total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | [required]
**has_errors** | **bool** | Indicates whether the certification has any errors. | [required]
**error_message** | **str** | Message indicating what the error is. | [optional]
**completed** | **bool** | Indicates whether all certification decisions have been made. | [required]
**decisions_made** | **int** | Number of approve/revoke/acknowledge decisions the reviewer has made. | [required]
**decisions_total** | **int** | Total number of approve/revoke/acknowledge decisions for the certification. | [required]
**entities_completed** | **int** | Number of entities (identities, access profiles, roles, etc.) that are complete and all decisions have been made for. | [required]
**entities_total** | **int** | Total number of entities (identities, access profiles, roles, etc.) in the certification, both complete and incomplete. | [required]
}
## Example

6
docs/tools/sdk/python/Reference/Beta/Models/EventAttributes.md
View File

@@ -20,6 +20,8 @@ Name | Type | Description | Notes
**id** | **str** | The unique ID of the trigger | [required]
**filter_** | **str** | JSON path expression that will limit which events the trigger will fire on | [optional]
**description** | **str** | Description of the event trigger | [optional]
**attribute_to_filter** | **str** | The attribute to filter on | [optional]
**form_definition_id** | **str** | Form definition's unique identifier. | [optional]
}
## Example
@@ -30,7 +32,9 @@ from sailpoint.beta.models.event_attributes import EventAttributes
event_attributes = EventAttributes(
id='idn:identity-attributes-changed',
filter_='$.changes[?(@.attribute == 'manager')]',
description=''
description='Triggered when an identity's manager attribute changes',
attribute_to_filter='LifecycleState',
form_definition_id='Admin_Access_Request_Form'
)
```

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

@@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChanged', 'BetaIden
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identity** | [**IdentityAttributesChangedIdentity**](identity-attributes-changed-identity) | | [required]
**changes** | [**[]IdentityAttributesChangedChangesInner**](identity-attributes-changed-changes-inner) | A list of one or more identity attributes that changed on the identity. | [required]
**changes** | [**[]IdentityAttributesChangedChangesInner**](identity-attributes-changed-changes-inner) | List of identity's attributes that changed. | [required]
}
## Example

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

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInner
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attribute** | **str** | The name of the identity attribute that changed. | [required]
**attribute** | **str** | Identity attribute's name. | [required]
**old_value** | [**IdentityAttributesChangedChangesInnerOldValue**](identity-attributes-changed-changes-inner-old-value) | | [optional]
**new_value** | [**IdentityAttributesChangedChangesInnerNewValue**](identity-attributes-changed-changes-inner-new-value) | | [optional]
}

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

@@ -11,7 +11,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInner
# IdentityAttributesChangedChangesInnerNewValue
The value of the identity attribute after it changed.
Identity attribute's new value after the change.
## Properties

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

@@ -11,7 +11,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributesChangedChangesInner
# IdentityAttributesChangedChangesInnerOldValue
The value of the identity attribute before it changed.
Identity attribute's previous value before the change.
## Properties

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

@@ -19,7 +19,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity whose attributes changed. | [required]
**id** | **str** | ID of identity whose attributes changed. | [required]
**name** | **str** | Display name of identity whose attributes changed. | [required]
**name** | **str** | Name of identity whose attributes changed. | [required]
}
## Example

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

@@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityCreated', 'BetaIdentityCreate
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identity** | [**IdentityCreatedIdentity**](identity-created-identity) | | [required]
**attributes** | **map[string]object** | The attributes assigned to the identity. Attributes are determined by the identity profile. | [required]
**attributes** | **map[string]object** | Attributes assigned to the identity. These attributes are determined by the identity profile. | [required]
}
## Example

6
docs/tools/sdk/python/Reference/Beta/Models/IdentityCreatedIdentity.md
View File

@@ -17,9 +17,9 @@ Created identity.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | Created identity's DTO type. | [required]
**id** | **str** | Created identity ID. | [required]
**name** | **str** | Created identity's display name. | [required]
**type** | **Enum** [ 'IDENTITY' ] | Identity's DTO type. | [required]
**id** | **str** | Identity's unique ID. | [required]
**name** | **str** | Identity's name. | [required]
}
## Example

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

@@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityDeleted', 'BetaIdentityDelete
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identity** | [**IdentityDeletedIdentity**](identity-deleted-identity) | | [required]
**attributes** | **map[string]object** | The attributes assigned to the identity. Attributes are determined by the identity profile. | [required]
**attributes** | **map[string]object** | Identity attributes. The attributes are determined by the identity profile. | [required]
}
## Example

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

@@ -19,7 +19,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | Deleted identity's DTO type. | [required]
**id** | **str** | Deleted identity ID. | [required]
**name** | **str** | Deleted identity's display name. | [required]
**name** | **str** | Deleted identity's name. | [required]
}
## Example

18
docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCompleted.md
View File

@@ -16,14 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCompleted', 'BetaProvisio
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**tracking_number** | **str** | The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. | [required]
**sources** | **str** | One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. | [required]
**action** | **str** | Origin of where the provisioning request came from. | [optional]
**errors** | **[]str** | A list of any accumulated error messages that occurred during provisioning. | [optional]
**warnings** | **[]str** | A list of any accumulated warning messages that occurred during provisioning. | [optional]
**tracking_number** | **str** | Provisioning request's reference number. Useful for tracking status in the 'Account Activity' search interface. | [required]
**sources** | **str** | Sources the provisioning transactions were performed on. Sources are comma separated. | [required]
**action** | **str** | Origin of the provisioning request. | [optional]
**errors** | **[]str** | List of any accumulated error messages that occurred during provisioning. | [optional]
**warnings** | **[]str** | List of any accumulated warning messages that occurred during provisioning. | [optional]
**recipient** | [**ProvisioningCompletedRecipient**](provisioning-completed-recipient) | | [required]
**requester** | [**ProvisioningCompletedRequester**](provisioning-completed-requester) | | [optional]
**account_requests** | [**[]ProvisioningCompletedAccountRequestsInner**](provisioning-completed-account-requests-inner) | A list of provisioning instructions to perform on an account-by-account basis. | [required]
**account_requests** | [**[]ProvisioningCompletedAccountRequestsInner**](provisioning-completed-account-requests-inner) | List of provisioning instructions to perform on an account-by-account basis. | [required]
}
## Example
@@ -55,7 +55,7 @@ account_requests=[
id = '4e4d982dddff4267ab12f0f1e72b5a6d',
type = 'SOURCE',
name = 'Corporate Active Directory', ),
account_id = 'CN=Chewy.Bacca,ou=hardcorefigter,ou=wookies,dc=starwars,dc=com',
account_id = 'CN=Rob.Robertson,ou=csm,ou=sales,dc=helpco,dc=com',
account_operation = 'Modify',
provisioning_result = SUCCESS,
provisioning_target = 'Corp AD',
@@ -63,8 +63,8 @@ account_requests=[
attribute_requests = [
sailpoint.beta.models.provisioning_completed_account_requests_inner_attribute_requests_inner.ProvisioningCompleted_accountRequests_inner_attributeRequests_inner(
attribute_name = 'memberOf',
attribute_value = 'CN=jedi,DC=starwars,DC=com',
operation = Add, )
attribute_value = 'CN=sales,DC=helpco,DC=com',
operation = 'Add', )
], )
]
)

18
docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInner.md
View File

@@ -17,12 +17,12 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsI
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**source** | [**ProvisioningCompletedAccountRequestsInnerSource**](provisioning-completed-account-requests-inner-source) | | [required]
**account_id** | **str** | The unique idenfier of the account being provisioned. | [optional]
**account_operation** | **str** | The provisioning operation; typically Create, Modify, Enable, Disable, Unlock, or Delete. | [required]
**provisioning_result** | **Enum** [ 'SUCCESS', 'PENDING', 'FAILED' ] | The overall result of the provisioning transaction; this could be success, pending, failed, etc. | [required]
**provisioning_target** | **str** | The name of the provisioning channel selected; this could be the same as the source, or could be a Service Desk Integration Module (SDIM). | [required]
**ticket_id** | **str** | A reference to a tracking number, if this is sent to a Service Desk Integration Module (SDIM). | [optional]
**attribute_requests** | [**[]ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner**](provisioning-completed-account-requests-inner-attribute-requests-inner) | A list of attributes as part of the provisioning transaction. | [optional]
**account_id** | **str** | Unique idenfier of the account being provisioned. | [optional]
**account_operation** | **Enum** [ 'Create', 'Modify', 'Enable', 'Disable', 'Unlock', 'Delete' ] | Provisioning operation. | [required]
**provisioning_result** | **Enum** [ 'SUCCESS', 'PENDING', 'FAILED' ] | Overall result of the provisioning transaction. | [required]
**provisioning_target** | **str** | Nme of the selected provisioning channel selected. This could be the same as the source, or it could be a Service Desk Integration Module (SDIM). | [required]
**ticket_id** | **str** | Reference to a tracking number for if this is sent to a SDIM. | [optional]
**attribute_requests** | [**[]ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner**](provisioning-completed-account-requests-inner-attribute-requests-inner) | List of attributes to include in the provisioning transaction. | [optional]
}
## Example
@@ -35,7 +35,7 @@ source=sailpoint.beta.models.provisioning_completed_account_requests_inner_sourc
id = '4e4d982dddff4267ab12f0f1e72b5a6d',
type = 'SOURCE',
name = 'Corporate Active Directory', ),
account_id='CN=Chewy.Bacca,ou=hardcorefigter,ou=wookies,dc=starwars,dc=com',
account_id='CN=Rob.Robertson,ou=csm,ou=sales,dc=helpco,dc=com',
account_operation='Modify',
provisioning_result=SUCCESS,
provisioning_target='Corp AD',
@@ -43,8 +43,8 @@ ticket_id='72619262',
attribute_requests=[
sailpoint.beta.models.provisioning_completed_account_requests_inner_attribute_requests_inner.ProvisioningCompleted_accountRequests_inner_attributeRequests_inner(
attribute_name = 'memberOf',
attribute_value = 'CN=jedi,DC=starwars,DC=com',
operation = Add, )
attribute_value = 'CN=sales,DC=helpco,DC=com',
operation = 'Add', )
]
)

8
docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner.md
View File

@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsI
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attribute_name** | **str** | The name of the attribute being provisioned. | [required]
**attribute_value** | **str** | The value of the attribute being provisioned. | [optional]
**attribute_name** | **str** | Name of the attribute being provisioned. | [required]
**attribute_value** | **str** | Value of the attribute being provisioned. | [optional]
**operation** | **Enum** [ 'Add', 'Set', 'Remove' ] | The operation to handle the attribute. | [required]
}
@@ -28,8 +28,8 @@ from sailpoint.beta.models.provisioning_completed_account_requests_inner_attribu
provisioning_completed_account_requests_inner_attribute_requests_inner = ProvisioningCompletedAccountRequestsInnerAttributeRequestsInner(
attribute_name='memberOf',
attribute_value='CN=jedi,DC=starwars,DC=com',
operation=Add
attribute_value='CN=sales,DC=helpco,DC=com',
operation='Add'
)
```

8
docs/tools/sdk/python/Reference/Beta/Models/ProvisioningCompletedAccountRequestsInnerSource.md
View File

@@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'ProvisioningCompletedAccountRequestsI
# ProvisioningCompletedAccountRequestsInnerSource
Reference to the source being provisioned against.
Source that ISC is provisioning access on.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | ID of the object to which this reference applies | [required]
**type** | **Enum** [ 'SOURCE' ] | The type of object that is referenced | [required]
**name** | **str** | Human-readable display name of the object to which this reference applies | [required]
**id** | **str** | Source ID. | [required]
**type** | **Enum** [ 'SOURCE' ] | Source DTO type. | [required]
**name** | **str** | Source name. | [required]
}
## Example

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

@@ -19,7 +19,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | Provisioning recipient DTO type. | [required]
**id** | **str** | Provisioning recipient's identity ID. | [required]
**name** | **str** | Provisioning recipient's display name. | [required]
**name** | **str** | Provisioning recipient's name. | [required]
}
## Example

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

@@ -19,7 +19,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | Provisioning requester's DTO type. | [required]
**id** | **str** | Provisioning requester's identity ID. | [required]
**name** | **str** | Provisioning owner's human-readable display name. | [required]
**name** | **str** | Provisioning requester's name. | [required]
}
## Example

10
docs/tools/sdk/python/Reference/Beta/Models/Reviewer.md
View File

@@ -11,16 +11,16 @@ tags: ['SDK', 'Software Development Kit', 'Reviewer', 'BetaReviewer']
# Reviewer
Details of the reviewer for certification.
Details of the reviewer for a certification.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY', 'GOVERNANCE_GROUP' ] | The reviewer's DTO type. | [required]
**id** | **str** | The reviewer's ID. | [required]
**name** | **str** | The reviewer's display name. | [required]
**email** | **str** | The reviewing identity's email. Only applicable to `IDENTITY`. | [optional]
**type** | **Enum** [ 'IDENTITY', 'GOVERNANCE_GROUP' ] | Reviewer's DTO type. | [required]
**id** | **str** | Reviewer's ID. | [required]
**name** | **str** | Reviewer's display name. | [required]
**email** | **str** | Reviewing identity's email. This is only applicable to reviewers of the `IDENTITY` type. | [optional]
}
## Example

10
docs/tools/sdk/python/Reference/Beta/Models/SavedSearchComplete.md
View File

@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'SavedSearchComplete', 'BetaSavedSearc
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**file_name** | **str** | A name for the report file. | [required]
**owner_email** | **str** | The email address of the identity that owns the saved search. | [required]
**owner_name** | **str** | The name of the identity that owns the saved search. | [required]
**query** | **str** | The search query that was used to generate the report. | [required]
**search_name** | **str** | The name of the saved search. | [required]
**file_name** | **str** | Report file name. | [required]
**owner_email** | **str** | Email address of the identity who owns the saved search. | [required]
**owner_name** | **str** | Name of the identity who owns the saved search. | [required]
**query** | **str** | Search query used to generate the report. | [required]
**search_name** | **str** | Saved search name. | [required]
**search_results** | [**SavedSearchCompleteSearchResults**](saved-search-complete-search-results) | | [required]
**signed_s3_url** | **str** | The Amazon S3 URL to download the report from. | [required]
}

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

@@ -11,7 +11,7 @@ tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResults', 'B
# SavedSearchCompleteSearchResults
A preview of the search results for each object type. This includes a count as well as headers, and the first several rows of data, per object type.
Preview of the search results for each object type. This includes a count as well as headers and the first several rows of data, per object type.
## Properties

8
docs/tools/sdk/python/Reference/Beta/Models/SavedSearchCompleteSearchResultsAccount.md
View File

@@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsAccou
# SavedSearchCompleteSearchResultsAccount
A table of accounts that match the search criteria.
Table of accounts matching the search criteria.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**count** | **str** | The number of rows in the table. | [required]
**noun** | **str** | The type of object represented in the table. | [required]
**preview** | **[]List[str]** | A sample of the data in the table. | [required]
**count** | **str** | Number of rows in the table. | [required]
**noun** | **str** | Type of object represented in the table. | [required]
**preview** | **[]List[str]** | Sample of table data. | [required]
}
## Example

8
docs/tools/sdk/python/Reference/Beta/Models/SavedSearchCompleteSearchResultsEntitlement.md
View File

@@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsEntit
# SavedSearchCompleteSearchResultsEntitlement
A table of entitlements that match the search criteria.
Table of entitlements matching the search criteria.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**count** | **str** | The number of rows in the table. | [required]
**noun** | **str** | The type of object represented in the table. | [required]
**preview** | **[]List[str]** | A sample of the data in the table. | [required]
**count** | **str** | Number of rows in the table. | [required]
**noun** | **str** | Type of object represented in the table. | [required]
**preview** | **[]List[str]** | Sample of table data. | [required]
}
## Example

8
docs/tools/sdk/python/Reference/Beta/Models/SavedSearchCompleteSearchResultsIdentity.md
View File

@@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'SavedSearchCompleteSearchResultsIdent
# SavedSearchCompleteSearchResultsIdentity
A table of identities that match the search criteria.
Table of identities matching the search criteria.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**count** | **str** | The number of rows in the table. | [required]
**noun** | **str** | The type of object represented in the table. | [required]
**preview** | **[]List[str]** | A sample of the data in the table. | [required]
**count** | **str** | Number of rows in the table. | [required]
**noun** | **str** | Type of object represented in the table. | [required]
**preview** | **[]List[str]** | Sample of the table data. | [required]
}
## Example

6
docs/tools/sdk/python/Reference/Beta/Models/ScheduledAttributes.md
View File

@@ -19,9 +19,10 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**frequency** | **Enum** [ 'daily', 'weekly', 'monthly', 'yearly', 'cronSchedule' ] | Frequency of execution | [required]
**time_zone** | **str** | Time zone identifier | [optional]
**cron_string** | **str** | | [optional]
**cron_string** | **str** | A valid CRON expression | [optional]
**weekly_days** | **[]str** | Scheduled days of the week for execution | [optional]
**weekly_times** | **[]str** | Scheduled execution times | [optional]
**yearly_times** | **[]str** | Scheduled execution times | [optional]
}
## Example
@@ -34,7 +35,8 @@ frequency='daily',
time_zone='America/Chicago',
cron_string='0 9 * * 1',
weekly_days=Monday,
weekly_times=Monday
weekly_times=Monday,
yearly_times=1969-12-31T09:00:00.000Z
)
```

14
docs/tools/sdk/python/Reference/Beta/Models/SourceAccountCreated.md
View File

@@ -16,14 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'SourceAccountCreated', 'BetaSourceAcc
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**uuid** | **str** | Source unique identifier for the identity. UUID is generated by the source system. | [optional]
**uuid** | **str** | Identity's universal unique identifier (UUID) on the source. The source system generates the UUID. | [required]
**id** | **str** | SailPoint generated unique identifier. | [required]
**native_identifier** | **str** | Unique ID of the account on the source. | [required]
**source_id** | **str** | The ID of the source. | [required]
**source_name** | **str** | The name of the source. | [required]
**identity_id** | **str** | The ID of the identity that is correlated with this account. | [required]
**identity_name** | **str** | The name of the identity that is correlated with this account. | [required]
**attributes** | **map[string]object** | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required]
**native_identifier** | **str** | Account's unique ID on the source. | [required]
**source_id** | **str** | Source ID. | [required]
**source_name** | **str** | Source name. | [required]
**identity_id** | **str** | ID of the identity correlated with the account. | [required]
**identity_name** | **str** | Name of the identity correlated with the account. | [required]
**attributes** | **map[string]object** | Account attributes. The attributes' contents depend on the source's account schema. | [required]
}
## Example

14
docs/tools/sdk/python/Reference/Beta/Models/SourceAccountDeleted.md
View File

@@ -16,14 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'SourceAccountDeleted', 'BetaSourceAcc
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**uuid** | **str** | Source unique identifier for the identity. UUID is generated by the source system. | [optional]
**uuid** | **str** | Identity's universal unique identifier (UUID) on the source. The source system generates the UUID. | [required]
**id** | **str** | SailPoint generated unique identifier. | [required]
**native_identifier** | **str** | Unique ID of the account on the source. | [required]
**source_id** | **str** | The ID of the source. | [required]
**source_name** | **str** | The name of the source. | [required]
**identity_id** | **str** | The ID of the identity that is correlated with this account. | [required]
**identity_name** | **str** | The name of the identity that is correlated with this account. | [required]
**attributes** | **map[string]object** | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required]
**native_identifier** | **str** | Account's unique ID on the source. | [required]
**source_id** | **str** | Source ID. | [required]
**source_name** | **str** | Source name. | [required]
**identity_id** | **str** | ID of the identity correlated with the account. | [required]
**identity_name** | **str** | Name of the identity correlated with the account. | [required]
**attributes** | **map[string]object** | Account attributes. The attributes' contents depend on the source's account schema. | [required]
}
## Example

14
docs/tools/sdk/python/Reference/Beta/Models/SourceAccountUpdated.md
View File

@@ -16,14 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'SourceAccountUpdated', 'BetaSourceAcc
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**uuid** | **str** | Source unique identifier for the identity. UUID is generated by the source system. | [optional]
**uuid** | **str** | Identity's universal unique identifier (UUID) on the source. The source system generates the UUID. | [required]
**id** | **str** | SailPoint generated unique identifier. | [required]
**native_identifier** | **str** | Unique ID of the account on the source. | [required]
**source_id** | **str** | The ID of the source. | [required]
**source_name** | **str** | The name of the source. | [required]
**identity_id** | **str** | The ID of the identity that is correlated with this account. | [required]
**identity_name** | **str** | The name of the identity that is correlated with this account. | [required]
**attributes** | **map[string]object** | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required]
**native_identifier** | **str** | Account's unique ID on the source. | [required]
**source_id** | **str** | Source ID. | [required]
**source_name** | **str** | Source name. | [required]
**identity_id** | **str** | ID of the identity correlated with the account. | [required]
**identity_name** | **str** | Name of the identity correlated with the account. | [required]
**attributes** | **map[string]object** | Account attributes. The attributes' contents depend on the source's account schema. | [required]
}
## Example

10
docs/tools/sdk/python/Reference/Beta/Models/SourceCreated.md
View File

@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'SourceCreated', 'BetaSourceCreated']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique ID of the source. | [required]
**name** | **str** | Human friendly name of the source. | [required]
**type** | **str** | The connection type. | [required]
**created** | **datetime** | The date and time the source was created. | [required]
**connector** | **str** | The connector type used to connect to the source. | [required]
**id** | **str** | Source's unique ID. | [required]
**name** | **str** | Source name. | [required]
**type** | **str** | Connection type. | [required]
**created** | **datetime** | Date and time when the source was created. | [required]
**connector** | **str** | Connector type used to connect to the source. | [required]
**actor** | [**SourceCreatedActor**](source-created-actor) | | [required]
}

6
docs/tools/sdk/python/Reference/Beta/Models/SourceCreatedActor.md
View File

@@ -17,9 +17,9 @@ Identity who created the source.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity who created the source. | [required]
**id** | **str** | ID of identity who created the source. | [required]
**name** | **str** | Display name of identity who created the source. | [required]
**type** | **Enum** [ 'IDENTITY' ] | DTO type of the identity who created the source. | [required]
**id** | **str** | ID of the identity who created the source. | [required]
**name** | **str** | Name of the identity who created the source. | [required]
}
## Example

10
docs/tools/sdk/python/Reference/Beta/Models/SourceDeleted.md
View File

@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'SourceDeleted', 'BetaSourceDeleted']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique ID of the source. | [required]
**name** | **str** | Human friendly name of the source. | [required]
**type** | **str** | The connection type. | [required]
**deleted** | **datetime** | The date and time the source was deleted. | [required]
**connector** | **str** | The connector type used to connect to the source. | [required]
**id** | **str** | Source's unique ID. | [required]
**name** | **str** | Source name. | [required]
**type** | **str** | Connection type. | [required]
**deleted** | **datetime** | Date and time when the source was deleted. | [required]
**connector** | **str** | Connector type used to connect to the source. | [required]
**actor** | [**SourceDeletedActor**](source-deleted-actor) | | [required]
}

6
docs/tools/sdk/python/Reference/Beta/Models/SourceDeletedActor.md
View File

@@ -17,9 +17,9 @@ Identity who deleted the source.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity who deleted the source. | [required]
**id** | **str** | ID of identity who deleted the source. | [required]
**name** | **str** | Display name of identity who deleted the source. | [required]
**type** | **Enum** [ 'IDENTITY' ] | DTO type of the identity who deleted the source. | [required]
**id** | **str** | ID of the identity who deleted the source. | [required]
**name** | **str** | Name of the identity who deleted the source. | [required]
}
## Example

12
docs/tools/sdk/python/Reference/Beta/Models/SourceUpdated.md
View File

@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'SourceUpdated', 'BetaSourceUpdated']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique ID of the source. | [required]
**name** | **str** | The user friendly name of the source. | [required]
**type** | **str** | The connection type of the source. | [required]
**modified** | **datetime** | The date and time the source was modified. | [required]
**connector** | **str** | The connector type used to connect to the source. | [required]
**id** | **str** | Source's unique ID. | [required]
**name** | **str** | Source name. | [required]
**type** | **str** | Connection type. | [required]
**modified** | **datetime** | Date and time when the source was modified. | [required]
**connector** | **str** | Connector type used to connect to the source. | [required]
**actor** | [**SourceUpdatedActor**](source-updated-actor) | | [required]
}
@@ -31,7 +31,7 @@ from sailpoint.beta.models.source_updated import SourceUpdated
source_updated = SourceUpdated(
id='2c9180866166b5b0016167c32ef31a66',
name='Corporate Active Directory',
name='Test source',
type='DIRECT_CONNECT',
modified='2021-03-29T22:01:50.474Z',
connector='active-directory',

6
docs/tools/sdk/python/Reference/Beta/Models/SourceUpdatedActor.md
View File

@@ -17,9 +17,9 @@ Identity who updated the source.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | DTO type of identity who updated the source. | [required]
**id** | **str** | ID of identity who updated the source. | [optional]
**name** | **str** | Display name of identity who updated the source. | [required]
**type** | **Enum** [ 'IDENTITY' ] | DTO type of the identity who updated the source. | [required]
**id** | **str** | ID of the identity who updated the source. | [required]
**name** | **str** | Name of the identity who updated the source. | [required]
}
## Example

87
docs/tools/sdk/python/Reference/Beta/Models/TriggerExampleInput.md
View File

@@ -17,52 +17,52 @@ An example of the JSON payload that will be sent by the trigger to the subscribe
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_request_id** | **str** | The unique ID of the access request. | [required]
**requested_for** | [**[]AccessItemRequestedForDto**](access-item-requested-for-dto) | Identities access was requested for. | [required]
**requested_items** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details of the access items being requested. | [required]
**requested_by** | [**AccessItemRequesterDto**](access-item-requester-dto) | | [required]
**requested_items_status** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details on the outcome of each access item. | [required]
**access_request_id** | **str** | Access request's unique ID. | [required]
**requested_for** | [**[]AccessItemRequestedForDto1**](access-item-requested-for-dto1) | Identities whom access was requested for. | [required]
**requested_items** | [**[]AccessRequestPreApprovalRequestedItemsInner**](access-request-pre-approval-requested-items-inner) | Details about each requested access item. | [required]
**requested_by** | [**AccessItemRequesterDto1**](access-item-requester-dto1) | | [required]
**requested_items_status** | [**[]AccessRequestPostApprovalRequestedItemsStatusInner**](access-request-post-approval-requested-items-status-inner) | Details about the outcome of each requested access item. | [required]
**source** | [**AccountUncorrelatedSource**](account-uncorrelated-source) | | [required]
**status** | **Enum** [ 'Success', 'Failed', 'Terminated' ] | The overall status of the collection. | [required]
**started** | **datetime** | The date and time when the account collection started. | [required]
**completed** | **datetime** | The date and time when the account collection finished. | [required]
**errors** | **[]str** | A list of any accumulated error messages that occurred during provisioning. | [required]
**warnings** | **[]str** | A list of any accumulated warning messages that occurred during provisioning. | [required]
**errors** | **[]str** | List of any accumulated error messages that occurred during provisioning. | [required]
**warnings** | **[]str** | List of any accumulated warning messages that occurred during provisioning. | [required]
**stats** | [**AccountsCollectedForAggregationStats**](accounts-collected-for-aggregation-stats) | | [required]
**identity** | [**IdentityDeletedIdentity**](identity-deleted-identity) | | [required]
**account** | [**AccountUncorrelatedAccount**](account-uncorrelated-account) | | [required]
**changes** | [**[]IdentityAttributesChangedChangesInner**](identity-attributes-changed-changes-inner) | A list of one or more identity attributes that changed on the identity. | [required]
**attributes** | **map[string]object** | The attributes of the account. The contents of attributes depends on the account schema for the source. | [required]
**changes** | [**[]IdentityAttributesChangedChangesInner**](identity-attributes-changed-changes-inner) | List of identity's attributes that changed. | [required]
**attributes** | **map[string]object** | Account attributes. The attributes' contents depend on the source's account schema. | [required]
**entitlement_count** | **int** | The number of entitlements associated with this account. | [optional]
**campaign** | [**CampaignGeneratedCampaign**](campaign-generated-campaign) | | [required]
**certification** | [**CertificationSignedOffCertification**](certification-signed-off-certification) | | [required]
**tracking_number** | **str** | The reference number of the provisioning request. Useful for tracking status in the Account Activity search interface. | [required]
**sources** | **str** | One or more sources that the provisioning transaction(s) were done against. Sources are comma separated. | [required]
**action** | **str** | Origin of where the provisioning request came from. | [optional]
**tracking_number** | **str** | Provisioning request's reference number. Useful for tracking status in the 'Account Activity' search interface. | [required]
**sources** | **str** | Sources the provisioning transactions were performed on. Sources are comma separated. | [required]
**action** | **str** | Origin of the provisioning request. | [optional]
**recipient** | [**ProvisioningCompletedRecipient**](provisioning-completed-recipient) | | [required]
**requester** | [**ProvisioningCompletedRequester**](provisioning-completed-requester) | | [optional]
**account_requests** | [**[]ProvisioningCompletedAccountRequestsInner**](provisioning-completed-account-requests-inner) | A list of provisioning instructions to perform on an account-by-account basis. | [required]
**file_name** | **str** | A name for the report file. | [required]
**owner_email** | **str** | The email address of the identity that owns the saved search. | [required]
**owner_name** | **str** | The name of the identity that owns the saved search. | [required]
**query** | **str** | The search query that was used to generate the report. | [required]
**search_name** | **str** | The name of the saved search. | [required]
**account_requests** | [**[]ProvisioningCompletedAccountRequestsInner**](provisioning-completed-account-requests-inner) | List of provisioning instructions to perform on an account-by-account basis. | [required]
**file_name** | **str** | Report file name. | [required]
**owner_email** | **str** | Email address of the identity who owns the saved search. | [required]
**owner_name** | **str** | Name of the identity who owns the saved search. | [required]
**query** | **str** | Search query used to generate the report. | [required]
**search_name** | **str** | Saved search name. | [required]
**search_results** | [**SavedSearchCompleteSearchResults**](saved-search-complete-search-results) | | [required]
**signed_s3_url** | **str** | The Amazon S3 URL to download the report from. | [required]
**uuid** | **str** | Source unique identifier for the identity. UUID is generated by the source system. | [optional]
**id** | **str** | The unique ID of the source. | [required]
**native_identifier** | **str** | Unique ID of the account on the source. | [required]
**source_id** | **str** | The ID of the source. | [required]
**source_name** | **str** | The name of the source. | [required]
**identity_id** | **str** | The ID of the identity that is correlated with this account. | [required]
**identity_name** | **str** | The name of the identity that is correlated with this account. | [required]
**name** | **str** | The user friendly name of the source. | [required]
**type** | **str** | The connection type of the source. | [required]
**created** | **datetime** | The date and time the status change occurred. | [required]
**connector** | **str** | The connector type used to connect to the source. | [required]
**uuid** | **str** | Identity's universal unique identifier (UUID) on the source. The source system generates the UUID. | [required]
**id** | **str** | Source's unique ID. | [required]
**native_identifier** | **str** | Account's unique ID on the source. | [required]
**source_id** | **str** | Source ID. | [required]
**source_name** | **str** | Source name. | [required]
**identity_id** | **str** | ID of the identity correlated with the account. | [required]
**identity_name** | **str** | Name of the identity correlated with the account. | [required]
**name** | **str** | Source name. | [required]
**type** | **str** | Connection type. | [required]
**created** | **datetime** | Date and time when the status change occurred. | [required]
**connector** | **str** | Connector type used to connect to the source. | [required]
**actor** | [**SourceUpdatedActor**](source-updated-actor) | | [required]
**deleted** | **datetime** | The date and time the source was deleted. | [required]
**modified** | **datetime** | The date and time the source was modified. | [required]
**deleted** | **datetime** | Date and time when the source was deleted. | [required]
**modified** | **datetime** | Date and time when the source was modified. | [required]
**application** | [**VAClusterStatusChangeEventApplication**](va-cluster-status-change-event-application) | | [required]
**health_check_result** | [**VAClusterStatusChangeEventHealthCheckResult**](va-cluster-status-change-event-health-check-result) | | [required]
**previous_health_check_result** | [**VAClusterStatusChangeEventPreviousHealthCheckResult**](va-cluster-status-change-event-previous-health-check-result) | | [required]
@@ -76,7 +76,7 @@ from sailpoint.beta.models.trigger_example_input import TriggerExampleInput
trigger_example_input = TriggerExampleInput(
access_request_id='2c91808b6ef1d43e016efba0ce470904',
requested_for=[
sailpoint.beta.models.access_item_requested_for_dto.AccessItemRequestedForDto(
sailpoint.beta.models.access_item_requested_for_dto_1.AccessItemRequestedForDto_1(
type = 'IDENTITY',
id = '2c4180a46faadee4016fb4e018c20626',
name = 'Robert Robinson', )
@@ -90,7 +90,7 @@ requested_items=[
operation = Add,
comment = 'William needs this access to do his job.', )
],
requested_by=sailpoint.beta.models.access_item_requester_dto.AccessItemRequesterDto(
requested_by=sailpoint.beta.models.access_item_requester_dto_1.AccessItemRequesterDto_1(
type = 'IDENTITY',
id = '2c7180a46faadee4016fb4e018c20648',
name = 'William Wilson', ),
@@ -105,11 +105,10 @@ requested_items_status=[
client_metadata = {applicationName=My application},
approval_info = [
sailpoint.beta.models.access_request_post_approval_requested_items_status_inner_approval_info_inner.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner(
approval_comment = 'This access looks good. Approved.',
approval_comment = 'This access looks good. Approved.',
approval_decision = APPROVED,
approver_name = 'Stephen.Austin',
approver = sailpoint.beta.models.access_request_post_approval_requested_items_status_inner_approval_info_inner_approver.AccessRequestPostApproval_requestedItemsStatus_inner_approvalInfo_inner_approver(
type = IDENTITY, ), )
approver = null, )
], )
],
source=sailpoint.beta.models.account_uncorrelated_source.AccountUncorrelated_source(
@@ -159,8 +158,8 @@ campaign=sailpoint.beta.models.campaign_generated_campaign.CampaignGenerated_cam
type = MANAGER,
campaign_owner = sailpoint.beta.models.campaign_generated_campaign_campaign_owner.CampaignGenerated_campaign_campaignOwner(
id = '37f080867702c1910177031320c40n27',
display_name = 'John Snow',
email = 'john.snow@example.com', ),
display_name = 'Albert Albertson',
email = 'albert.albertson@example.com', ),
status = STAGED, ),
certification=sailpoint.beta.models.certification_signed_off_certification.CertificationSignedOff_certification(
id = '2c91808576f886190176f88caf0d0067',
@@ -184,7 +183,7 @@ account_requests=[
id = '4e4d982dddff4267ab12f0f1e72b5a6d',
type = 'SOURCE',
name = 'Corporate Active Directory', ),
account_id = 'CN=Chewy.Bacca,ou=hardcorefigter,ou=wookies,dc=starwars,dc=com',
account_id = 'CN=Rob.Robertson,ou=csm,ou=sales,dc=helpco,dc=com',
account_operation = 'Modify',
provisioning_result = SUCCESS,
provisioning_target = 'Corp AD',
@@ -192,8 +191,8 @@ account_requests=[
attribute_requests = [
sailpoint.beta.models.provisioning_completed_account_requests_inner_attribute_requests_inner.ProvisioningCompleted_accountRequests_inner_attributeRequests_inner(
attribute_name = 'memberOf',
attribute_value = 'CN=jedi,DC=starwars,DC=com',
operation = Add, )
attribute_value = 'CN=sales,DC=helpco,DC=com',
operation = 'Add', )
], )
],
file_name='Modified.zip',
@@ -228,7 +227,7 @@ source_id='2c918082814e693601816e09471b29b6',
source_name='Active Directory',
identity_id='ee769173319b41d19ccec6c235423237b',
identity_name='john.doe',
name='Corporate Active Directory',
name='Test source',
type='DIRECT_CONNECT',
created='2020-06-29T22:01:50.474Z',
connector='active-directory',
@@ -245,11 +244,11 @@ application=sailpoint.beta.models.va_cluster_status_change_event_application.VAC
health_check_result=sailpoint.beta.models.va_cluster_status_change_event_health_check_result.VAClusterStatusChangeEvent_healthCheckResult(
message = 'Test Connection failed with exception. Error message - java.lang Exception',
result_type = 'SOURCE_STATE_ERROR_CLUSTER',
status = Succeeded, ),
status = 'Succeeded', ),
previous_health_check_result=sailpoint.beta.models.va_cluster_status_change_event_previous_health_check_result.VAClusterStatusChangeEvent_previousHealthCheckResult(
message = 'Test Connection failed with exception. Error message - java.lang Exception',
result_type = 'SOURCE_STATE_ERROR_CLUSTER',
status = Failed, )
status = 'Failed', )
)
```

8
docs/tools/sdk/python/Reference/Beta/Models/VAClusterStatusChangeEvent.md
View File

@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEvent', 'BetaVAC
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**created** | **datetime** | The date and time the status change occurred. | [required]
**type** | **Enum** [ 'SOURCE', 'CLUSTER' ] | The type of the object that initiated this event. | [required]
**created** | **datetime** | Date and time when the status change occurred. | [required]
**type** | **Enum** [ 'SOURCE', 'CLUSTER' ] | Type of the object that initiated the event. | [required]
**application** | [**VAClusterStatusChangeEventApplication**](va-cluster-status-change-event-application) | | [required]
**health_check_result** | [**VAClusterStatusChangeEventHealthCheckResult**](va-cluster-status-change-event-health-check-result) | | [required]
**previous_health_check_result** | [**VAClusterStatusChangeEventPreviousHealthCheckResult**](va-cluster-status-change-event-previous-health-check-result) | | [required]
@@ -38,11 +38,11 @@ application=sailpoint.beta.models.va_cluster_status_change_event_application.VAC
health_check_result=sailpoint.beta.models.va_cluster_status_change_event_health_check_result.VAClusterStatusChangeEvent_healthCheckResult(
message = 'Test Connection failed with exception. Error message - java.lang Exception',
result_type = 'SOURCE_STATE_ERROR_CLUSTER',
status = Succeeded, ),
status = 'Succeeded', ),
previous_health_check_result=sailpoint.beta.models.va_cluster_status_change_event_previous_health_check_result.VAClusterStatusChangeEvent_previousHealthCheckResult(
message = 'Test Connection failed with exception. Error message - java.lang Exception',
result_type = 'SOURCE_STATE_ERROR_CLUSTER',
status = Failed, )
status = 'Failed', )
)
```

8
docs/tools/sdk/python/Reference/Beta/Models/VAClusterStatusChangeEventApplication.md
View File

@@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventApplication
# VAClusterStatusChangeEventApplication
Details about the `CLUSTER` or `SOURCE` that initiated this event.
Details about the `CLUSTER` or `SOURCE` that initiated the event.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The GUID of the application | [required]
**name** | **str** | The name of the application | [required]
**attributes** | **map[string]object** | Custom map of attributes for a source. This will only be populated if type is `SOURCE` and the source has a proxy. | [required]
**id** | **str** | Application's globally unique identifier (GUID). | [required]
**name** | **str** | Application name. | [required]
**attributes** | **map[string]object** | Custom map of attributes for a source. Attributes only populate if the type is `SOURCE` and the source has a proxy. | [required]
}
## Example

10
docs/tools/sdk/python/Reference/Beta/Models/VAClusterStatusChangeEventHealthCheckResult.md
View File

@@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventHealthCheck
# VAClusterStatusChangeEventHealthCheckResult
The results of the most recent health check.
Results of the most recent health check.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**message** | **str** | Detailed message of the result of the health check. | [required]
**result_type** | **str** | The type of the health check result. | [required]
**status** | **Enum** [ 'Succeeded', 'Failed' ] | The status of the health check. | [required]
**message** | **str** | Detailed message of the health check result.. | [required]
**result_type** | **str** | Health check result type. | [required]
**status** | **Enum** [ 'Succeeded', 'Failed' ] | Health check status. | [required]
}
## Example
@@ -30,7 +30,7 @@ from sailpoint.beta.models.va_cluster_status_change_event_health_check_result im
va_cluster_status_change_event_health_check_result = VAClusterStatusChangeEventHealthCheckResult(
message='Test Connection failed with exception. Error message - java.lang Exception',
result_type='SOURCE_STATE_ERROR_CLUSTER',
status=Succeeded
status='Succeeded'
)
```

10
docs/tools/sdk/python/Reference/Beta/Models/VAClusterStatusChangeEventPreviousHealthCheckResult.md
View File

@@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'VAClusterStatusChangeEventPreviousHea
# VAClusterStatusChangeEventPreviousHealthCheckResult
The results of the last health check.
Results of the last health check.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**message** | **str** | Detailed message of the result of the health check. | [required]
**result_type** | **str** | The type of the health check result. | [required]
**status** | **Enum** [ 'Succeeded', 'Failed' ] | The status of the health check. | [required]
**message** | **str** | Detailed message of the health check result. | [required]
**result_type** | **str** | Health check result type. | [required]
**status** | **Enum** [ 'Succeeded', 'Failed' ] | Health check status. | [required]
}
## Example
@@ -30,7 +30,7 @@ from sailpoint.beta.models.va_cluster_status_change_event_previous_health_check_
va_cluster_status_change_event_previous_health_check_result = VAClusterStatusChangeEventPreviousHealthCheckResult(
message='Test Connection failed with exception. Error message - java.lang Exception',
result_type='SOURCE_STATE_ERROR_CLUSTER',
status=Failed
status='Failed'
)
```

10
docs/tools/sdk/python/Reference/Beta/Models/WorkflowTriggerAttributes.md
View File

@@ -20,14 +20,17 @@ Name | Type | Description | Notes
**id** | **str** | The unique ID of the trigger | [required]
**filter_** | **str** | JSON path expression that will limit which events the trigger will fire on | [optional]
**description** | **str** | Additional context about the external trigger | [optional]
**attribute_to_filter** | **str** | The attribute to filter on | [optional]
**form_definition_id** | **str** | Form definition's unique identifier. | [optional]
**name** | **str** | A unique name for the external trigger | [optional]
**client_id** | **str** | OAuth Client ID to authenticate with this trigger | [optional]
**url** | **str** | URL to invoke this workflow | [optional]
**frequency** | **Enum** [ 'daily', 'weekly', 'monthly', 'yearly', 'cronSchedule' ] | Frequency of execution | [required]
**time_zone** | **str** | Time zone identifier | [optional]
**cron_string** | **str** | | [optional]
**cron_string** | **str** | A valid CRON expression | [optional]
**weekly_days** | **[]str** | Scheduled days of the week for execution | [optional]
**weekly_times** | **[]str** | Scheduled execution times | [optional]
**yearly_times** | **[]str** | Scheduled execution times | [optional]
}
## Example
@@ -39,6 +42,8 @@ workflow_trigger_attributes = WorkflowTriggerAttributes(
id='idn:identity-attributes-changed',
filter_='$.changes[?(@.attribute == 'manager')]',
description='Run a search and notify the results',
attribute_to_filter='LifecycleState',
form_definition_id='Admin_Access_Request_Form',
name='search-and-notify',
client_id='87e239b2-b85b-4bde-b9a7-55bf304ddcdc',
url='https://tenant.api.identitynow.com/beta/workflows/execute/external/c79e0079-562c-4df5-aa73-60a9e25c916d',
@@ -46,7 +51,8 @@ frequency='daily',
time_zone='America/Chicago',
cron_string='0 9 * * 1',
weekly_days=Monday,
weekly_times=Monday
weekly_times=Monday,
yearly_times=1969-12-31T09:00:00.000Z
)
```