LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-08 20:37:46 +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

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

@@ -792,8 +792,8 @@ 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, 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* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *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* **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, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name**
### Return type
[**List[Account]**](../models/account)
@@ -828,8 +828,8 @@ 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 = '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* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *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* **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* **sourceId**: *eq, in, sw* **uncorrelated**: *eq* **entitlements**: *eq* **origin**: *eq, in* **manuallyCorrelated**: *eq* **hasEntitlements**: *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* **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, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.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, created, modified, sourceId, identityId, nativeIdentity, uuid, manuallyCorrelated, hasEntitlements, entitlements, origin, identity.name, identity.identityState, identity.correlated, source.displayableName, source.authoritative, source.connectionType, sourceOwner.name** (optional)
try:
# Accounts List

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

@@ -34,6 +34,7 @@ Method | HTTP request | Description
[**get-identity-certification-pending-tasks**](#get-identity-certification-pending-tasks) | **GET** `/certifications/{id}/tasks-pending` | Pending Certification Tasks
[**get-identity-certification-task-status**](#get-identity-certification-task-status) | **GET** `/certifications/{id}/tasks/{taskId}` | Certification Task Status
[**list-certification-reviewers**](#list-certification-reviewers) | **GET** `/certifications/{id}/reviewers` | List of Reviewers for certification
[**list-certifications**](#list-certifications) | **GET** `/certifications` | Certifications by IDs
[**submit-reassign-certs-async**](#submit-reassign-certs-async) | **POST** `/certifications/{id}/reassign-async` | Reassign Certifications Asynchronously
@@ -303,6 +304,75 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-certifications
Certifications by IDs
This API returns a list of certifications that satisfy the given query parameters. Any authenticated token can call this API, but only certifications you are authorized to review will be returned.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-certifications)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Query | reviewer_identitiy | **str** | (optional) | The ID of reviewer identity. *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 | 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* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in*
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, due, signed**
### Return type
[**List[CertificationDto]**](../models/certification-dto)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | List of certifications | List[CertificationDto] | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessModelMetadataAttribute429Response | - |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```python
import sailpoint.beta
from sailpoint.beta.api.certifications_api import CertificationsApi
from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.certification_dto import CertificationDto
from pprint import pprint
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
reviewer_identitiy = 'reviewer_identitiy_example' # str | The ID of reviewer identity. *me* indicates the current user. (optional) # str | The ID of reviewer identity. *me* indicates the current user. (optional)
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
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 = 'filters_example' # 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* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **phase**: *eq* **completed**: *eq, ne* **campaignRef.campaignType**: *eq, in* **campaignRef.id**: *eq, in* (optional)
sorters = 'sorters_example' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, due, signed** (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, due, signed** (optional)
try:
# Certifications by IDs
results =CertificationsApi(api_client).list_certifications()
# Below is a request that includes all optional parameters
# results = CertificationsApi(api_client).list_certifications(reviewer_identitiy, limit, offset, count, filters, sorters)
print("The response of CertificationsApi->list_certifications:\n")
pprint(results)
except Exception as e:
print("Exception when calling CertificationsApi->list_certifications: %s\n" % e)
```
[[Back to top]](#)
## submit-reassign-certs-async

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

@@ -26,23 +26,22 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
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` | Default identity attribute config
[**get-identity-profile**](#get-identity-profile) | **GET** `/identity-profiles/{identity-profile-id}` | Gets a 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-generate-identity-preview**](#show-generate-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
Create an identity profile.
A token with ORG_ADMIN authority is required to call this API to create an Identity Profile.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-identity-profile)
@@ -59,7 +58,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. | ListAccessModelMetadataAttribute401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
@@ -133,7 +132,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)
@@ -150,22 +149,18 @@ 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.
A token with ORG_ADMIN authority is required to call this API.
The following rights are required to access this endpoint: idn:identity-profile:delete
[API Spec](https://developer.sailpoint.com/docs/api/beta/delete-identity-profile)
### Parameters
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)
@@ -197,10 +192,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
@@ -413,9 +408,8 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-identity-profile
Gets a single Identity Profile
This returns a single Identity Profile based on ID.
Get Identity Profile
Get a single identity profile by ID.
A token with ORG_ADMIN or API authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-identity-profile)
@@ -424,7 +418,7 @@ A token with ORG_ADMIN or API authority is required to call this API.
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)
@@ -432,7 +426,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. | ListAccessModelMetadataAttribute401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
@@ -456,10 +450,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:
# Gets a 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
@@ -594,8 +588,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.
A token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-identity-profiles)
@@ -607,7 +601,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, 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
@@ -616,7 +610,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. | ListAccessModelMetadataAttribute401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
@@ -642,11 +636,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 8c190e6787aa4ed9a90bd9d5344523fb' # 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, 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, in, le, lt, isnull, sw* **priority**: *eq, ne* (optional)
filters = 'id eq 8c190e6787aa4ed9a90bd9d5344523fb' # 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 = 'name,-priority' # 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
@@ -815,14 +809,11 @@ 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 the specified identity profile with this PATCH request.
A token with ORG_ADMIN authority is required to call this API to update the Identity Profile.
Some fields of the Schema cannot be updated. These fields are listed below:
These fields cannot be updated:
* id
* name
* created
* modified
* identityCount
@@ -835,8 +826,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)
@@ -844,7 +835,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. | ListAccessModelMetadataAttribute401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
@@ -869,17 +860,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/Beta/Methods/NonEmployeeLifecycleManagementApi.md
View File

@@ -297,9 +297,7 @@ with ApiClient(configuration) as api_client:
## create-non-employee-source
Create Non-Employee Source
This request will create a non-employee source.
Request will require the following security scope:
'idn:nesr:create'
Create a non-employee source.
[API Spec](https://developer.sailpoint.com/docs/api/beta/create-non-employee-source)
@@ -1722,7 +1720,9 @@ with ApiClient(configuration) as api_client:
## list-non-employee-sources
List Non-Employee Sources
This gets a list of non-employee sources.
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/beta/list-non-employee-sources)
@@ -1730,11 +1730,11 @@ This gets a list of non-employee sources.
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 | non_employee_count | **bool** | True | The flag to determine whether return a non-employee count associate with source.
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 | 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
@@ -1743,7 +1743,7 @@ Param Type | Name | Data Type | Required | Description
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | List of non-employee sources objects. | List[NonEmployeeSourceWithNECount] | - |
200 | List of non-employee source objects. | List[NonEmployeeSourceWithNECount] | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
@@ -1766,19 +1766,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.
non_employee_count = false # bool | The flag to determine whether return a non-employee count associate with source. # bool | The flag to determine whether return a non-employee count associate with source.
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
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)
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, non_employee_count, )
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, non_employee_count, limit, offset, 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:

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

@@ -406,7 +406,11 @@ Gets all Reassignment configuration for the current org.
[API Spec](https://developer.sailpoint.com/docs/api/beta/list-reassignment-configurations)
### Parameters
This endpoint does not need any parameter.
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Query | limit | **int** | (optional) (default to 20) | Max number of results to return.
Query | offset | **int** | (optional) | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified.
### Return type
[**List[ConfigurationResponse]**](../models/configuration-response)
@@ -438,13 +442,15 @@ from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
limit = 20 # int | Max number of results to return. (optional) (default to 20) # int | Max number of results to return. (optional) (default to 20)
offset = 10 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. Defaults to 0 if not specified. (optional)
try:
# List Reassignment Configurations
results =WorkReassignmentApi(api_client).list_reassignment_configurations()
# Below is a request that includes all optional parameters
# results = WorkReassignmentApi(api_client).list_reassignment_configurations()
# results = WorkReassignmentApi(api_client).list_reassignment_configurations(limit, offset)
print("The response of WorkReassignmentApi->list_reassignment_configurations:\n")
pprint(results)
except Exception as e:

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

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeConfig', 'BetaIdenti
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enabled** | **bool** | If the profile or mapping is enabled | [optional] [default to True]
**enabled** | **bool** | Backend will only promote values if the profile/mapping is enabled. | [optional] [default to True]
**attribute_transforms** | [**[]IdentityAttributeTransform**](identity-attribute-transform) | | [optional]
}

2
docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributeConfig1.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** | [**[]IdentityAttributeTransform1**](identity-attribute-transform1) | | [optional]
}

3
docs/tools/sdk/python/Reference/Beta/Models/IdentityAttributeTransform.md
View File

@@ -11,12 +11,13 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform', 'BetaIde
# IdentityAttributeTransform
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]
}

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

@@ -11,13 +11,13 @@ tags: ['SDK', 'Software Development Kit', 'IdentityAttributeTransform1', 'BetaId
# IdentityAttributeTransform1
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** | [**TransformDefinition1**](transform-definition1) | | [optional]
}

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

@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference', 'B
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

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

@@ -16,8 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'IdentityExceptionReportReference1', '
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/Beta/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 True]
**has_time_based_attr** | **bool** | Indicates the value of `requiresPeriodicRefresh` attribute for the identity profile. | [optional] [default to True]
}
## Example

10
docs/tools/sdk/python/Reference/Beta/Models/IdentityProfile1.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** | [**IdentityProfile1AllOfAuthoritativeSource**](identity-profile1-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** | [**IdentityAttributeConfig1**](identity-attribute-config1) | | [optional]
**identity_exception_report_reference** | [**IdentityExceptionReportReference1**](identity-exception-report-reference1) | | [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/Beta/Models/IdentityProfile1AllOfAuthoritativeSource.md
View File

@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfile1AllOfAuthoritativeSou
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/Beta/Models/IdentityProfileAllOfAuthoritativeSource.md
View File

@@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfAuthoritativeSour
# IdentityProfileAllOfAuthoritativeSource
The authoritative source for this Identity Profile.
Identity profile's authoritative source.
## Properties
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/Beta/Models/IdentityProfileAllOfOwner.md
View File

@@ -11,15 +11,15 @@ tags: ['SDK', 'Software Development Kit', 'IdentityProfileAllOfOwner', 'BetaIden
# 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/Beta/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/Beta/Models/NonEmployeeSourceWithNECount.md
View File

@@ -24,7 +24,7 @@ Name | Type | Description | Notes
**account_managers** | [**[]IdentityReferenceWithId**](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

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

@@ -16,6 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'RequestedItemStatus', 'BetaRequestedI
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.beta.models.requested_item_status import RequestedItemStatus
requested_item_status = RequestedItemStatus(
id='2c9180926cbfbddd016cbfc7c3b10010',
name='AccessProfile1',
type='ACCESS_PROFILE',
cancelled_request_details=,

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

@@ -17,7 +17,7 @@ Self block for imported/exported object.
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**type** | **Enum** [ 'ACCESS_PROFILE', 'ACCESS_REQUEST_CONFIG', 'ATTR_SYNC_SOURCE_CONFIG', 'AUTH_ORG', 'CAMPAIGN_FILTER', 'FORM_DEFINITION', 'GOVERNANCE_GROUP', 'IDENTITY_OBJECT_CONFIG', 'IDENTITY_PROFILE', 'LIFECYCLE_STATE', 'NOTIFICATION_TEMPLATE', 'PASSWORD_POLICY', 'PASSWORD_SYNC_GROUP', 'PUBLIC_IDENTITIES_CONFIG', 'ROLE', 'RULE', 'SEGMENT', 'SERVICE_DESK_INTEGRATION', 'SOD_POLICY', 'SOURCE', 'TAG', 'TRANSFORM', 'TRIGGER_SUBSCRIPTION', 'WORKFLOW' ] | Imported/exported object's DTO type. Import is currently only possible with the IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types. | [optional]
**type** | **Enum** [ 'ACCESS_PROFILE', 'ACCESS_REQUEST_CONFIG', 'ATTR_SYNC_SOURCE_CONFIG', 'AUTH_ORG', 'CAMPAIGN_FILTER', 'CONNECTOR_RULE', 'FORM_DEFINITION', 'GOVERNANCE_GROUP', 'IDENTITY_OBJECT_CONFIG', 'IDENTITY_PROFILE', 'LIFECYCLE_STATE', 'NOTIFICATION_TEMPLATE', 'PASSWORD_POLICY', 'PASSWORD_SYNC_GROUP', 'PUBLIC_IDENTITIES_CONFIG', 'ROLE', 'RULE', 'SEGMENT', 'SERVICE_DESK_INTEGRATION', 'SOD_POLICY', 'SOURCE', 'TAG', 'TRANSFORM', 'TRIGGER_SUBSCRIPTION', 'WORKFLOW' ] | Imported/exported object's DTO type. Import is currently only possible with the CONNECTOR_RULE, IDENTITY_OBJECT_CONFIG, IDENTITY_PROFILE, RULE, SOURCE, TRANSFORM, and TRIGGER_SUBSCRIPTION object types. | [optional]
**id** | **str** | Imported/exported object's ID. | [optional]
**name** | **str** | Imported/exported object's display name. | [optional]
}

9
docs/tools/sdk/python/Reference/Beta/Models/SpConfigObject.md
View File

@@ -20,6 +20,7 @@ Name | Type | Description | Notes
**object_type** | **str** | The object type this configuration is for. | [optional]
**reference_extractors** | **[]str** | List of json paths within an exported object of this type that represent references that need to be resolved. | [optional]
**signature_required** | **bool** | If true, this type of object will be JWS signed and cannot be modified before import. | [optional] [default to False]
**always_resolve_by_id** | **bool** | Whether this object type has to be resolved always by ID | [optional] [default to False]
**legacy_object** | **bool** | Whether this is a legacy object | [optional] [default to False]
**one_per_tenant** | **bool** | Whether there is only one object of this type | [optional] [default to False]
**exportable** | **bool** | Whether this object can be exported or it is just a reference object | [optional] [default to False]
@@ -35,6 +36,7 @@ sp_config_object = SpConfigObject(
object_type='TRIGGER_SUBSCRIPTION',
reference_extractors=[$.owner],
signature_required=False,
always_resolve_by_id=True,
legacy_object=False,
one_per_tenant=False,
exportable=True,
@@ -42,14 +44,13 @@ rules=sailpoint.beta.models.config_object_rules.Config Object Rules(
take_from_target_rules = [
sailpoint.beta.models.config_object_rule.Config Object Rule(
path = '$.enabled',
value = sailpoint.beta.models.value.value(),
mode = [RESTORE, PROMOTE], )
value = null,
modes = [RESTORE, PROMOTE], )
],
default_rules = [
sailpoint.beta.models.config_object_rule.Config Object Rule(
path = '$.enabled',
value = sailpoint.beta.models.value.value(),
mode = [RESTORE, PROMOTE], )
modes = [RESTORE, PROMOTE], )
],
editable = True, )
)

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

@@ -18,8 +18,8 @@ Format of Config Hub Object Rules
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**path** | **str** | JSONPath expression denoting the path within the object where a value substitution should be applied | [optional]
**value** | **object** | Value to be assigned at the jsonPath location within the object | [optional]
**mode** | **[]str** | Draft modes to which this rule will apply | [optional]
**value** | [**SpConfigRuleValue**](sp-config-rule-value) | | [optional]
**modes** | **[]str** | Draft modes to which this rule will apply | [optional]
}
## Example
@@ -29,8 +29,8 @@ from sailpoint.beta.models.sp_config_rule import SpConfigRule
sp_config_rule = SpConfigRule(
path='$.enabled',
value=sailpoint.beta.models.value.value(),
mode=[RESTORE, PROMOTE]
value=,
modes=[RESTORE, PROMOTE]
)
```

32
docs/tools/sdk/python/Reference/Beta/Models/SpConfigRuleValue.md Normal file
View File

@@ -0,0 +1,32 @@
---
id: beta-sp-config-rule-value
title: SpConfigRuleValue
pagination_label: SpConfigRuleValue
sidebar_label: SpConfigRuleValue
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'SpConfigRuleValue', 'BetaSpConfigRuleValue']
slug: /tools/sdk/python/beta/models/sp-config-rule-value
tags: ['SDK', 'Software Development Kit', 'SpConfigRuleValue', 'BetaSpConfigRuleValue']
---
# SpConfigRuleValue
Value to be assigned at the jsonPath location within the object
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
}
## Example
```python
from sailpoint.beta.models.sp_config_rule_value import SpConfigRuleValue
sp_config_rule_value = SpConfigRuleValue(
)
```
[[Back to top]](#)

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

@@ -31,14 +31,14 @@ sp_config_rules = SpConfigRules(
take_from_target_rules=[
sailpoint.beta.models.config_object_rule.Config Object Rule(
path = '$.enabled',
value = sailpoint.beta.models.value.value(),
mode = [RESTORE, PROMOTE], )
value = null,
modes = [RESTORE, PROMOTE], )
],
default_rules=[
sailpoint.beta.models.config_object_rule.Config Object Rule(
path = '$.enabled',
value = sailpoint.beta.models.value.value(),
mode = [RESTORE, PROMOTE], )
value = null,
modes = [RESTORE, PROMOTE], )
],
editable=True
)

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

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'TransformDefinition', 'BetaTransformD
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/Beta/Models/TransformDefinition1.md
View File

@@ -16,7 +16,7 @@ tags: ['SDK', 'Software Development Kit', 'TransformDefinition1', 'BetaTransform
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/Beta/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