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

merge changes from main and pull the latest from python docs

Browse Source
This commit is contained in:
darrell-thobe-sp
2025-03-10 11:34:32 -04:00
parent 6f7d1983fd 8c3bd4fe6f
commit 340c9bb8cd
3122 changed files with 95404 additions and 24060 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -409,12 +409,12 @@ Path | id | **str** | True | The account id
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.
### Return type
[**List[EntitlementDto]**](../models/entitlement-dto)
[**List[Entitlement]**](../models/entitlement)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | An array of account entitlements | List[EntitlementDto] | - |
200 | An array of account entitlements | List[Entitlement] | - |
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. | ListAccessProfiles401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
@@ -432,7 +432,7 @@ Code | Description | Data Type | Response headers |
import sailpoint.v3
from sailpoint.v3.api.accounts_api import AccountsApi
from sailpoint.v3.api_client import ApiClient
from sailpoint.v3.models.entitlement_dto import EntitlementDto
from sailpoint.v3.models.entitlement import Entitlement
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
@@ -473,8 +473,8 @@ Param Type | Name | Data Type | Required | Description
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 | detail_level | **str** | (optional) | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior.
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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull*
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: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType**
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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt*
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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType**
### Return type
[**List[Account]**](../models/account)
@@ -509,8 +509,8 @@ with ApiClient(configuration) as api_client:
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
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)
detail_level = 'FULL' # str | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional) # str | This value determines whether the API provides `SLIM` or increased level of detail (`FULL`) for each account in the returned list. `FULL` is the default behavior. (optional)
filters = 'identityId eq \"2c9180858082150f0180893dbaf44201\"' # 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* (optional)
sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (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: **id, name, created, modified, sourceId, identityId, identity.id, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional)
filters = 'identityId eq \"2c9180858082150f0180893dbaf44201\"' # 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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (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, sw* **identityId**: *eq, in, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **hasEntitlements**: *eq* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **identity.correlated**: *eq* **identity.identityState**: *eq, in* **source.displayableName**: *eq, in* **source.authoritative**: *eq* **source.connectionType**: *eq, in* **recommendation.method**: *eq, in, isnull* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* (optional)
sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (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: **id, name, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType** (optional)
try:
# Accounts List

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

@@ -25,22 +25,22 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
Method | HTTP request | Description
------------- | ------------- | -------------
[**create-identity-profile**](#create-identity-profile) | **POST** `/identity-profiles` | Create an Identity Profile
[**delete-identity-profile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete an Identity Profile
[**create-identity-profile**](#create-identity-profile) | **POST** `/identity-profiles` | Create Identity Profile
[**delete-identity-profile**](#delete-identity-profile) | **DELETE** `/identity-profiles/{identity-profile-id}` | Delete Identity Profile
[**delete-identity-profiles**](#delete-identity-profiles) | **POST** `/identity-profiles/bulk-delete` | Delete Identity Profiles
[**export-identity-profiles**](#export-identity-profiles) | **GET** `/identity-profiles/export` | Export Identity Profiles
[**get-default-identity-attribute-config**](#get-default-identity-attribute-config) | **GET** `/identity-profiles/{identity-profile-id}/default-identity-attribute-config` | Get default Identity Attribute Config
[**get-identity-profile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get single Identity Profile
[**get-identity-profile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Get Identity Profile
[**import-identity-profiles**](#import-identity-profiles) | **POST** `/identity-profiles/import` | Import Identity Profiles
[**list-identity-profiles**](#list-identity-profiles) | **GET** `/identity-profiles` | Identity Profiles List
[**list-identity-profiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List Identity Profiles
[**show-identity-preview**](#show-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview
[**sync-identity-profile**](#sync-identity-profile) | **POST** `/identity-profiles/{identity-profile-id}/process-identities` | Process identities under profile
[**update-identity-profile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update the Identity Profile
[**update-identity-profile**](#update-identity-profile) | **PATCH** `/identity-profiles/{identity-profile-id}` | Update Identity Profile
## create-identity-profile
Create an Identity Profile
This creates an Identity Profile.
Create Identity Profile
Creates an identity profile.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-identity-profile)
@@ -56,7 +56,7 @@ Param Type | Name | Data Type | Required | Description
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
201 | The created Identity Profile | IdentityProfile | - |
201 | Created identity profile. | IdentityProfile | - |
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. | ListAccessProfiles401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
@@ -130,7 +130,7 @@ with ApiClient(configuration) as api_client:
} # IdentityProfile |
try:
# Create an Identity Profile
# Create Identity Profile
new_identity_profile = IdentityProfile()
new_identity_profile.from_json(identity_profile)
results =IdentityProfilesApi(api_client).create_identity_profile(new_identity_profile)
@@ -147,13 +147,9 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-identity-profile
Delete an Identity Profile
This deletes an Identity Profile based on ID.
Delete Identity Profile
Delete an identity profile by ID.
On success, this endpoint will return a reference to the bulk delete task result.
The following rights are required to access this endpoint: idn:identity-profile:delete
[API Spec](https://developer.sailpoint.com/docs/api/v3/delete-identity-profile)
@@ -161,7 +157,7 @@ The following rights are required to access this endpoint: idn:identity-profile:
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | identity_profile_id | **str** | True | The Identity Profile ID.
Path | identity_profile_id | **str** | True | Identity profile ID.
### Return type
[**TaskResultSimplified**](../models/task-result-simplified)
@@ -193,10 +189,10 @@ from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Identity Profile ID. # str | The Identity Profile ID.
identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID.
try:
# Delete an Identity Profile
# Delete Identity Profile
results =IdentityProfilesApi(api_client).delete_identity_profile(identity_profile_id)
# Below is a request that includes all optional parameters
@@ -405,8 +401,8 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-identity-profile
Get single Identity Profile
This returns a single Identity Profile based on ID.
Get Identity Profile
Get a single identity profile by ID.
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-identity-profile)
@@ -414,7 +410,7 @@ This returns a single Identity Profile based on ID.
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | identity_profile_id | **str** | True | The Identity Profile ID.
Path | identity_profile_id | **str** | True | Identity profile ID.
### Return type
[**IdentityProfile**](../models/identity-profile)
@@ -422,7 +418,7 @@ Path | identity_profile_id | **str** | True | The Identity Profile ID.
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | An Identity Profile object. | IdentityProfile | - |
200 | Identity profile object. | IdentityProfile | - |
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. | ListAccessProfiles401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
@@ -446,10 +442,10 @@ from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | The Identity Profile ID. # str | The Identity Profile ID.
identity_profile_id = '2b838de9-db9b-abcf-e646-d4f274ad4238' # str | Identity profile ID. # str | Identity profile ID.
try:
# Get single Identity Profile
# Get Identity Profile
results =IdentityProfilesApi(api_client).get_identity_profile(identity_profile_id)
# Below is a request that includes all optional parameters
@@ -584,8 +580,8 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-identity-profiles
Identity Profiles List
This returns a list of Identity Profiles based on the specified query parameters.
List Identity Profiles
Get a list of identity profiles, based on the specified query parameters.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-identity-profiles)
@@ -596,7 +592,7 @@ 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.
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, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne*
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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne*
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: **id, name, priority, created, modified, owner.id, owner.name**
### Return type
@@ -605,7 +601,7 @@ Param Type | Name | Data Type | Required | Description
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | List of identityProfiles. | List[IdentityProfile] | - |
200 | List of identity profiles. | List[IdentityProfile] | - |
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. | ListAccessProfiles401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
@@ -631,11 +627,11 @@ with ApiClient(configuration) as api_client:
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False)
filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* (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, ne, ge, gt, in, le, lt, isnull, sw* **name**: *eq, ne, ge, gt, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional)
filters = 'id eq \"ef38f94347e94562b5bb8424a56397d8\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (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, ne, ge, gt, in, le, sw* **name**: *eq, ne, ge, gt, in, le, sw* **priority**: *eq, ne* (optional)
sorters = 'id,name' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, priority, created, modified, owner.id, owner.name** (optional)
try:
# Identity Profiles List
# List Identity Profiles
results =IdentityProfilesApi(api_client).list_identity_profiles()
# Below is a request that includes all optional parameters
@@ -802,18 +798,16 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-identity-profile
Update the Identity Profile
This updates the specified Identity Profile.
Update Identity Profile
Update a specified identity profile with this PATCH request.
Some fields of the Schema cannot be updated. These fields are listed below:
You cannot update these fields:
* id
* name
* created
* modified
* identityCount
* identityRefreshRequired
* Authoritative Source and Identity Attribute Configuration cannot be modified at once.
* Authoritative Source and Identity Attribute Configuration cannot be modified at the same time.
[API Spec](https://developer.sailpoint.com/docs/api/v3/update-identity-profile)
@@ -821,8 +815,8 @@ Some fields of the Schema cannot be updated. These fields are listed below:
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | identity_profile_id | **str** | True | The Identity Profile ID
Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
Path | identity_profile_id | **str** | True | Identity profile ID.
Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
### Return type
[**IdentityProfile**](../models/identity-profile)
@@ -830,7 +824,7 @@ Path | identity_profile_id | **str** | True | The Identity Profile ID
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | The updated Identity Profile. | IdentityProfile | - |
200 | Updated identity profile. | IdentityProfile | - |
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. | ListAccessProfiles401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
@@ -855,17 +849,17 @@ from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The Identity Profile ID # str | The Identity Profile ID
[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}] # List[JsonPatchOperation] | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
identity_profile_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity profile ID. # str | Identity profile ID.
[{op=add, path=/identityAttributeConfig/attributeTransforms/0, value={identityAttributeName=location, transformDefinition={type=accountAttribute, attributes={sourceName=Employees, attributeName=location, sourceId=2c91808878b7d63b0178c66ffcdc4ce4}}}}] # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
json_patch_operation = {
"op" : "replace",
"path" : "/description",
"value" : "New description"
} # List[JsonPatchOperation] | A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
} # List[JsonPatchOperation] | List of identity profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
try:
# Update the Identity Profile
# Update Identity Profile
new_json_patch_operation = JsonPatchOperation()
new_json_patch_operation.from_json(json_patch_operation)
results =IdentityProfilesApi(api_client).update_identity_profile(identity_profile_id, new_json_patch_operation)

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

@@ -296,7 +296,7 @@ with ApiClient(configuration) as api_client:
## create-non-employee-source
Create Non-Employee Source
This request will create a non-employee source. Requires role context of `idn:nesr:create`
Create a non-employee source.
[API Spec](https://developer.sailpoint.com/docs/api/v3/create-non-employee-source)
@@ -1749,11 +1749,9 @@ with ApiClient(configuration) as api_client:
## list-non-employee-sources
List Non-Employee Sources
This gets a list of non-employee sources. There are two contextual uses for the requested-for path parameter:
1. The user has the role context of `idn:nesr:read`, in which case he or
she may request a list sources assigned to a particular account manager by passing in that manager's id.
2. The current user is an account manager, in which case "me" should be
provided as the `requested-for` value. This will provide the user with a list of the sources that he or she owns.
Get a list of non-employee sources. There are two contextual uses for the `requested-for` path parameter:
1. If the user has the role context of `idn:nesr:read`, he or she may request a list sources assigned to a particular account manager by passing in that manager's `id`.
2. If the current user is an account manager, the user should provide 'me' as the `requested-for` value. Doing so provide the user with a list of the sources he or she owns.
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-non-employee-sources)
@@ -1761,11 +1759,11 @@ provided as the `requested-for` value. This will provide the user with a list of
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Query | requested_for | **str** | True | The identity for whom the request was made. *me* indicates the current user.
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 | non_employee_count | **bool** | (optional) | The flag to determine whether return a non-employee count associate with source.
Query | requested_for | **str** | (optional) | Identity the request was made for. Use 'me' to indicate the current user.
Query | non_employee_count | **bool** | (optional) (default to False) | Flag that determines whether the API will return a non-employee count associated with the source.
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, sourceId**
### Return type
@@ -1797,19 +1795,19 @@ from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
requested_for = 'me' # str | The identity for whom the request was made. *me* indicates the current user. # str | The identity for whom the request was made. *me* indicates the current user.
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
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)
non_employee_count = true # bool | The flag to determine whether return a non-employee count associate with source. (optional) # bool | The flag to determine whether return a non-employee count associate with source. (optional)
requested_for = 'me' # str | Identity the request was made for. Use 'me' to indicate the current user. (optional) # str | Identity the request was made for. Use 'me' to indicate the current user. (optional)
non_employee_count = False # bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to False) # bool | Flag that determines whether the API will return a non-employee count associated with the source. (optional) (default to False)
sorters = 'name,created' # 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, sourceId** (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, sourceId** (optional)
try:
# List Non-Employee Sources
results =NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(requested_for, )
results =NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources()
# Below is a request that includes all optional parameters
# results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(requested_for, limit, offset, count, non_employee_count, sorters)
# results = NonEmployeeLifecycleManagementApi(api_client).list_non_employee_sources(limit, offset, count, requested_for, non_employee_count, sorters)
print("The response of NonEmployeeLifecycleManagementApi->list_non_employee_sources:\n")
pprint(results)
except Exception as e:

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

@@ -443,7 +443,7 @@ from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
index = 'accounts' # str | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. # str | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*.
index = 'identities' # str | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*. # str | The index from which to fetch the specified document. The currently supported index names are: *accessprofiles*, *accountactivities*, *entitlements*, *events*, *identities*, and *roles*.
id = '2c91808568c529c60168cca6f90c1313' # str | ID of the requested document. # str | ID of the requested document.
try:

4
docs/tools/sdk/python/Reference/V3/Models/Access.md
View File

@@ -19,8 +19,7 @@ Name | Type | Description | Notes
**id** | **str** | The unique ID of the referenced object. | [optional]
**name** | **str** | The human readable name of the referenced object. | [optional]
**display_name** | **str** | | [optional]
**type** | [**DtoType**](dto-type) | | [optional]
**description** | **str** | | [optional]
**description** | **str** | Description of access item. | [optional]
}
## Example
@@ -32,7 +31,6 @@ access = Access(
id='2c91808568c529c60168cca6f90c1313',
name='John Doe',
display_name='John Q. Doe',
type='IDENTITY',
description=''
)

43
docs/tools/sdk/python/Reference/V3/Models/AccessApps.md Normal file
View File

@@ -0,0 +1,43 @@
---
id: access-apps
title: AccessApps
pagination_label: AccessApps
sidebar_label: AccessApps
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessApps', 'AccessApps']
slug: /tools/sdk/python/v3/models/access-apps
tags: ['SDK', 'Software Development Kit', 'AccessApps', 'AccessApps']
---
# AccessApps
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique ID of the referenced object. | [optional]
**name** | **str** | Name of application | [optional]
**description** | **str** | Description of application. | [optional]
**owner** | [**AccessAppsOwner**](access-apps-owner) | | [optional]
}
## Example
```python
from sailpoint.v3.models.access_apps import AccessApps
access_apps = AccessApps(
id='2c91808568c529c60168cca6f90c1313',
name='Travel and Expense',
description='Travel and Expense Application',
owner=sailpoint.v3.models.access_apps_owner.AccessApps_owner(
type = 'IDENTITY',
id = '2c9180a46faadee4016fb4e018c20639',
name = 'John Doe',
email = 'john.doe@sailpoint.com', )
)
```
[[Back to top]](#)

40
docs/tools/sdk/python/Reference/V3/Models/AccessAppsOwner.md Normal file
View File

@@ -0,0 +1,40 @@
---
id: access-apps-owner
title: AccessAppsOwner
pagination_label: AccessAppsOwner
sidebar_label: AccessAppsOwner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessAppsOwner', 'AccessAppsOwner']
slug: /tools/sdk/python/v3/models/access-apps-owner
tags: ['SDK', 'Software Development Kit', 'AccessAppsOwner', 'AccessAppsOwner']
---
# AccessAppsOwner
Owner's identity.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | Owner's DTO type. | [optional]
**id** | **str** | Owner's identity ID. | [optional]
**name** | **str** | Owner's display name. | [optional]
**email** | **str** | Owner's email. | [optional]
}
## Example
```python
from sailpoint.v3.models.access_apps_owner import AccessAppsOwner
access_apps_owner = AccessAppsOwner(
type='IDENTITY',
id='2c9180a46faadee4016fb4e018c20639',
name='John Doe',
email='john.doe@sailpoint.com'
)
```
[[Back to top]](#)

55
docs/tools/sdk/python/Reference/V3/Models/AccessModelMetadata.md Normal file
View File

@@ -0,0 +1,55 @@
---
id: access-model-metadata
title: AccessModelMetadata
pagination_label: AccessModelMetadata
sidebar_label: AccessModelMetadata
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessModelMetadata', 'AccessModelMetadata']
slug: /tools/sdk/python/v3/models/access-model-metadata
tags: ['SDK', 'Software Development Kit', 'AccessModelMetadata', 'AccessModelMetadata']
---
# AccessModelMetadata
Metadata that describes an access item
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**key** | **str** | Unique identifier for the metadata type | [optional]
**name** | **str** | Human readable name of the metadata type | [optional]
**multiselect** | **bool** | Allows selecting multiple values | [optional] [default to False]
**status** | **str** | The state of the metadata item | [optional]
**type** | **str** | The type of the metadata item | [optional]
**object_types** | **[]str** | The types of objects | [optional]
**description** | **str** | Describes the metadata item | [optional]
**values** | [**[]AccessModelMetadataValuesInner**](access-model-metadata-values-inner) | The value to assign to the metadata item | [optional]
}
## Example
```python
from sailpoint.v3.models.access_model_metadata import AccessModelMetadata
access_model_metadata = AccessModelMetadata(
key='iscCsp',
name='CSP',
multiselect=True,
status='active',
type='governance',
object_types=[
'general'
],
description='Indicates the type of deployment environment of an access item.',
values=[
sailpoint.v3.models.access_model_metadata_values_inner.AccessModelMetadata_values_inner(
value = 'development',
name = 'Development',
status = 'active', )
]
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/V3/Models/AccessModelMetadataValuesInner.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: access-model-metadata-values-inner
title: AccessModelMetadataValuesInner
pagination_label: AccessModelMetadataValuesInner
sidebar_label: AccessModelMetadataValuesInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessModelMetadataValuesInner', 'AccessModelMetadataValuesInner']
slug: /tools/sdk/python/v3/models/access-model-metadata-values-inner
tags: ['SDK', 'Software Development Kit', 'AccessModelMetadataValuesInner', 'AccessModelMetadataValuesInner']
---
# AccessModelMetadataValuesInner
An individual value to assign to the metadata item
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**value** | **str** | The value to assign to the metdata item | [optional]
**name** | **str** | Display name of the value | [optional]
**status** | **str** | The status of the individual value | [optional]
}
## Example
```python
from sailpoint.v3.models.access_model_metadata_values_inner import AccessModelMetadataValuesInner
access_model_metadata_values_inner = AccessModelMetadataValuesInner(
value='development',
name='Development',
status='active'
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/V3/Models/AccessProfileDocument.md
View File

@@ -17,8 +17,6 @@ More complete representation of an access profile.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Access profile's ID. | [required]
**name** | **str** | Access profile's name. | [required]
**description** | **str** | Access item's description. | [optional]
**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**modified** | **datetime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
@@ -26,12 +24,16 @@ Name | Type | Description | Notes
**enabled** | **bool** | Indicates whether the access item is currently enabled. | [optional] [default to False]
**requestable** | **bool** | Indicates whether the access item can be requested. | [optional] [default to True]
**request_comments_required** | **bool** | Indicates whether comments are required for requests to access the item. | [optional] [default to False]
**owner** | [**BaseAccessAllOfOwner**](base-access-all-of-owner) | | [optional]
**type** | **Enum** [ 'accessprofile', 'accountactivity', 'account', 'aggregation', 'entitlement', 'event', 'identity', 'role' ] | Access profile's document type. This enum represents the currently supported document types. Additional values may be added in the future without notice. | [required]
**owner** | [**BaseAccessOwner**](base-access-owner) | | [optional]
**id** | **str** | Access profile's ID. | [required]
**name** | **str** | Access profile's name. | [required]
**source** | [**AccessProfileDocumentAllOfSource**](access-profile-document-all-of-source) | | [optional]
**entitlements** | [**[]BaseEntitlement**](base-entitlement) | Entitlements the access profile has access to. | [optional]
**entitlement_count** | **int** | Number of entitlements. | [optional]
**segments** | [**[]BaseSegment**](base-segment) | Segments with the access profile. | [optional]
**segment_count** | **int** | Number of segments with the access profile. | [optional]
**tags** | **[]str** | Tags that have been applied to the object. | [optional]
**apps** | [**[]AccessApps**](access-apps) | Applications with the access profile | [optional]
}
## Example
@@ -40,21 +42,20 @@ Name | Type | Description | Notes
from sailpoint.v3.models.access_profile_document import AccessProfileDocument
access_profile_document = AccessProfileDocument(
id='2c9180825a6c1adc015a71c9023f0818',
name='Cloud Eng',
description='The admin role',
description='Admin access',
created='2018-06-25T20:22:28.104Z',
modified='2018-06-25T20:22:28.104Z',
synced='2018-06-25T20:22:33.104Z',
enabled=True,
requestable=True,
request_comments_required=False,
owner=sailpoint.v3.models.base_access_all_of_owner.BaseAccess_allOf_owner(
owner=sailpoint.v3.models.base_access_owner.BaseAccess_owner(
type = 'IDENTITY',
id = '2c9180a46faadee4016fb4e018c20639',
name = 'Support',
email = 'cloud-support@sailpoint.com', ),
type='accessprofile',
id='2c9180825a6c1adc015a71c9023f0818',
name='Cloud Eng',
source=sailpoint.v3.models.access_profile_document_all_of_source.AccessProfileDocument_allOf_source(
id = 'ff8081815757d4fb0157588f3d9d008f',
name = 'Employees', ),
@@ -70,7 +71,24 @@ entitlements=[
name = 'CN=Cloud Engineering,DC=sailpoint,DC=COM', )
],
entitlement_count=5,
tags=[TAG_1, TAG_2]
segments=[
sailpoint.v3.models.base_segment.BaseSegment(
id = 'b009b6e3-b56d-41d9-8735-cb532ea0b017',
name = 'Test Segment', )
],
segment_count=1,
tags=[TAG_1, TAG_2],
apps=[
sailpoint.v3.models.access_apps.AccessApps(
id = '2c91808568c529c60168cca6f90c1313',
name = 'Travel and Expense',
description = 'Travel and Expense Application',
owner = sailpoint.v3.models.access_apps_owner.AccessApps_owner(
type = 'IDENTITY',
id = '2c9180a46faadee4016fb4e018c20639',
name = 'John Doe',
email = 'john.doe@sailpoint.com', ), )
]
)
```

6
docs/tools/sdk/python/Reference/V3/Models/AccessProfileEntitlement.md
View File

@@ -20,9 +20,9 @@ Name | Type | Description | Notes
**id** | **str** | The unique ID of the referenced object. | [optional]
**name** | **str** | The human readable name of the referenced object. | [optional]
**display_name** | **str** | | [optional]
**type** | [**DtoType**](dto-type) | | [optional]
**description** | **str** | | [optional]
**description** | **str** | Description of access item. | [optional]
**source** | [**Reference**](reference) | | [optional]
**type** | **str** | Type of the access item. | [optional]
**privileged** | **bool** | | [optional]
**attribute** | **str** | | [optional]
**value** | **str** | | [optional]
@@ -38,11 +38,11 @@ access_profile_entitlement = AccessProfileEntitlement(
id='2c91808568c529c60168cca6f90c1313',
name='John Doe',
display_name='John Q. Doe',
type='IDENTITY',
description='',
source=sailpoint.v3.models.reference.Reference(
id = '2c91808568c529c60168cca6f90c1313',
name = 'John Doe', ),
type='ENTITLEMENT',
privileged=False,
attribute='memberOf',
value='CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com',

6
docs/tools/sdk/python/Reference/V3/Models/AccessProfileRole.md
View File

@@ -20,8 +20,8 @@ Name | Type | Description | Notes
**id** | **str** | The unique ID of the referenced object. | [optional]
**name** | **str** | The human readable name of the referenced object. | [optional]
**display_name** | **str** | | [optional]
**type** | [**DtoType**](dto-type) | | [optional]
**description** | **str** | | [optional]
**description** | **str** | Description of access item. | [optional]
**type** | **str** | Type of the access item. | [optional]
**owner** | [**DisplayReference**](display-reference) | | [optional]
**disabled** | **bool** | | [optional]
**revocable** | **bool** | | [optional]
@@ -36,8 +36,8 @@ access_profile_role = AccessProfileRole(
id='2c91808568c529c60168cca6f90c1313',
name='John Doe',
display_name='John Q. Doe',
type='IDENTITY',
description='',
type='ROLE',
owner=,
disabled=True,
revocable=True

6
docs/tools/sdk/python/Reference/V3/Models/AccessProfileSummary.md
View File

@@ -20,8 +20,8 @@ Name | Type | Description | Notes
**id** | **str** | The unique ID of the referenced object. | [optional]
**name** | **str** | The human readable name of the referenced object. | [optional]
**display_name** | **str** | | [optional]
**type** | [**DtoType**](dto-type) | | [optional]
**description** | **str** | | [optional]
**description** | **str** | Description of access item. | [optional]
**type** | **str** | Type of the access item. | [optional]
**source** | [**Reference**](reference) | | [optional]
**owner** | [**DisplayReference**](display-reference) | | [optional]
**revocable** | **bool** | | [optional]
@@ -36,8 +36,8 @@ access_profile_summary = AccessProfileSummary(
id='2c91808568c529c60168cca6f90c1313',
name='John Doe',
display_name='John Q. Doe',
type='IDENTITY',
description='',
type='ACCESS_PROFILE',
source=sailpoint.v3.models.reference.Reference(
id = '2c91808568c529c60168cca6f90c1313',
name = 'John Doe', ),

29
docs/tools/sdk/python/Reference/V3/Models/Account.md
View File

@@ -27,7 +27,7 @@ Name | Type | Description | Notes
**identity_state** | **str** | The identity state of the identity this account is correlated to | [optional]
**connection_type** | **str** | The connection type of the source this account is from | [optional]
**is_machine** | **bool** | Indicates if the account is of machine type | [optional] [default to False]
**recommendation** | [**Recommendation**](recommendation) | | [optional]
**recommendation** | [**AccountAllOfRecommendation**](account-all-of-recommendation) | | [optional]
**attributes** | **map[string]object** | The account attributes that are aggregated | [required]
**authoritative** | **bool** | Indicates if this account is from an authoritative source | [required]
**description** | **str** | A description of the account | [optional]
@@ -39,11 +39,11 @@ Name | Type | Description | Notes
**uuid** | **str** | The unique ID of the account as determined by the account schema | [optional]
**manually_correlated** | **bool** | Indicates if the account has been manually correlated to an identity | [required]
**has_entitlements** | **bool** | Indicates if the account has entitlements | [required]
**identity** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
**source_owner** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
**identity** | [**AccountAllOfIdentity**](account-all-of-identity) | | [optional]
**source_owner** | [**AccountAllOfSourceOwner**](account-all-of-source-owner) | | [optional]
**features** | **str** | A string list containing the owning source's features | [optional]
**origin** | **Enum** [ 'AGGREGATED', 'PROVISIONED' ] | The origin of the account either aggregated or provisioned | [optional]
**owner_identity** | [**BaseReferenceDto**](base-reference-dto) | | [optional]
**owner_identity** | [**AccountAllOfOwnerIdentity**](account-all-of-owner-identity) | | [optional]
}
## Example
@@ -63,9 +63,7 @@ cloud_lifecycle_state='active',
identity_state='ACTIVE',
connection_type='direct',
is_machine=True,
recommendation=sailpoint.v3.models.recommendation.Recommendation(
type = 'MACHINE',
method = 'DISCOVERY', ),
recommendation=,
attributes={firstName=SailPoint, lastName=Support, displayName=SailPoint Support},
authoritative=False,
description='',
@@ -77,20 +75,17 @@ uncorrelated=False,
uuid='{b0dce506-d6d4-44d2-8a32-d9a5b21fb175}',
manually_correlated=False,
has_entitlements=True,
identity=sailpoint.v3.models.base_reference_dto.BaseReferenceDto(
identity=sailpoint.v3.models.account_all_of_identity.Account_allOf_identity(
id = '2c918084660f45d6016617daa9210584',
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'William Wilson', ),
source_owner=sailpoint.v3.models.base_reference_dto.BaseReferenceDto(
name = 'John Doe', ),
source_owner=sailpoint.v3.models.account_all_of_source_owner.Account_allOf_sourceOwner(
id = '2c918084660f45d6016617daa9210584',
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'William Wilson', ),
name = 'Adam Kennedy', ),
features='ENABLE',
origin='AGGREGATED',
owner_identity=sailpoint.v3.models.base_reference_dto.BaseReferenceDto(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'William Wilson', )
owner_identity=
)
```

41
docs/tools/sdk/python/Reference/V3/Models/AccountActivityDocument.md
View File

@@ -17,17 +17,15 @@ AccountActivity
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | | [required]
**name** | **str** | | [required]
**type** | [**DocumentType**](document-type) | | [required]
**id** | **str** | ID of account activity. | [optional]
**action** | **str** | Type of action performed in the activity. | [optional]
**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**modified** | **datetime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
**synced** | **str** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional]
**stage** | **str** | Activity's current stage. | [optional]
**origin** | **str** | Activity's origin. | [optional]
**status** | **str** | Activity's current status. | [optional]
**requester** | [**AccountSource**](account-source) | | [optional]
**recipient** | [**AccountSource**](account-source) | | [optional]
**requester** | [**ActivityIdentity**](activity-identity) | | [optional]
**recipient** | [**ActivityIdentity**](activity-identity) | | [optional]
**tracking_number** | **str** | Account activity's tracking number. | [optional]
**errors** | **[]str** | Errors provided by the source while completing account actions. | [optional]
**warnings** | **[]str** | Warnings provided by the source while completing account actions. | [optional]
@@ -45,13 +43,11 @@ from sailpoint.v3.models.account_activity_document import AccountActivityDocumen
account_activity_document = AccountActivityDocument(
id='2c91808375d8e80a0175e1f88a575222',
name='john.doe',
type='identity',
action='Identity Refresh.',
created='2018-06-25T20:22:28.104Z',
modified='2018-06-25T20:22:28.104Z',
synced='2018-06-25T20:22:28.104Z',
stage='Completed',
origin='',
status='Complete',
requester=,
recipient=,
@@ -70,20 +66,25 @@ approvals=[
commenter = 'Automated AR Approval',
date = '2018-06-25T20:22:28.104Z', )
],
created = '2018-06-25T20:22:28.104Z',
modified = '2018-06-25T20:22:28.104Z',
owner = null,
result = 'Finished',
type = '', )
attribute_request = sailpoint.v3.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = null, ),
source = null, )
],
original_requests=[
sailpoint.v3.models.original_request.OriginalRequest(
account_id = 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com',
result = sailpoint.v3.models.result.Result(
status = 'Manual Task Created', ),
attribute_requests = [
sailpoint.v3.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = '3203537556531076', )
value = null, )
],
op = 'add',
source = null, )
@@ -93,13 +94,13 @@ expansion_items=[
account_id = '2c91808981f58ea601821c3e93482e6f',
cause = 'Role',
name = 'smartsheet-role',
attribute_requests = [
sailpoint.v3.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = '3203537556531076', )
],
source = null, )
attribute_request = sailpoint.v3.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = null, ),
source = null,
id = 'ac2887ffe0e7435a8c18c73f7ae94c7b',
state = 'EXECUTING', )
],
account_requests=[
sailpoint.v3.models.account_request.AccountRequest(
@@ -108,7 +109,7 @@ account_requests=[
sailpoint.v3.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = '3203537556531076', )
value = null, )
],
op = 'Modify',
provisioning_target = null,

41
docs/tools/sdk/python/Reference/V3/Models/AccountActivitySearchedItem.md
View File

@@ -17,17 +17,15 @@ AccountActivity
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | | [required]
**name** | **str** | | [required]
**type** | [**DocumentType**](document-type) | | [required]
**id** | **str** | ID of account activity. | [optional]
**action** | **str** | Type of action performed in the activity. | [optional]
**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**modified** | **datetime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
**synced** | **str** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional]
**stage** | **str** | Activity's current stage. | [optional]
**origin** | **str** | Activity's origin. | [optional]
**status** | **str** | Activity's current status. | [optional]
**requester** | [**AccountSource**](account-source) | | [optional]
**recipient** | [**AccountSource**](account-source) | | [optional]
**requester** | [**ActivityIdentity**](activity-identity) | | [optional]
**recipient** | [**ActivityIdentity**](activity-identity) | | [optional]
**tracking_number** | **str** | Account activity's tracking number. | [optional]
**errors** | **[]str** | Errors provided by the source while completing account actions. | [optional]
**warnings** | **[]str** | Warnings provided by the source while completing account actions. | [optional]
@@ -45,13 +43,11 @@ from sailpoint.v3.models.account_activity_searched_item import AccountActivitySe
account_activity_searched_item = AccountActivitySearchedItem(
id='2c91808375d8e80a0175e1f88a575222',
name='john.doe',
type='identity',
action='Identity Refresh.',
created='2018-06-25T20:22:28.104Z',
modified='2018-06-25T20:22:28.104Z',
synced='2018-06-25T20:22:28.104Z',
stage='Completed',
origin='',
status='Complete',
requester=,
recipient=,
@@ -70,20 +66,25 @@ approvals=[
commenter = 'Automated AR Approval',
date = '2018-06-25T20:22:28.104Z', )
],
created = '2018-06-25T20:22:28.104Z',
modified = '2018-06-25T20:22:28.104Z',
owner = null,
result = 'Finished',
type = '', )
attribute_request = sailpoint.v3.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = null, ),
source = null, )
],
original_requests=[
sailpoint.v3.models.original_request.OriginalRequest(
account_id = 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com',
result = sailpoint.v3.models.result.Result(
status = 'Manual Task Created', ),
attribute_requests = [
sailpoint.v3.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = '3203537556531076', )
value = null, )
],
op = 'add',
source = null, )
@@ -93,13 +94,13 @@ expansion_items=[
account_id = '2c91808981f58ea601821c3e93482e6f',
cause = 'Role',
name = 'smartsheet-role',
attribute_requests = [
sailpoint.v3.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = '3203537556531076', )
],
source = null, )
attribute_request = sailpoint.v3.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = null, ),
source = null,
id = 'ac2887ffe0e7435a8c18c73f7ae94c7b',
state = 'EXECUTING', )
],
account_requests=[
sailpoint.v3.models.account_request.AccountRequest(
@@ -108,7 +109,7 @@ account_requests=[
sailpoint.v3.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = '3203537556531076', )
value = null, )
],
op = 'Modify',
provisioning_target = null,

38
docs/tools/sdk/python/Reference/V3/Models/AccountAllOfIdentity.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: account-all-of-identity
title: AccountAllOfIdentity
pagination_label: AccountAllOfIdentity
sidebar_label: AccountAllOfIdentity
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountAllOfIdentity', 'AccountAllOfIdentity']
slug: /tools/sdk/python/v3/models/account-all-of-identity
tags: ['SDK', 'Software Development Kit', 'AccountAllOfIdentity', 'AccountAllOfIdentity']
---
# AccountAllOfIdentity
The identity this account is correlated to
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The ID of the identity | [optional]
**type** | **Enum** [ 'IDENTITY' ] | The type of object being referenced | [optional]
**name** | **str** | display name of identity | [optional]
}
## Example
```python
from sailpoint.v3.models.account_all_of_identity import AccountAllOfIdentity
account_all_of_identity = AccountAllOfIdentity(
id='2c918084660f45d6016617daa9210584',
type='IDENTITY',
name='John Doe'
)
```
[[Back to top]](#)

37
docs/tools/sdk/python/Reference/V3/Models/AccountAllOfOwnerIdentity.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: account-all-of-owner-identity
title: AccountAllOfOwnerIdentity
pagination_label: AccountAllOfOwnerIdentity
sidebar_label: AccountAllOfOwnerIdentity
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountAllOfOwnerIdentity', 'AccountAllOfOwnerIdentity']
slug: /tools/sdk/python/v3/models/account-all-of-owner-identity
tags: ['SDK', 'Software Development Kit', 'AccountAllOfOwnerIdentity', 'AccountAllOfOwnerIdentity']
---
# AccountAllOfOwnerIdentity
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | [**DtoType**](dto-type) | | [optional]
**id** | **str** | ID of the object to which this reference applies | [optional]
**name** | **str** | Human-readable display name of the object to which this reference applies | [optional]
}
## Example
```python
from sailpoint.v3.models.account_all_of_owner_identity import AccountAllOfOwnerIdentity
account_all_of_owner_identity = AccountAllOfOwnerIdentity(
type='IDENTITY',
id='2c91808568c529c60168cca6f90c1313',
name='William Wilson'
)
```
[[Back to top]](#)

35
docs/tools/sdk/python/Reference/V3/Models/AccountAllOfRecommendation.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: account-all-of-recommendation
title: AccountAllOfRecommendation
pagination_label: AccountAllOfRecommendation
sidebar_label: AccountAllOfRecommendation
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountAllOfRecommendation', 'AccountAllOfRecommendation']
slug: /tools/sdk/python/v3/models/account-all-of-recommendation
tags: ['SDK', 'Software Development Kit', 'AccountAllOfRecommendation', 'AccountAllOfRecommendation']
---
# AccountAllOfRecommendation
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'HUMAN', 'MACHINE' ] | Recommended type of account. | [required]
**method** | **Enum** [ 'DISCOVERY', 'SOURCE', 'CRITERIA' ] | Method used to produce the recommendation. DISCOVERY - suggested by AI, SOURCE - the account comes from a source flagged as containing machine accounts, CRITERIA - the account satisfies classification criteria. | [required]
}
## Example
```python
from sailpoint.v3.models.account_all_of_recommendation import AccountAllOfRecommendation
account_all_of_recommendation = AccountAllOfRecommendation(
type='MACHINE',
method='DISCOVERY'
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/V3/Models/AccountAllOfSourceOwner.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: account-all-of-source-owner
title: AccountAllOfSourceOwner
pagination_label: AccountAllOfSourceOwner
sidebar_label: AccountAllOfSourceOwner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountAllOfSourceOwner', 'AccountAllOfSourceOwner']
slug: /tools/sdk/python/v3/models/account-all-of-source-owner
tags: ['SDK', 'Software Development Kit', 'AccountAllOfSourceOwner', 'AccountAllOfSourceOwner']
---
# AccountAllOfSourceOwner
The owner of the source this account belongs to.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The ID of the identity | [optional]
**type** | **Enum** [ 'IDENTITY' ] | The type of object being referenced | [optional]
**name** | **str** | display name of identity | [optional]
}
## Example
```python
from sailpoint.v3.models.account_all_of_source_owner import AccountAllOfSourceOwner
account_all_of_source_owner = AccountAllOfSourceOwner(
id='2c918084660f45d6016617daa9210584',
type='IDENTITY',
name='Adam Kennedy'
)
```
[[Back to top]](#)

2
docs/tools/sdk/python/Reference/V3/Models/AccountRequest.md
View File

@@ -35,7 +35,7 @@ attribute_requests=[
sailpoint.v3.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = '3203537556531076', )
value = null, )
],
op='Modify',
provisioning_target=,

4
docs/tools/sdk/python/Reference/V3/Models/AccountRequestResult.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountRequestResult', 'AccountReques
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**errors** | **[]str** | | [optional]
**errors** | **[]str** | Error message. | [optional]
**status** | **str** | The status of the account request | [optional]
**ticket_id** | **str** | | [optional]
**ticket_id** | **str** | ID of associated ticket. | [optional]
}
## Example

37
docs/tools/sdk/python/Reference/V3/Models/ActivityIdentity.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: activity-identity
title: ActivityIdentity
pagination_label: ActivityIdentity
sidebar_label: ActivityIdentity
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ActivityIdentity', 'ActivityIdentity']
slug: /tools/sdk/python/v3/models/activity-identity
tags: ['SDK', 'Software Development Kit', 'ActivityIdentity', 'ActivityIdentity']
---
# ActivityIdentity
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique ID of the referenced object. | [optional]
**name** | **str** | The human readable name of the referenced object. | [optional]
**type** | **str** | Type of object | [optional]
}
## Example
```python
from sailpoint.v3.models.activity_identity import ActivityIdentity
activity_identity = ActivityIdentity(
id='2c91808568c529c60168cca6f90c1313',
name='John Doe',
type='Identity'
)
```
[[Back to top]](#)

2
docs/tools/sdk/python/Reference/V3/Models/AggregationResult.md
View File

@@ -28,7 +28,7 @@ from sailpoint.v3.models.aggregation_result import AggregationResult
aggregation_result = AggregationResult(
aggregations={Identity Locations={buckets=[{key=Austin, doc_count=109}, {key=London, doc_count=64}, {key=San Jose, doc_count=27}, {key=Brussels, doc_count=26}, {key=Sao Paulo, doc_count=24}, {key=Munich, doc_count=23}, {key=Singapore, doc_count=22}, {key=Tokyo, doc_count=20}, {key=Taipei, doc_count=16}]}},
hits=[
sailpoint.v3.models.search_document.SearchDocument()
sailpoint.v3.models.search_documents.SearchDocuments()
]
)

13
docs/tools/sdk/python/Reference/V3/Models/Approval.md
View File

@@ -17,11 +17,11 @@ tags: ['SDK', 'Software Development Kit', 'Approval', 'Approval']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**comments** | [**[]ApprovalComment**](approval-comment) | | [optional]
**created** | **datetime** | A date-time in ISO-8601 format | [optional]
**modified** | **datetime** | A date-time in ISO-8601 format | [optional]
**owner** | [**AccountSource**](account-source) | | [optional]
**owner** | [**ActivityIdentity**](activity-identity) | | [optional]
**result** | **str** | The result of the approval | [optional]
**type** | **str** | | [optional]
**attribute_request** | [**AttributeRequest**](attribute-request) | | [optional]
**source** | [**AccountSource**](account-source) | | [optional]
}
## Example
@@ -36,11 +36,14 @@ comments=[
commenter = 'Automated AR Approval',
date = '2018-06-25T20:22:28.104Z', )
],
created='2018-06-25T20:22:28.104Z',
modified='2018-06-25T20:22:28.104Z',
owner=,
result='Finished',
type=''
attribute_request=sailpoint.v3.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = null, ),
source=
)
```

4
docs/tools/sdk/python/Reference/V3/Models/AttributeRequest.md
View File

@@ -18,7 +18,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Attribute name. | [optional]
**op** | **str** | Operation to perform on attribute. | [optional]
**value** | **str** | Value of attribute. | [optional]
**value** | [**AttributeRequestValue**](attribute-request-value) | | [optional]
}
## Example
@@ -29,7 +29,7 @@ from sailpoint.v3.models.attribute_request import AttributeRequest
attribute_request = AttributeRequest(
name='groups',
op='Add',
value='3203537556531076'
value=
)
```

32
docs/tools/sdk/python/Reference/V3/Models/AttributeRequestValue.md Normal file
View File

@@ -0,0 +1,32 @@
---
id: attribute-request-value
title: AttributeRequestValue
pagination_label: AttributeRequestValue
sidebar_label: AttributeRequestValue
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AttributeRequestValue', 'AttributeRequestValue']
slug: /tools/sdk/python/v3/models/attribute-request-value
tags: ['SDK', 'Software Development Kit', 'AttributeRequestValue', 'AttributeRequestValue']
---
# AttributeRequestValue
Value of attribute.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
}
## Example
```python
from sailpoint.v3.models.attribute_request_value import AttributeRequestValue
attribute_request_value = AttributeRequestValue(
)
```
[[Back to top]](#)

4
docs/tools/sdk/python/Reference/V3/Models/AuthUser.md
View File

@@ -29,9 +29,10 @@ Name | Type | Description | Notes
**lastname** | **str** | Auth user's last name. | [optional]
**display_name** | **str** | Auth user's name in displayed format. | [optional]
**alias** | **str** | Auth user's alias. | [optional]
**last_password_change_date** | **str** | Date of last password change. | [optional]
**last_password_change_date** | **datetime** | Date of last password change. | [optional]
**last_login_timestamp** | **int** | Timestamp of the last login (long type value). | [optional]
**current_login_timestamp** | **int** | Timestamp of the current login (long type value). | [optional]
**last_unlock_timestamp** | **datetime** | The date and time when the user was last unlocked. | [optional]
**capabilities** | **[]str** | Array of the auth user's capabilities. | [optional]
}
@@ -57,6 +58,7 @@ alias='will.smith',
last_password_change_date='2021-03-08T22:37:33.901Z',
last_login_timestamp=1656327185832,
current_login_timestamp=1656327185832,
last_unlock_timestamp='2021-03-08T22:37:33.901Z',
capabilities=[
'ORG_ADMIN'
]

10
docs/tools/sdk/python/Reference/V3/Models/BaseAccess.md
View File

@@ -16,8 +16,6 @@ tags: ['SDK', 'Software Development Kit', 'BaseAccess', 'BaseAccess']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique ID of the referenced object. | [optional]
**name** | **str** | The human readable name of the referenced object. | [optional]
**description** | **str** | Access item's description. | [optional]
**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**modified** | **datetime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
@@ -25,7 +23,7 @@ Name | Type | Description | Notes
**enabled** | **bool** | Indicates whether the access item is currently enabled. | [optional] [default to False]
**requestable** | **bool** | Indicates whether the access item can be requested. | [optional] [default to True]
**request_comments_required** | **bool** | Indicates whether comments are required for requests to access the item. | [optional] [default to False]
**owner** | [**BaseAccessAllOfOwner**](base-access-all-of-owner) | | [optional]
**owner** | [**BaseAccessOwner**](base-access-owner) | | [optional]
}
## Example
@@ -34,16 +32,14 @@ Name | Type | Description | Notes
from sailpoint.v3.models.base_access import BaseAccess
base_access = BaseAccess(
id='2c91808568c529c60168cca6f90c1313',
name='John Doe',
description='The admin role',
description='Admin access',
created='2018-06-25T20:22:28.104Z',
modified='2018-06-25T20:22:28.104Z',
synced='2018-06-25T20:22:33.104Z',
enabled=True,
requestable=True,
request_comments_required=False,
owner=sailpoint.v3.models.base_access_all_of_owner.BaseAccess_allOf_owner(
owner=sailpoint.v3.models.base_access_owner.BaseAccess_owner(
type = 'IDENTITY',
id = '2c9180a46faadee4016fb4e018c20639',
name = 'Support',

20
docs/tools/sdk/python/Reference/V3/Models/BaseAccessAllOfOwner.md → docs/tools/sdk/python/Reference/V3/Models/BaseAccessOwner.md
View File

@@ -1,15 +1,15 @@
---
id: base-access-all-of-owner
title: BaseAccessAllOfOwner
pagination_label: BaseAccessAllOfOwner
sidebar_label: BaseAccessAllOfOwner
id: base-access-owner
title: BaseAccessOwner
pagination_label: BaseAccessOwner
sidebar_label: BaseAccessOwner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'BaseAccessAllOfOwner', 'BaseAccessAllOfOwner']
slug: /tools/sdk/python/v3/models/base-access-all-of-owner
tags: ['SDK', 'Software Development Kit', 'BaseAccessAllOfOwner', 'BaseAccessAllOfOwner']
keywords: ['python', 'Python', 'sdk', 'BaseAccessOwner', 'BaseAccessOwner']
slug: /tools/sdk/python/v3/models/base-access-owner
tags: ['SDK', 'Software Development Kit', 'BaseAccessOwner', 'BaseAccessOwner']
---
# BaseAccessAllOfOwner
# BaseAccessOwner
Owner's identity.
@@ -26,9 +26,9 @@ Name | Type | Description | Notes
## Example
```python
from sailpoint.v3.models.base_access_all_of_owner import BaseAccessAllOfOwner
from sailpoint.v3.models.base_access_owner import BaseAccessOwner
base_access_all_of_owner = BaseAccessAllOfOwner(
base_access_owner = BaseAccessOwner(
type='IDENTITY',
id='2c9180a46faadee4016fb4e018c20639',
name='Support',

6
docs/tools/sdk/python/Reference/V3/Models/BaseAccount.md
View File

@@ -27,6 +27,8 @@ Name | Type | Description | Notes
**password_last_set** | **datetime** | A date-time in ISO-8601 format | [optional]
**entitlement_attributes** | **map[string]object** | Map or dictionary of key/value pairs. | [optional]
**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**supports_password_change** | **bool** | Indicates whether the account supports password change. | [optional] [default to False]
**account_attributes** | **map[string]object** | Map or dictionary of key/value pairs. | [optional]
}
## Example
@@ -45,7 +47,9 @@ privileged=False,
manually_correlated=False,
password_last_set='2018-06-25T20:22:28.104Z',
entitlement_attributes={moderator=true, admin=true, trust_level=4},
created='2018-06-25T20:22:28.104Z'
created='2018-06-25T20:22:28.104Z',
supports_password_change=False,
account_attributes={type=global, admin=true, trust_level=4}
)
```

8
docs/tools/sdk/python/Reference/V3/Models/BaseDocument.md
View File

@@ -16,9 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'BaseDocument', 'BaseDocument']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | | [required]
**name** | **str** | | [required]
**type** | [**DocumentType**](document-type) | | [required]
**id** | **str** | ID of the referenced object. | [required]
**name** | **str** | The human readable name of the referenced object. | [required]
}
## Example
@@ -28,8 +27,7 @@ from sailpoint.v3.models.base_document import BaseDocument
base_document = BaseDocument(
id='2c91808375d8e80a0175e1f88a575222',
name='john.doe',
type='identity'
name='john.doe'
)
```

35
docs/tools/sdk/python/Reference/V3/Models/DocumentType.md
View File

@@ -1,35 +0,0 @@
---
id: document-type
title: DocumentType
pagination_label: DocumentType
sidebar_label: DocumentType
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'DocumentType', 'DocumentType']
slug: /tools/sdk/python/v3/models/document-type
tags: ['SDK', 'Software Development Kit', 'DocumentType', 'DocumentType']
---
# DocumentType
Enum representing the currently supported document types. Additional values may be added in the future without notice.
## Enum
* `ACCESSPROFILE` (value: `'accessprofile'`)
* `ACCOUNTACTIVITY` (value: `'accountactivity'`)
* `ACCOUNT` (value: `'account'`)
* `AGGREGATION` (value: `'aggregation'`)
* `ENTITLEMENT` (value: `'entitlement'`)
* `EVENT` (value: `'event'`)
* `IDENTITY` (value: `'identity'`)
* `ROLE` (value: `'role'`)
[[Back to top]](#)

29
docs/tools/sdk/python/Reference/V3/Models/Entitlement.md
View File

@@ -24,6 +24,10 @@ Name | Type | Description | Notes
**description** | **str** | The description of the entitlement | [optional]
**privileged** | **bool** | True if the entitlement is privileged | [optional]
**cloud_governed** | **bool** | True if the entitlement is cloud governed | [optional]
**requestable** | **bool** | True if the entitlement is able to be directly requested | [optional] [default to False]
**owner** | [**EntitlementOwner**](entitlement-owner) | | [optional]
**manually_updated_fields** | **map[string]object** | A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated. | [optional]
**access_model_metadata** | [**EntitlementAccessModelMetadata**](entitlement-access-model-metadata) | | [optional]
**created** | **datetime** | Time when the entitlement was created | [optional]
**modified** | **datetime** | Time when the entitlement was last modified | [optional]
**source** | [**EntitlementSource**](entitlement-source) | | [optional]
@@ -46,6 +50,31 @@ source_schema_object_type='group',
description='CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local',
privileged=True,
cloud_governed=True,
requestable=True,
owner=sailpoint.v3.models.entitlement_owner.Entitlement_owner(
id = '2c9180827ca885d7017ca8ce28a000eb',
type = 'IDENTITY',
name = 'john.doe', ),
manually_updated_fields={DISPLAY_NAME=true, DESCRIPTION=true},
access_model_metadata=sailpoint.v3.models.entitlement_access_model_metadata.Entitlement_accessModelMetadata(
attributes = [
sailpoint.v3.models.access_model_metadata.AccessModelMetadata(
key = 'iscCsp',
name = 'CSP',
multiselect = True,
status = 'active',
type = 'governance',
object_types = [
'general'
],
description = 'Indicates the type of deployment environment of an access item.',
values = [
sailpoint.v3.models.access_model_metadata_values_inner.AccessModelMetadata_values_inner(
value = 'development',
name = 'Development',
status = 'active', )
], )
], ),
created='2020-10-08T18:33:52.029Z',
modified='2020-10-08T18:33:52.029Z',
source=sailpoint.v3.models.entitlement_source.Entitlement_source(

51
docs/tools/sdk/python/Reference/V3/Models/EntitlementAccessModelMetadata.md Normal file
View File

@@ -0,0 +1,51 @@
---
id: entitlement-access-model-metadata
title: EntitlementAccessModelMetadata
pagination_label: EntitlementAccessModelMetadata
sidebar_label: EntitlementAccessModelMetadata
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'EntitlementAccessModelMetadata', 'EntitlementAccessModelMetadata']
slug: /tools/sdk/python/v3/models/entitlement-access-model-metadata
tags: ['SDK', 'Software Development Kit', 'EntitlementAccessModelMetadata', 'EntitlementAccessModelMetadata']
---
# EntitlementAccessModelMetadata
Additional data to classify the entitlement
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attributes** | [**[]AccessModelMetadata**](access-model-metadata) | | [optional]
}
## Example
```python
from sailpoint.v3.models.entitlement_access_model_metadata import EntitlementAccessModelMetadata
entitlement_access_model_metadata = EntitlementAccessModelMetadata(
attributes=[
sailpoint.v3.models.access_model_metadata.AccessModelMetadata(
key = 'iscCsp',
name = 'CSP',
multiselect = True,
status = 'active',
type = 'governance',
object_types = [
'general'
],
description = 'Indicates the type of deployment environment of an access item.',
values = [
sailpoint.v3.models.access_model_metadata_values_inner.AccessModelMetadata_values_inner(
value = 'development',
name = 'Development',
status = 'active', )
], )
]
)
```
[[Back to top]](#)

45
docs/tools/sdk/python/Reference/V3/Models/EntitlementDocument.md
View File

@@ -17,21 +17,29 @@ Entitlement
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | | [required]
**name** | **str** | | [required]
**type** | [**DocumentType**](document-type) | | [required]
**id** | **str** | ID of the referenced object. | [required]
**name** | **str** | The human readable name of the referenced object. | [required]
**modified** | **datetime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
**synced** | **str** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional]
**display_name** | **str** | Entitlement's display name. | [optional]
**source** | [**EntitlementDocumentAllOfSource**](entitlement-document-all-of-source) | | [optional]
**segments** | [**[]BaseSegment**](base-segment) | Segments with the role. | [optional]
**segments** | [**[]BaseSegment**](base-segment) | Segments with the entitlement. | [optional]
**segment_count** | **int** | Number of segments with the role. | [optional]
**requestable** | **bool** | Indicates whether the entitlement is requestable. | [optional] [default to False]
**cloud_governed** | **bool** | Indicates whether the entitlement is cloud governed. | [optional] [default to False]
**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**privileged** | **bool** | Indicates whether the entitlement is privileged. | [optional] [default to False]
**identity_count** | **int** | Number of identities who have access to the entitlement. | [optional]
**tags** | **[]str** | Tags that have been applied to the object. | [optional]
**attribute** | **str** | Attribute information for the entitlement. | [optional]
**value** | **str** | Value of the entitlement. | [optional]
**source_schema_object_type** | **str** | Source schema object type of the entitlement. | [optional]
**var_schema** | **str** | Schema type of the entitlement. | [optional]
**hash** | **str** | Read-only calculated hash value of an entitlement. | [optional]
**attributes** | **map[string]object** | Attributes of the entitlement. | [optional]
**truncated_attributes** | **[]str** | Truncated attributes of the entitlement. | [optional]
**contains_data_access** | **bool** | Indicates whether the entitlement contains data access. | [optional] [default to False]
**manually_updated_fields** | [**EntitlementDocumentAllOfManuallyUpdatedFields**](entitlement-document-all-of-manually-updated-fields) | | [optional]
**permissions** | [**[]EntitlementDocumentAllOfPermissions**](entitlement-document-all-of-permissions) | | [optional]
}
## Example
@@ -42,13 +50,13 @@ from sailpoint.v3.models.entitlement_document import EntitlementDocument
entitlement_document = EntitlementDocument(
id='2c91808375d8e80a0175e1f88a575222',
name='john.doe',
type='identity',
modified='2018-06-25T20:22:28.104Z',
synced='',
display_name='Admin',
source=sailpoint.v3.models.entitlement_document_all_of_source.EntitlementDocument_allOf_source(
id = '2c91808b6e9e6fb8016eec1a2b6f7b5f',
name = 'ODS-HR-Employees', ),
name = 'ODS-HR-Employees',
type = 'SOURCE', ),
segments=[
sailpoint.v3.models.base_segment.BaseSegment(
id = 'b009b6e3-b56d-41d9-8735-cb532ea0b017',
@@ -59,8 +67,27 @@ requestable=False,
cloud_governed=False,
created='2018-06-25T20:22:28.104Z',
privileged=False,
identity_count=3,
tags=[TAG_1, TAG_2]
tags=[TAG_1, TAG_2],
attribute='groups',
value='1733ff75-441e-4327-9bfc-3ac445fd8cd1',
source_schema_object_type='group',
var_schema='group',
hash='c6fab95235584cca98a454a2f51e5683bc77d6a0',
attributes={ },
truncated_attributes=[
''
],
contains_data_access=True,
manually_updated_fields=sailpoint.v3.models.entitlement_document_all_of_manually_updated_fields.EntitlementDocument_allOf_manuallyUpdatedFields(
description = False,
display_name = False, ),
permissions=[
sailpoint.v3.models.entitlement_document_all_of_permissions.EntitlementDocument_allOf_permissions(
target = 'SYS.GV_$TRANSACTION',
rights = [
'SELECT'
], )
]
)
```

36
docs/tools/sdk/python/Reference/V3/Models/EntitlementDocumentAllOfManuallyUpdatedFields.md Normal file
View File

@@ -0,0 +1,36 @@
---
id: entitlement-document-all-of-manually-updated-fields
title: EntitlementDocumentAllOfManuallyUpdatedFields
pagination_label: EntitlementDocumentAllOfManuallyUpdatedFields
sidebar_label: EntitlementDocumentAllOfManuallyUpdatedFields
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'EntitlementDocumentAllOfManuallyUpdatedFields', 'EntitlementDocumentAllOfManuallyUpdatedFields']
slug: /tools/sdk/python/v3/models/entitlement-document-all-of-manually-updated-fields
tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfManuallyUpdatedFields', 'EntitlementDocumentAllOfManuallyUpdatedFields']
---
# EntitlementDocumentAllOfManuallyUpdatedFields
Indicates whether the entitlement's display name and/or description have been manually updated.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**description** | **bool** | | [optional] [default to False]
**display_name** | **bool** | | [optional] [default to False]
}
## Example
```python
from sailpoint.v3.models.entitlement_document_all_of_manually_updated_fields import EntitlementDocumentAllOfManuallyUpdatedFields
entitlement_document_all_of_manually_updated_fields = EntitlementDocumentAllOfManuallyUpdatedFields(
description=False,
display_name=False
)
```
[[Back to top]](#)

37
docs/tools/sdk/python/Reference/V3/Models/EntitlementDocumentAllOfPermissions.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: entitlement-document-all-of-permissions
title: EntitlementDocumentAllOfPermissions
pagination_label: EntitlementDocumentAllOfPermissions
sidebar_label: EntitlementDocumentAllOfPermissions
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'EntitlementDocumentAllOfPermissions', 'EntitlementDocumentAllOfPermissions']
slug: /tools/sdk/python/v3/models/entitlement-document-all-of-permissions
tags: ['SDK', 'Software Development Kit', 'EntitlementDocumentAllOfPermissions', 'EntitlementDocumentAllOfPermissions']
---
# EntitlementDocumentAllOfPermissions
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**target** | **str** | The target the permission would grants rights on. | [optional]
**rights** | **[]str** | All the rights (e.g. actions) that this permission allows on the target | [optional]
}
## Example
```python
from sailpoint.v3.models.entitlement_document_all_of_permissions import EntitlementDocumentAllOfPermissions
entitlement_document_all_of_permissions = EntitlementDocumentAllOfPermissions(
target='SYS.GV_$TRANSACTION',
rights=[
'SELECT'
]
)
```
[[Back to top]](#)

4
docs/tools/sdk/python/Reference/V3/Models/EntitlementDocumentAllOfSource.md
View File

@@ -19,6 +19,7 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | ID of entitlement's source. | [optional]
**name** | **str** | Display name of entitlement's source. | [optional]
**type** | **str** | Type of object. | [optional]
}
## Example
@@ -28,7 +29,8 @@ from sailpoint.v3.models.entitlement_document_all_of_source import EntitlementDo
entitlement_document_all_of_source = EntitlementDocumentAllOfSource(
id='2c91808b6e9e6fb8016eec1a2b6f7b5f',
name='ODS-HR-Employees'
name='ODS-HR-Employees',
type='SOURCE'
)
```

58
docs/tools/sdk/python/Reference/V3/Models/EntitlementDto.md
View File

@@ -1,58 +0,0 @@
---
id: entitlement-dto
title: EntitlementDto
pagination_label: EntitlementDto
sidebar_label: EntitlementDto
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'EntitlementDto', 'EntitlementDto']
slug: /tools/sdk/python/v3/models/entitlement-dto
tags: ['SDK', 'Software Development Kit', 'EntitlementDto', 'EntitlementDto']
---
# EntitlementDto
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | System-generated unique ID of the Object | [optional] [readonly]
**name** | **str** | Name of the Object | [required]
**created** | **datetime** | Creation date of the Object | [optional] [readonly]
**modified** | **datetime** | Last modification date of the Object | [optional] [readonly]
**attribute** | **str** | Name of the entitlement attribute | [optional]
**value** | **str** | Raw value of the entitlement | [optional]
**description** | **str** | Entitlment description | [optional]
**attributes** | **map[string]object** | Entitlement attributes | [optional]
**source_schema_object_type** | **str** | Schema objectType on the given application that maps to an Account Group | [optional]
**privileged** | **bool** | Determines if this Entitlement is privileged. | [optional]
**cloud_governed** | **bool** | Determines if this Entitlement is goverened in the cloud. | [optional]
**source** | [**EntitlementSource**](entitlement-source) | | [optional]
}
## Example
```python
from sailpoint.v3.models.entitlement_dto import EntitlementDto
entitlement_dto = EntitlementDto(
id='id12345',
name='aName',
created='2015-05-28T14:07:17Z',
modified='2015-05-28T14:07:17Z',
attribute='authorizationType',
value='CN=Users,dc=sailpoint,dc=com',
description='Active Directory DC',
attributes={GroupType=Security, sAMAccountName=Buyer},
source_schema_object_type='group',
privileged=False,
cloud_governed=False,
source=sailpoint.v3.models.entitlement_source.EntitlementSource(
type = 'SOURCE',
id = '2c9180835d191a86015d28455b4b232a',
name = 'HR Active Directory', )
)
```
[[Back to top]](#)

38
docs/tools/sdk/python/Reference/V3/Models/EntitlementOwner.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: entitlement-owner
title: EntitlementOwner
pagination_label: EntitlementOwner
sidebar_label: EntitlementOwner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'EntitlementOwner', 'EntitlementOwner']
slug: /tools/sdk/python/v3/models/entitlement-owner
tags: ['SDK', 'Software Development Kit', 'EntitlementOwner', 'EntitlementOwner']
---
# EntitlementOwner
The identity that owns the entitlement
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The identity ID | [optional]
**type** | **Enum** [ 'IDENTITY' ] | The type of object | [optional]
**name** | **str** | The display name of the identity | [optional]
}
## Example
```python
from sailpoint.v3.models.entitlement_owner import EntitlementOwner
entitlement_owner = EntitlementOwner(
id='2c9180827ca885d7017ca8ce28a000eb',
type='IDENTITY',
name='john.doe'
)
```
[[Back to top]](#)

6
docs/tools/sdk/python/Reference/V3/Models/EntitlementSummary.md
View File

@@ -20,9 +20,9 @@ Name | Type | Description | Notes
**id** | **str** | The unique ID of the referenced object. | [optional]
**name** | **str** | The human readable name of the referenced object. | [optional]
**display_name** | **str** | | [optional]
**type** | [**DtoType**](dto-type) | | [optional]
**description** | **str** | | [optional]
**description** | **str** | Description of access item. | [optional]
**source** | [**Reference**](reference) | | [optional]
**type** | **str** | Type of the access item. | [optional]
**privileged** | **bool** | | [optional]
**attribute** | **str** | | [optional]
**value** | **str** | | [optional]
@@ -38,11 +38,11 @@ entitlement_summary = EntitlementSummary(
id='2c91808568c529c60168cca6f90c1313',
name='John Doe',
display_name='John Q. Doe',
type='IDENTITY',
description='',
source=sailpoint.v3.models.reference.Reference(
id = '2c91808568c529c60168cca6f90c1313',
name = 'John Doe', ),
type='ENTITLEMENT',
privileged=False,
attribute='memberOf',
value='CN=Buyer,OU=Groups,OU=Demo,DC=seri,DC=sailpointdemo,DC=com',

28
docs/tools/sdk/python/Reference/V3/Models/Event.md
View File

@@ -17,15 +17,14 @@ Event
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | | [required]
**name** | **str** | | [required]
**type** | [**DocumentType**](document-type) | | [required]
**id** | **str** | ID of the entitlement. | [optional]
**name** | **str** | Name of the entitlement. | [optional]
**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**synced** | **str** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional]
**action** | **str** | Name of the event as it's displayed in audit reports. | [optional]
**type** | **str** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional]
**actor** | **str** | Name of the actor that generated the event. | [optional]
**target** | **str** | Name of the target, or recipient, of the event. | [optional]
**actor** | [**EventActor**](event-actor) | | [optional]
**target** | [**EventTarget**](event-target) | | [optional]
**stack** | **str** | The event's stack. | [optional]
**tracking_number** | **str** | ID of the group of events. | [optional]
**ip_address** | **str** | Target system's IP address. | [optional]
@@ -44,14 +43,15 @@ from sailpoint.v3.models.event import Event
event = Event(
id='2c91808375d8e80a0175e1f88a575222',
name='john.doe',
type='identity',
name='Add Entitlement Passed',
created='2018-06-25T20:22:28.104Z',
synced='',
action='update',
type='SYSTEM_CONFIG',
actor='System',
target='Carol.Adams',
synced='2018-06-25T20:22:28.104Z',
action='AddEntitlement',
type='ACCESS_ITEM',
actor=sailpoint.v3.models.event_actor.Event_actor(
name = 'System', ),
target=sailpoint.v3.models.event_target.Event_target(
name = 'Carol.Adams', ),
stack='tpe',
tracking_number='63f891e0735f4cc8bf1968144a1e7440',
ip_address='52.52.97.85',
@@ -60,9 +60,9 @@ attributes={pod=stg03-useast1, org=acme, sourceName=SailPoint},
objects=[
'AUTHENTICATION'
],
operation='REQUEST',
operation='ADD',
status='PASSED',
technical_name='AUTHENTICATION_REQUEST_PASSED'
technical_name='ENTITLEMENT_ADD_PASSED'
)
```

33
docs/tools/sdk/python/Reference/V3/Models/EventActor.md Normal file
View File

@@ -0,0 +1,33 @@
---
id: event-actor
title: EventActor
pagination_label: EventActor
sidebar_label: EventActor
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'EventActor', 'EventActor']
slug: /tools/sdk/python/v3/models/event-actor
tags: ['SDK', 'Software Development Kit', 'EventActor', 'EventActor']
---
# EventActor
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Name of the actor that generated the event. | [optional]
}
## Example
```python
from sailpoint.v3.models.event_actor import EventActor
event_actor = EventActor(
name='System'
)
```
[[Back to top]](#)

28
docs/tools/sdk/python/Reference/V3/Models/EventDocument.md
View File

@@ -17,15 +17,14 @@ Event
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | | [required]
**name** | **str** | | [required]
**type** | [**DocumentType**](document-type) | | [required]
**id** | **str** | ID of the entitlement. | [optional]
**name** | **str** | Name of the entitlement. | [optional]
**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**synced** | **str** | ISO-8601 date-time referring to the date-time when object was queued to be synced into search database for use in the search API. This date-time changes anytime there is an update to the object, which triggers a synchronization event being sent to the search database. There may be some delay between the `synced` time and the time when the updated data is actually available in the search API. | [optional]
**action** | **str** | Name of the event as it's displayed in audit reports. | [optional]
**type** | **str** | Event type. Refer to [Event Types](https://documentation.sailpoint.com/saas/help/search/index.html#event-types) for a list of event types and their meanings. | [optional]
**actor** | **str** | Name of the actor that generated the event. | [optional]
**target** | **str** | Name of the target, or recipient, of the event. | [optional]
**actor** | [**EventActor**](event-actor) | | [optional]
**target** | [**EventTarget**](event-target) | | [optional]
**stack** | **str** | The event's stack. | [optional]
**tracking_number** | **str** | ID of the group of events. | [optional]
**ip_address** | **str** | Target system's IP address. | [optional]
@@ -44,14 +43,15 @@ from sailpoint.v3.models.event_document import EventDocument
event_document = EventDocument(
id='2c91808375d8e80a0175e1f88a575222',
name='john.doe',
type='identity',
name='Add Entitlement Passed',
created='2018-06-25T20:22:28.104Z',
synced='',
action='update',
type='SYSTEM_CONFIG',
actor='System',
target='Carol.Adams',
synced='2018-06-25T20:22:28.104Z',
action='AddEntitlement',
type='ACCESS_ITEM',
actor=sailpoint.v3.models.event_actor.Event_actor(
name = 'System', ),
target=sailpoint.v3.models.event_target.Event_target(
name = 'Carol.Adams', ),
stack='tpe',
tracking_number='63f891e0735f4cc8bf1968144a1e7440',
ip_address='52.52.97.85',
@@ -60,9 +60,9 @@ attributes={pod=stg03-useast1, org=acme, sourceName=SailPoint},
objects=[
'AUTHENTICATION'
],
operation='REQUEST',
operation='ADD',
status='PASSED',
technical_name='AUTHENTICATION_REQUEST_PASSED'
technical_name='ENTITLEMENT_ADD_PASSED'
)
```

33
docs/tools/sdk/python/Reference/V3/Models/EventTarget.md Normal file
View File

@@ -0,0 +1,33 @@
---
id: event-target
title: EventTarget
pagination_label: EventTarget
sidebar_label: EventTarget
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'EventTarget', 'EventTarget']
slug: /tools/sdk/python/v3/models/event-target
tags: ['SDK', 'Software Development Kit', 'EventTarget', 'EventTarget']
---
# EventTarget
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | Name of the target, or recipient, of the event. | [optional]
}
## Example
```python
from sailpoint.v3.models.event_target import EventTarget
event_target = EventTarget(
name='Carol.Adams'
)
```
[[Back to top]](#)

20
docs/tools/sdk/python/Reference/V3/Models/ExpansionItem.md
View File

@@ -17,10 +17,12 @@ tags: ['SDK', 'Software Development Kit', 'ExpansionItem', 'ExpansionItem']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**account_id** | **str** | The ID of the account | [optional]
**cause** | **str** | | [optional]
**cause** | **str** | Cause of the expansion item. | [optional]
**name** | **str** | The name of the item | [optional]
**attribute_requests** | [**[]AttributeRequest**](attribute-request) | | [optional]
**attribute_request** | [**AttributeRequest**](attribute-request) | | [optional]
**source** | [**AccountSource**](account-source) | | [optional]
**id** | **str** | ID of the expansion item | [optional]
**state** | **str** | State of the expansion item | [optional]
}
## Example
@@ -32,13 +34,13 @@ expansion_item = ExpansionItem(
account_id='2c91808981f58ea601821c3e93482e6f',
cause='Role',
name='smartsheet-role',
attribute_requests=[
sailpoint.v3.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = '3203537556531076', )
],
source=
attribute_request=sailpoint.v3.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = null, ),
source=,
id='ac2887ffe0e7435a8c18c73f7ae94c7b',
state='EXECUTING'
)
```

6
docs/tools/sdk/python/Reference/V3/Models/IdentityAccess.md
View File

@@ -19,8 +19,8 @@ Name | Type | Description | Notes
**id** | **str** | The unique ID of the referenced object. | [optional]
**name** | **str** | The human readable name of the referenced object. | [optional]
**display_name** | **str** | | [optional]
**type** | [**DtoType**](dto-type) | | [optional]
**description** | **str** | | [optional]
**description** | **str** | Description of access item. | [optional]
**type** | **str** | Type of the access item. | [optional]
**source** | [**Reference**](reference) | | [optional]
**owner** | [**DisplayReference**](display-reference) | | [optional]
**revocable** | **bool** | | [optional]
@@ -40,8 +40,8 @@ identity_access = IdentityAccess(
id='2c91808568c529c60168cca6f90c1313',
name='John Doe',
display_name='John Q. Doe',
type='IDENTITY',
description='',
type='ROLE',
source=sailpoint.v3.models.reference.Reference(
id = '2c91808568c529c60168cca6f90c1313',
name = 'John Doe', ),

2
docs/tools/sdk/python/Reference/V3/Models/IdentityAttributeConfig.md
View File

@@ -17,7 +17,7 @@ Defines all the identity attribute mapping configurations. This defines how to g
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enabled** | **bool** | The backend will only promote values if the profile/mapping is enabled. | [optional] [default to False]
**enabled** | **bool** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to False]
**attribute_transforms** | [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional]
}

4
docs/tools/sdk/python/Reference/V3/Models/IdentityAttributeTransform.md
View File

@@ -11,13 +11,13 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'Identit
# IdentityAttributeTransform
Defines a transformation definition for an identity attribute.
Transform definition for an identity attribute.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**identity_attribute_name** | **str** | Name of the identity attribute. | [optional]
**identity_attribute_name** | **str** | Identity attribute's name. | [optional]
**transform_definition** | [**TransformDefinition**](transform-definition) | | [optional]
}

16
docs/tools/sdk/python/Reference/V3/Models/IdentityDocument.md
View File

@@ -19,7 +19,6 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique ID of the referenced object. | [required]
**name** | **str** | The human readable name of the referenced object. | [required]
**type** | [**DocumentType**](document-type) | | [required]
**display_name** | **str** | Identity's display name. | [optional]
**first_name** | **str** | Identity's first name. | [optional]
**last_name** | **str** | Identity's last name. | [optional]
@@ -37,6 +36,8 @@ Name | Type | Description | Notes
**identity_profile** | [**IdentityDocumentAllOfIdentityProfile**](identity-document-all-of-identity-profile) | | [optional]
**source** | [**IdentityDocumentAllOfSource**](identity-document-all-of-source) | | [optional]
**attributes** | **map[string]object** | Map or dictionary of key/value pairs. | [optional]
**disabled** | **bool** | Indicates whether the identity is disabled. | [optional] [default to False]
**locked** | **bool** | Indicates whether the identity is locked. | [optional] [default to False]
**processing_state** | **str** | Identity's processing state. | [optional]
**processing_details** | [**ProcessingDetails**](processing-details) | | [optional]
**accounts** | [**[]BaseAccount**](base-account) | List of accounts associated with the identity. | [optional]
@@ -51,6 +52,9 @@ Name | Type | Description | Notes
**owns** | [**[]Owns**](owns) | Access items the identity owns. | [optional]
**owns_count** | **int** | Number of access items the identity owns. | [optional]
**tags** | **[]str** | Tags that have been applied to the object. | [optional]
**tags_count** | **int** | Number of tags on the identity. | [optional]
**visible_segments** | **[]str** | List of segments that the identity is in. | [optional]
**visible_segment_count** | **int** | Number of segments the identity is in. | [optional]
}
## Example
@@ -61,7 +65,6 @@ from sailpoint.v3.models.identity_document import IdentityDocument
identity_document = IdentityDocument(
id='2c91808568c529c60168cca6f90c1313',
name='John Doe',
type='identity',
display_name='Carol.Adams',
first_name='Carol',
last_name='Adams',
@@ -86,7 +89,9 @@ source=sailpoint.v3.models.identity_document_all_of_source.IdentityDocument_allO
id = '2c91808b6e9e6fb8016eec1a2b6f7b5f',
name = 'ODS-HR-Employees', ),
attributes={country=US, firstname=Carol, cloudStatus=UNREGISTERED},
processing_state='',
disabled=False,
locked=False,
processing_state='ERROR',
processing_details=sailpoint.v3.models.processing_details.ProcessingDetails(
date = '2018-06-25T20:22:28.104Z',
stage = 'In Process',
@@ -135,7 +140,10 @@ owns=[
fallback_approver = False, )
],
owns_count=5,
tags=[TAG_1, TAG_2]
tags=[TAG_1, TAG_2],
tags_count=56,
visible_segments=[All Employees],
visible_segment_count=1
)
```

4
docs/tools/sdk/python/Reference/V3/Models/IdentityExceptionReportReference.md
View File

@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'I
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**task_result_id** | **str** | The id of the task result. | [optional]
**report_name** | **str** | The name of the report. | [optional]
**task_result_id** | **str** | Task result ID. | [optional]
**report_name** | **str** | Report name. | [optional]
}
## Example

10
docs/tools/sdk/python/Reference/V3/Models/IdentityProfile.md
View File

@@ -20,15 +20,15 @@ Name | Type | Description | Notes
**name** | **str** | Name of the Object | [required]
**created** | **datetime** | Creation date of the Object | [optional] [readonly]
**modified** | **datetime** | Last modification date of the Object | [optional] [readonly]
**description** | **str** | The description of the Identity Profile. | [optional]
**description** | **str** | Identity profile's description. | [optional]
**owner** | [**IdentityProfileAllOfOwner**](identity-profile-all-of-owner) | | [optional]
**priority** | **int** | The priority for an Identity Profile. | [optional]
**priority** | **int** | Identity profile's priority. | [optional]
**authoritative_source** | [**IdentityProfileAllOfAuthoritativeSource**](identity-profile-all-of-authoritative-source) | | [required]
**identity_refresh_required** | **bool** | True if a identity refresh is needed. Typically triggered when a change on the source has been made. | [optional] [default to False]
**identity_count** | **int** | The number of identities that belong to the Identity Profile. | [optional]
**identity_refresh_required** | **bool** | Set this value to 'True' if an identity refresh is necessary. You would typically want to trigger an identity refresh when a change has been made on the source. | [optional] [default to False]
**identity_count** | **int** | Number of identities belonging to the identity profile. | [optional]
**identity_attribute_config** | [**IdentityAttributeConfig**](identity-attribute-config) | | [optional]
**identity_exception_report_reference** | [**IdentityExceptionReportReference**](identity-exception-report-reference) | | [optional]
**has_time_based_attr** | **bool** | Indicates the value of requiresPeriodicRefresh attribute for the Identity Profile. | [optional] [default to False]
**has_time_based_attr** | **bool** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to False]
}
## Example

6
docs/tools/sdk/python/Reference/V3/Models/IdentityProfileAllOfAuthoritativeSource.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSour
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'SOURCE' ] | Type of the object to which this reference applies | [optional]
**id** | **str** | ID of the object to which this reference applies | [optional]
**name** | **str** | Human-readable display name of the object to which this reference applies | [optional]
**type** | **Enum** [ 'SOURCE' ] | Authoritative source's object type. | [optional]
**id** | **str** | Authoritative source's ID. | [optional]
**name** | **str** | Authoritative source's name. | [optional]
}
## Example

8
docs/tools/sdk/python/Reference/V3/Models/IdentityProfileAllOfOwner.md
View File

@@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'Identity
# IdentityProfileAllOfOwner
The owner of the Identity Profile.
Identity profile's owner.
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY' ] | Type of the object to which this reference applies | [optional]
**id** | **str** | ID of the object to which this reference applies | [optional]
**name** | **str** | Human-readable display name of the object to which this reference applies | [optional]
**type** | **Enum** [ 'IDENTITY' ] | Owner's object type. | [optional]
**id** | **str** | Owner's ID. | [optional]
**name** | **str** | Owner's name. | [optional]
}
## Example

2
docs/tools/sdk/python/Reference/V3/Models/ImportObject.md
View File

@@ -17,7 +17,7 @@ Object created or updated by import.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'IDENTITY_OBJECT_CONFIG', 'IDENTITY_PROFILE', 'RULE', 'SOURCE', 'TRANSFORM', 'TRIGGER_SUBSCRIPTION' ] | DTO type of object created or updated by import. | [optional]
**type** | **Enum** [ 'CONNECTOR_RULE', 'IDENTITY_OBJECT_CONFIG', 'IDENTITY_PROFILE', 'RULE', 'SOURCE', 'TRANSFORM', 'TRIGGER_SUBSCRIPTION' ] | DTO type of object created or updated by import. | [optional]
**id** | **str** | ID of object created or updated by import. | [optional]
**name** | **str** | Display name of object created or updated by import. | [optional]
}

2
docs/tools/sdk/python/Reference/V3/Models/NonEmployeeSourceWithNECount.md
View File

@@ -24,7 +24,7 @@ Name | Type | Description | Notes
**account_managers** | [**[]NonEmployeeIdentityReferenceWithId**](non-employee-identity-reference-with-id) | List of account managers | [optional]
**modified** | **datetime** | When the request was last modified. | [optional]
**created** | **datetime** | When the request was created. | [optional]
**non_employee_count** | **int** | Number of non-employee records associated with this source. | [optional]
**non_employee_count** | **int** | Number of non-employee records associated with this source. This value is 'NULL' by default. To get the non-employee count, you must set the `non-employee-count` flag in your request to 'true'. | [optional]
}
## Example

5
docs/tools/sdk/python/Reference/V3/Models/OriginalRequest.md
View File

@@ -17,6 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'OriginalRequest', 'OriginalRequest']
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**account_id** | **str** | Account ID. | [optional]
**result** | [**Result**](result) | | [optional]
**attribute_requests** | [**[]AttributeRequest**](attribute-request) | Attribute changes requested for account. | [optional]
**op** | **str** | Operation used. | [optional]
**source** | [**AccountSource**](account-source) | | [optional]
@@ -29,11 +30,13 @@ from sailpoint.v3.models.original_request import OriginalRequest
original_request = OriginalRequest(
account_id='CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com',
result=sailpoint.v3.models.result.Result(
status = 'Manual Task Created', ),
attribute_requests=[
sailpoint.v3.models.attribute_request.AttributeRequest(
name = 'groups',
op = 'Add',
value = '3203537556531076', )
value = null, )
],
op='add',
source=

2
docs/tools/sdk/python/Reference/V3/Models/RequestedItemStatus.md
View File

@@ -16,6 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'RequestedItemStatus', 'RequestedItemS
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The ID of the access request. | [optional]
**name** | **str** | Human-readable display name of the item being requested. | [optional]
**type** | **Enum** [ 'ACCESS_PROFILE', 'ROLE', 'ENTITLEMENT' ] | Type of requested object. | [optional]
**cancelled_request_details** | [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional]
@@ -48,6 +49,7 @@ Name | Type | Description | Notes
from sailpoint.v3.models.requested_item_status import RequestedItemStatus
requested_item_status = RequestedItemStatus(
id='2c9180926cbfbddd016cbfc7c3b10010',
name='AccessProfile1',
type='ACCESS_PROFILE',
cancelled_request_details=,

33
docs/tools/sdk/python/Reference/V3/Models/Result.md Normal file
View File

@@ -0,0 +1,33 @@
---
id: result
title: Result
pagination_label: Result
sidebar_label: Result
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'Result', 'Result']
slug: /tools/sdk/python/v3/models/result
tags: ['SDK', 'Software Development Kit', 'Result', 'Result']
---
# Result
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**status** | **str** | Request result status | [optional]
}
## Example
```python
from sailpoint.v3.models.result import Result
result = Result(
status='Manual Task Created'
)
```
[[Back to top]](#)

56
docs/tools/sdk/python/Reference/V3/Models/RoleDocument.md
View File

@@ -17,9 +17,6 @@ Role
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | The unique ID of the referenced object. | [required]
**name** | **str** | The human readable name of the referenced object. | [required]
**type** | [**DocumentType**](document-type) | | [required]
**description** | **str** | Access item's description. | [optional]
**created** | **datetime** | ISO-8601 date-time referring to the time when the object was created. | [optional]
**modified** | **datetime** | ISO-8601 date-time referring to the time when the object was last modified. | [optional]
@@ -27,14 +24,20 @@ Name | Type | Description | Notes
**enabled** | **bool** | Indicates whether the access item is currently enabled. | [optional] [default to False]
**requestable** | **bool** | Indicates whether the access item can be requested. | [optional] [default to True]
**request_comments_required** | **bool** | Indicates whether comments are required for requests to access the item. | [optional] [default to False]
**owner** | [**BaseAccessAllOfOwner**](base-access-all-of-owner) | | [optional]
**owner** | [**BaseAccessOwner**](base-access-owner) | | [optional]
**id** | **str** | ID of the role. | [required]
**name** | **str** | Name of the role. | [required]
**access_profiles** | [**[]BaseAccessProfile**](base-access-profile) | Access profiles included with the role. | [optional]
**access_profile_count** | **int** | Number of access profiles included with the role. | [optional]
**tags** | **[]str** | Tags that have been applied to the object. | [optional]
**segments** | [**[]BaseSegment**](base-segment) | Segments with the role. | [optional]
**segment_count** | **int** | Number of segments with the role. | [optional]
**entitlements** | [**[]BaseEntitlement**](base-entitlement) | Entitlements included with the role. | [optional]
**entitlements** | [**[]RoleDocumentAllOfEntitlements**](role-document-all-of-entitlements) | Entitlements included with the role. | [optional]
**entitlement_count** | **int** | Number of entitlements included with the role. | [optional]
**dimensional** | **bool** | | [optional] [default to False]
**dimension_schema_attribute_count** | **int** | Number of dimension attributes included with the role. | [optional]
**dimension_schema_attributes** | [**[]RoleDocumentAllOfDimensionSchemaAttributes**](role-document-all-of-dimension-schema-attributes) | Dimension attributes included with the role. | [optional]
**dimensions** | [**[]RoleDocumentAllOfDimensions**](role-document-all-of-dimensions) | | [optional]
}
## Example
@@ -43,21 +46,20 @@ Name | Type | Description | Notes
from sailpoint.v3.models.role_document import RoleDocument
role_document = RoleDocument(
id='2c91808568c529c60168cca6f90c1313',
name='John Doe',
type='identity',
description='The admin role',
description='Admin access',
created='2018-06-25T20:22:28.104Z',
modified='2018-06-25T20:22:28.104Z',
synced='2018-06-25T20:22:33.104Z',
enabled=True,
requestable=True,
request_comments_required=False,
owner=sailpoint.v3.models.base_access_all_of_owner.BaseAccess_allOf_owner(
owner=sailpoint.v3.models.base_access_owner.BaseAccess_owner(
type = 'IDENTITY',
id = '2c9180a46faadee4016fb4e018c20639',
name = 'Support',
email = 'cloud-support@sailpoint.com', ),
id='2c91808375d8e80a0175e1f88a575222',
name='Branch Manager Access',
access_profiles=[
sailpoint.v3.models.base_access_profile.BaseAccessProfile(
id = '2c91809c6faade77016fb4f0b63407ae',
@@ -72,17 +74,31 @@ segments=[
],
segment_count=1,
entitlements=[
sailpoint.v3.models.base_entitlement.BaseEntitlement(
has_permissions = False,
description = 'Cloud engineering',
attribute = 'memberOf',
value = 'CN=Cloud Engineering,DC=sailpoint,DC=COM',
schema = 'group',
privileged = False,
id = '2c918084575812550157589064f33b89',
name = 'CN=Cloud Engineering,DC=sailpoint,DC=COM', )
null
],
entitlement_count=3
entitlement_count=3,
dimensional=False,
dimension_schema_attribute_count=3,
dimension_schema_attributes=[
sailpoint.v3.models.role_document_all_of_dimension_schema_attributes.RoleDocument_allOf_dimensionSchemaAttributes(
derived = True,
display_name = 'Department',
name = 'department', )
],
dimensions=[
sailpoint.v3.models.role_document_all_of_dimensions.RoleDocument_allOf_dimensions(
id = 'b3c28992ba964a40a7598978139d1ced',
name = 'Manager Austin Branch',
description = 'Managers located at the Austin branch',
entitlements = [
null
],
access_profiles = [
sailpoint.v3.models.base_access_profile.BaseAccessProfile(
id = '2c91809c6faade77016fb4f0b63407ae',
name = 'Admin Access', )
], )
]
)
```

37
docs/tools/sdk/python/Reference/V3/Models/RoleDocumentAllOfDimensionSchemaAttributes.md Normal file
View File

@@ -0,0 +1,37 @@
---
id: role-document-all-of-dimension-schema-attributes
title: RoleDocumentAllOfDimensionSchemaAttributes
pagination_label: RoleDocumentAllOfDimensionSchemaAttributes
sidebar_label: RoleDocumentAllOfDimensionSchemaAttributes
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'RoleDocumentAllOfDimensionSchemaAttributes', 'RoleDocumentAllOfDimensionSchemaAttributes']
slug: /tools/sdk/python/v3/models/role-document-all-of-dimension-schema-attributes
tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfDimensionSchemaAttributes', 'RoleDocumentAllOfDimensionSchemaAttributes']
---
# RoleDocumentAllOfDimensionSchemaAttributes
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**derived** | **bool** | | [optional] [default to True]
**display_name** | **str** | Displayname of the dimension attribute. | [optional]
**name** | **str** | Name of the dimension attribute. | [optional]
}
## Example
```python
from sailpoint.v3.models.role_document_all_of_dimension_schema_attributes import RoleDocumentAllOfDimensionSchemaAttributes
role_document_all_of_dimension_schema_attributes = RoleDocumentAllOfDimensionSchemaAttributes(
derived=True,
display_name='Department',
name='department'
)
```
[[Back to top]](#)

47
docs/tools/sdk/python/Reference/V3/Models/RoleDocumentAllOfDimensions.md Normal file
View File

@@ -0,0 +1,47 @@
---
id: role-document-all-of-dimensions
title: RoleDocumentAllOfDimensions
pagination_label: RoleDocumentAllOfDimensions
sidebar_label: RoleDocumentAllOfDimensions
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'RoleDocumentAllOfDimensions', 'RoleDocumentAllOfDimensions']
slug: /tools/sdk/python/v3/models/role-document-all-of-dimensions
tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfDimensions', 'RoleDocumentAllOfDimensions']
---
# RoleDocumentAllOfDimensions
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | Unique ID of the dimension. | [optional]
**name** | **str** | Name of the dimension. | [optional]
**description** | **str** | Description of the dimension. | [optional]
**entitlements** | [**[]RoleDocumentAllOfEntitlements1**](role-document-all-of-entitlements1) | Entitlements included with the role. | [optional]
**access_profiles** | [**[]BaseAccessProfile**](base-access-profile) | Access profiles included in the dimension. | [optional]
}
## Example
```python
from sailpoint.v3.models.role_document_all_of_dimensions import RoleDocumentAllOfDimensions
role_document_all_of_dimensions = RoleDocumentAllOfDimensions(
id='b3c28992ba964a40a7598978139d1ced',
name='Manager Austin Branch',
description='Managers located at the Austin branch',
entitlements=[
null
],
access_profiles=[
sailpoint.v3.models.base_access_profile.BaseAccessProfile(
id = '2c91809c6faade77016fb4f0b63407ae',
name = 'Admin Access', )
]
)
```
[[Back to top]](#)

51
docs/tools/sdk/python/Reference/V3/Models/RoleDocumentAllOfEntitlements.md Normal file
View File

@@ -0,0 +1,51 @@
---
id: role-document-all-of-entitlements
title: RoleDocumentAllOfEntitlements
pagination_label: RoleDocumentAllOfEntitlements
sidebar_label: RoleDocumentAllOfEntitlements
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'RoleDocumentAllOfEntitlements', 'RoleDocumentAllOfEntitlements']
slug: /tools/sdk/python/v3/models/role-document-all-of-entitlements
tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfEntitlements', 'RoleDocumentAllOfEntitlements']
---
# RoleDocumentAllOfEntitlements
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**has_permissions** | **bool** | Indicates whether the entitlement has permissions. | [optional] [default to False]
**description** | **str** | Entitlement's description. | [optional]
**attribute** | **str** | Entitlement attribute's name. | [optional]
**value** | **str** | Entitlement's value. | [optional]
**var_schema** | **str** | Entitlement's schema. | [optional]
**privileged** | **bool** | Indicates whether the entitlement is privileged. | [optional] [default to False]
**id** | **str** | Entitlement's ID. | [optional]
**name** | **str** | Entitlement's name. | [optional]
**source_schema_object_type** | **str** | Schema objectType. | [optional]
**hash** | **str** | Read-only calculated hash value of an entitlement. | [optional]
}
## Example
```python
from sailpoint.v3.models.role_document_all_of_entitlements import RoleDocumentAllOfEntitlements
role_document_all_of_entitlements = RoleDocumentAllOfEntitlements(
has_permissions=False,
description='Cloud engineering',
attribute='memberOf',
value='CN=Cloud Engineering,DC=sailpoint,DC=COM',
var_schema='group',
privileged=False,
id='2c918084575812550157589064f33b89',
name='CN=Cloud Engineering,DC=sailpoint,DC=COM',
source_schema_object_type='group',
hash='c6fab95235584cca98a454a2f51e5683bc77d6a0'
)
```
[[Back to top]](#)

51
docs/tools/sdk/python/Reference/V3/Models/RoleDocumentAllOfEntitlements1.md Normal file
View File

@@ -0,0 +1,51 @@
---
id: role-document-all-of-entitlements1
title: RoleDocumentAllOfEntitlements1
pagination_label: RoleDocumentAllOfEntitlements1
sidebar_label: RoleDocumentAllOfEntitlements1
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'RoleDocumentAllOfEntitlements1', 'RoleDocumentAllOfEntitlements1']
slug: /tools/sdk/python/v3/models/role-document-all-of-entitlements1
tags: ['SDK', 'Software Development Kit', 'RoleDocumentAllOfEntitlements1', 'RoleDocumentAllOfEntitlements1']
---
# RoleDocumentAllOfEntitlements1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**has_permissions** | **bool** | Indicates whether the entitlement has permissions. | [optional] [default to False]
**description** | **str** | Entitlement's description. | [optional]
**attribute** | **str** | Entitlement attribute's name. | [optional]
**value** | **str** | Entitlement's value. | [optional]
**var_schema** | **str** | Entitlement's schema. | [optional]
**privileged** | **bool** | Indicates whether the entitlement is privileged. | [optional] [default to False]
**id** | **str** | Entitlement's ID. | [optional]
**name** | **str** | Entitlement's name. | [optional]
**source_schema_object_type** | **str** | Schema objectType. | [optional]
**hash** | **str** | Read-only calculated hash value of an entitlement. | [optional]
}
## Example
```python
from sailpoint.v3.models.role_document_all_of_entitlements1 import RoleDocumentAllOfEntitlements1
role_document_all_of_entitlements1 = RoleDocumentAllOfEntitlements1(
has_permissions=False,
description='Cloud engineering',
attribute='memberOf',
value='CN=Cloud Engineering,DC=sailpoint,DC=COM',
var_schema='group',
privileged=False,
id='2c918084575812550157589064f33b89',
name='CN=Cloud Engineering,DC=sailpoint,DC=COM',
source_schema_object_type='group',
hash='c6fab95235584cca98a454a2f51e5683bc77d6a0'
)
```
[[Back to top]](#)

6
docs/tools/sdk/python/Reference/V3/Models/RoleSummary.md
View File

@@ -20,8 +20,8 @@ Name | Type | Description | Notes
**id** | **str** | The unique ID of the referenced object. | [optional]
**name** | **str** | The human readable name of the referenced object. | [optional]
**display_name** | **str** | | [optional]
**type** | [**DtoType**](dto-type) | | [optional]
**description** | **str** | | [optional]
**description** | **str** | Description of access item. | [optional]
**type** | **str** | Type of the access item. | [optional]
**owner** | [**DisplayReference**](display-reference) | | [optional]
**disabled** | **bool** | | [optional]
**revocable** | **bool** | | [optional]
@@ -36,8 +36,8 @@ role_summary = RoleSummary(
id='2c91808568c529c60168cca6f90c1313',
name='John Doe',
display_name='John Q. Doe',
type='IDENTITY',
description='',
type='ROLE',
owner=,
disabled=True,
revocable=True

2
docs/tools/sdk/python/Reference/V3/Models/TransformDefinition.md
View File

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'TransformDefinition', 'TransformDefin
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **str** | The type of the transform definition. | [optional]
**type** | **str** | Transform definition type. | [optional]
**attributes** | **map[string]object** | Arbitrary key-value pairs to store any metadata for the object | [optional]
}

2
docs/tools/sdk/python/Reference/V3/Models/WorkflowExecution.md
View File

@@ -21,7 +21,7 @@ Name | Type | Description | Notes
**request_id** | **str** | Backend ID that tracks a workflow request in the system. Provide this ID in a customer support ticket for debugging purposes. | [optional]
**start_time** | **datetime** | Date/time when the workflow started. | [optional]
**close_time** | **datetime** | Date/time when the workflow ended. | [optional]
**status** | **Enum** [ 'Completed', 'Failed', 'Canceled', 'Executing' ] | Workflow execution status. | [optional]
**status** | **Enum** [ 'Completed', 'Failed', 'Canceled', 'Running' ] | Workflow execution status. | [optional]
}
## Example