mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 12:27:47 +00:00
merge changes from main and pull the latest from python docs
This commit is contained in:
darrell-thobe-sp
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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)
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -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]
|
||||
}
|
||||
|
||||
|
||||
@@ -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]
|
||||
}
|
||||
|
||||
|
||||
@@ -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]
|
||||
}
|
||||
|
||||
|
||||
@@ -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]
|
||||
}
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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]
|
||||
}
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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=,
|
||||
|
||||
@@ -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]
|
||||
}
|
||||
|
||||
@@ -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, )
|
||||
)
|
||||
|
||||
@@ -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]
|
||||
)
|
||||
|
||||
```
|
||||
|
||||
@@ -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]](#)
|
||||
|
||||
@@ -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
|
||||
)
|
||||
|
||||
@@ -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]
|
||||
}
|
||||
|
||||
|
||||
@@ -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]
|
||||
}
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -23,9 +23,6 @@ Method | HTTP request | Description
|
||||
|
||||
|
||||
## get-access-request-identity-metrics
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Return access request identity metrics
|
||||
Use this API to return information access metrics.
|
||||
|
||||
@@ -38,7 +35,6 @@ Param Type | Name | Data Type | Required | Description
|
||||
Path | identity_id | **str** | True | Manager's identity ID.
|
||||
Path | requested_object_id | **str** | True | Requested access item's ID.
|
||||
Path | type | **str** | True | Requested access item's type.
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
**object**
|
||||
@@ -71,14 +67,13 @@ with ApiClient(configuration) as api_client:
|
||||
identity_id = '7025c863-c270-4ba6-beea-edf3cb091573' # str | Manager's identity ID. # str | Manager's identity ID.
|
||||
requested_object_id = '2db501be-f0fb-4cc5-a695-334133c52891' # str | Requested access item's ID. # str | Requested access item's ID.
|
||||
type = 'ENTITLEMENT' # str | Requested access item's type. # str | Requested access item's type.
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
|
||||
try:
|
||||
# Return access request identity metrics
|
||||
|
||||
results =AccessRequestIdentityMetricsApi(api_client).get_access_request_identity_metrics(identity_id, requested_object_id, type, x_sail_point_experimental)
|
||||
results =AccessRequestIdentityMetricsApi(api_client).get_access_request_identity_metrics(identity_id, requested_object_id, type)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = AccessRequestIdentityMetricsApi(api_client).get_access_request_identity_metrics(identity_id, requested_object_id, type, x_sail_point_experimental)
|
||||
# results = AccessRequestIdentityMetricsApi(api_client).get_access_request_identity_metrics(identity_id, requested_object_id, type)
|
||||
print("The response of AccessRequestIdentityMetricsApi->get_access_request_identity_metrics:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
|
||||
@@ -748,12 +748,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 | - |
|
||||
@@ -771,7 +771,7 @@ Code | Description | Data Type | Response headers |
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.accounts_api import AccountsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.entitlement_dto import EntitlementDto
|
||||
from sailpoint.v2024.models.entitlement import Entitlement
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
@@ -812,8 +812,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)
|
||||
@@ -848,8 +848,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
|
||||
|
||||
@@ -21,8 +21,8 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get-profile-config**](#get-profile-config) | **GET** `/auth-profiles/{id}` | Get Auth Profile.
|
||||
[**get-profile-config-list**](#get-profile-config-list) | **GET** `/auth-profiles` | Get list of Auth Profiles.
|
||||
[**get-profile-config**](#get-profile-config) | **GET** `/auth-profiles/{id}` | Get Auth Profile
|
||||
[**get-profile-config-list**](#get-profile-config-list) | **GET** `/auth-profiles` | Get list of Auth Profiles
|
||||
[**patch-profile-config**](#patch-profile-config) | **PATCH** `/auth-profiles/{id}` | Patch a specified Auth Profile
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ Method | HTTP request | Description
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Get Auth Profile.
|
||||
Get Auth Profile
|
||||
This API returns auth profile information.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-profile-config)
|
||||
@@ -76,7 +76,7 @@ with ApiClient(configuration) as api_client:
|
||||
id = '2c91808a7813090a017814121919ecca' # str | ID of the Auth Profile to patch. # str | ID of the Auth Profile to patch.
|
||||
|
||||
try:
|
||||
# Get Auth Profile.
|
||||
# Get Auth Profile
|
||||
|
||||
results =AuthProfileApi(api_client).get_profile_config(x_sail_point_experimental, id)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -95,7 +95,7 @@ with ApiClient(configuration) as api_client:
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Get list of Auth Profiles.
|
||||
Get list of Auth Profiles
|
||||
This API returns a list of auth profiles.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-profile-config-list)
|
||||
@@ -107,12 +107,12 @@ Param Type | Name | Data Type | Required | Description
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**AuthProfileSummary**](../models/auth-profile-summary)
|
||||
[**List[AuthProfileSummary]**](../models/auth-profile-summary)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | List of Auth Profiles | AuthProfileSummary | - |
|
||||
200 | List of Auth Profiles | List[AuthProfileSummary] | - |
|
||||
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 | - |
|
||||
@@ -138,7 +138,7 @@ with ApiClient(configuration) as api_client:
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
|
||||
try:
|
||||
# Get list of Auth Profiles.
|
||||
# Get list of Auth Profiles
|
||||
|
||||
results =AuthProfileApi(api_client).get_profile_config_list(x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
|
||||
@@ -314,6 +314,7 @@ with ApiClient(configuration) as api_client:
|
||||
"id" : "2c90ad2a70ace7d50170acf22ca90010",
|
||||
"type" : "IDENTITY"
|
||||
},
|
||||
"reviewerId" : "2c91808568c529c60168cca6f90c1313",
|
||||
"roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
|
||||
"query" : "Search Query",
|
||||
"description" : "Role Composition Description",
|
||||
@@ -496,6 +497,7 @@ with ApiClient(configuration) as api_client:
|
||||
"id" : "2c90ad2a70ace7d50170acf22ca90010",
|
||||
"type" : "IDENTITY"
|
||||
},
|
||||
"reviewerId" : "2c91808568c529c60168cca6f90c1313",
|
||||
"roleIds" : [ "2c90ad2a70ace7d50170acf22ca90010" ],
|
||||
"query" : "Search Query",
|
||||
"description" : "Role Composition Description",
|
||||
|
||||
@@ -823,12 +823,12 @@ This API gets a list of deploys for the current tenant.
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
[**List[DeployResponse]**](../models/deploy-response)
|
||||
[**ListDeploys200Response**](../models/list-deploys200-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | List of existing deploys. | List[DeployResponse] | - |
|
||||
200 | List of existing deploys. | ListDeploys200Response | - |
|
||||
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 | - |
|
||||
@@ -845,7 +845,7 @@ Code | Description | Data Type | Response headers |
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.configuration_hub_api import ConfigurationHubApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.deploy_response import DeployResponse
|
||||
from sailpoint.v2024.models.list_deploys200_response import ListDeploys200Response
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
@@ -1211,12 +1211,12 @@ Param Type | Name | Data Type | Required | Description
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**ListFormInstancesByTenantResponse**](../models/list-form-instances-by-tenant-response)
|
||||
[**List[ListFormInstancesByTenantResponse]**](../models/list-form-instances-by-tenant-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Returns a list of form instances by tenant | ListFormInstancesByTenantResponse | - |
|
||||
200 | Returns a list of form instances by tenant | List[ListFormInstancesByTenantResponse] | - |
|
||||
400 | An error with the request occurred | SearchFormDefinitionsByTenant400Response | - |
|
||||
401 | An error with the authorization occurred | SearchFormDefinitionsByTenant400Response | - |
|
||||
403 | An error with the user permissions occurred | SearchFormDefinitionsByTenant400Response | - |
|
||||
|
||||
@@ -388,12 +388,12 @@ Path | dimension_id | **str** | True | Id of the Dimension
|
||||
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, attribute, value, created, modified**
|
||||
|
||||
### Return type
|
||||
[**List[Entitlement1]**](../models/entitlement1)
|
||||
[**List[Entitlement]**](../models/entitlement)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | List of Entitlements | List[Entitlement1] | - |
|
||||
200 | List of 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 | - |
|
||||
@@ -410,7 +410,7 @@ Code | Description | Data Type | Response headers |
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.dimensions_api import DimensionsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.entitlement1 import Entitlement1
|
||||
from sailpoint.v2024.models.entitlement import Entitlement
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
@@ -453,7 +453,7 @@ A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | role_id | **str** | True | Parent Role Id of the dimension.
|
||||
Path | dimension_id | **str** | True | ID of the Dimension
|
||||
Path | dimension_id | **str** | True | Id of the Dimension
|
||||
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.
|
||||
@@ -491,7 +491,7 @@ configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
role_id = '6603fba3004f43c687610a29195252ce' # str | Parent Role Id of the dimension. # str | Parent Role Id of the dimension.
|
||||
dimension_id = '2c9180835d191a86015d28455b4a2329' # str | ID of the Dimension # str | ID of the Dimension
|
||||
dimension_id = '2c9180835d191a86015d28455b4a2329' # str | Id of the Dimension # str | Id of the Dimension
|
||||
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)
|
||||
|
||||
@@ -97,12 +97,12 @@ Path | attribute_value | **str** | True | Technical name of the Attribute Val
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**Entitlement1**](../models/entitlement1)
|
||||
[**Entitlement**](../models/entitlement)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | OK | Entitlement1 | - |
|
||||
200 | OK | 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 | - |
|
||||
@@ -119,7 +119,7 @@ Code | Description | Data Type | Response headers |
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.entitlements_api import EntitlementsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.entitlement1 import Entitlement1
|
||||
from sailpoint.v2024.models.entitlement import Entitlement
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
@@ -228,12 +228,12 @@ Path | id | **str** | True | The entitlement ID
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**Entitlement1**](../models/entitlement1)
|
||||
[**Entitlement**](../models/entitlement)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | An entitlement | Entitlement1 | - |
|
||||
200 | An entitlement | 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 | - |
|
||||
@@ -251,7 +251,7 @@ Code | Description | Data Type | Response headers |
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.entitlements_api import EntitlementsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.entitlement1 import Entitlement1
|
||||
from sailpoint.v2024.models.entitlement import Entitlement
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
@@ -436,12 +436,12 @@ Path | id | **str** | True | Entitlement Id
|
||||
Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le*
|
||||
|
||||
### Return type
|
||||
[**List[Entitlement1]**](../models/entitlement1)
|
||||
[**List[Entitlement]**](../models/entitlement)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | List of entitlements children from an entitlement | List[Entitlement1] | - |
|
||||
200 | List of entitlements children from an entitlement | 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 | - |
|
||||
@@ -459,7 +459,7 @@ Code | Description | Data Type | Response headers |
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.entitlements_api import EntitlementsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.entitlement1 import Entitlement1
|
||||
from sailpoint.v2024.models.entitlement import Entitlement
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
@@ -511,12 +511,12 @@ Path | id | **str** | True | Entitlement Id
|
||||
Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le*
|
||||
|
||||
### Return type
|
||||
[**List[Entitlement1]**](../models/entitlement1)
|
||||
[**List[Entitlement]**](../models/entitlement)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | List of entitlements parents from an entitlement | List[Entitlement1] | - |
|
||||
200 | List of entitlements parents from an entitlement | 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 | - |
|
||||
@@ -534,7 +534,7 @@ Code | Description | Data Type | Response headers |
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.entitlements_api import EntitlementsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.entitlement1 import Entitlement1
|
||||
from sailpoint.v2024.models.entitlement import Entitlement
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
@@ -593,12 +593,12 @@ Param Type | Name | Data Type | Required | Description
|
||||
Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in*
|
||||
|
||||
### Return type
|
||||
[**List[Entitlement1]**](../models/entitlement1)
|
||||
[**List[Entitlement]**](../models/entitlement)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | List of entitlements | List[Entitlement1] | - |
|
||||
200 | List of 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 | - |
|
||||
@@ -615,7 +615,7 @@ Code | Description | Data Type | Response headers |
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.entitlements_api import EntitlementsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.entitlement1 import Entitlement1
|
||||
from sailpoint.v2024.models.entitlement import Entitlement
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
@@ -670,12 +670,12 @@ Path | id | **str** | True | ID of the entitlement to patch
|
||||
Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) |
|
||||
|
||||
### Return type
|
||||
[**Entitlement1**](../models/entitlement1)
|
||||
[**Entitlement**](../models/entitlement)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Responds with the entitlement as updated. | Entitlement1 | - |
|
||||
200 | Responds with the entitlement as updated. | 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 | - |
|
||||
@@ -693,7 +693,7 @@ Code | Description | Data Type | Response headers |
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.entitlements_api import EntitlementsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.entitlement1 import Entitlement1
|
||||
from sailpoint.v2024.models.entitlement import Entitlement
|
||||
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
@@ -776,17 +776,10 @@ with ApiClient(configuration) as api_client:
|
||||
id = '2c91808a7813090a017814121e121518' # str | Entitlement ID # str | Entitlement ID
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
entitlement_request_config = {
|
||||
"accessRequestConfig" : {
|
||||
"denialCommentRequired" : false,
|
||||
"approvalSchemes" : [ {
|
||||
"approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
|
||||
"approverType" : "GOVERNANCE_GROUP"
|
||||
}, {
|
||||
"approverId" : "e3eab852-8315-467f-9de7-70eda97f63c8",
|
||||
"approverType" : "GOVERNANCE_GROUP"
|
||||
} ],
|
||||
"requestCommentRequired" : true
|
||||
}
|
||||
"requestCommentsRequired" : false,
|
||||
"deniedCommentsRequired" : false,
|
||||
"allowEntitlementRequest" : true,
|
||||
"grantRequestApprovalSchemes" : "entitlementOwner, sourceOwner, manager, workgroup:2c918084660f45d6016617daa9210584"
|
||||
} # EntitlementRequestConfig |
|
||||
|
||||
try:
|
||||
|
||||
@@ -20,9 +20,11 @@ Method | HTTP request | Description
|
||||
[**add-access-request-recommendations-viewed-item**](#add-access-request-recommendations-viewed-item) | **POST** `/ai-access-request-recommendations/viewed-items` | Notification of Viewed Access Request Recommendations
|
||||
[**add-access-request-recommendations-viewed-items**](#add-access-request-recommendations-viewed-items) | **POST** `/ai-access-request-recommendations/viewed-items/bulk-create` | Notification of Viewed Access Request Recommendations in Bulk
|
||||
[**get-access-request-recommendations**](#get-access-request-recommendations) | **GET** `/ai-access-request-recommendations` | Identity Access Request Recommendations
|
||||
[**get-access-request-recommendations-config**](#get-access-request-recommendations-config) | **GET** `/ai-access-request-recommendations/config` | Get Access Request Recommendations config
|
||||
[**get-access-request-recommendations-ignored-items**](#get-access-request-recommendations-ignored-items) | **GET** `/ai-access-request-recommendations/ignored-items` | List of Ignored Access Request Recommendations
|
||||
[**get-access-request-recommendations-requested-items**](#get-access-request-recommendations-requested-items) | **GET** `/ai-access-request-recommendations/requested-items` | List of Requested Access Request Recommendations
|
||||
[**get-access-request-recommendations-viewed-items**](#get-access-request-recommendations-viewed-items) | **GET** `/ai-access-request-recommendations/viewed-items` | List of Viewed Access Request Recommendations
|
||||
[**set-access-request-recommendations-config**](#set-access-request-recommendations-config) | **PUT** `/ai-access-request-recommendations/config` | Update Access Request Recommendations config
|
||||
|
||||
|
||||
## add-access-request-recommendations-ignored-item
|
||||
@@ -389,6 +391,68 @@ with ApiClient(configuration) as api_client:
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-access-request-recommendations-config
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Get Access Request Recommendations config
|
||||
This API returns the configurations for Access Request Recommender for the tenant.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-access-request-recommendations-config)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Configurations for Access Request Recommender for the tenant. | AccessRequestRecommendationConfigDto | - |
|
||||
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 | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
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.v2024
|
||||
from sailpoint.v2024.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.access_request_recommendation_config_dto import AccessRequestRecommendationConfigDto
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
|
||||
try:
|
||||
# Get Access Request Recommendations config
|
||||
|
||||
results =IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_config(x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = IAIAccessRequestRecommendationsApi(api_client).get_access_request_recommendations_config(x_sail_point_experimental)
|
||||
print("The response of IAIAccessRequestRecommendationsApi->get_access_request_recommendations_config:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
print("Exception when calling IAIAccessRequestRecommendationsApi->get_access_request_recommendations_config: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-access-request-recommendations-ignored-items
|
||||
@@ -605,6 +669,78 @@ with ApiClient(configuration) as api_client:
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## set-access-request-recommendations-config
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Update Access Request Recommendations config
|
||||
This API updates the configurations for Access Request Recommender for the tenant.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/set-access-request-recommendations-config)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Body | access_request_recommendation_config_dto | [**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto) | True | The desired configurations for Access Request Recommender for the tenant.
|
||||
|
||||
### Return type
|
||||
[**AccessRequestRecommendationConfigDto**](../models/access-request-recommendation-config-dto)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Successfully updated configurations for Access Request Recommender for the tenant. | AccessRequestRecommendationConfigDto | - |
|
||||
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 | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.iai_access_request_recommendations_api import IAIAccessRequestRecommendationsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.access_request_recommendation_config_dto import AccessRequestRecommendationConfigDto
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
access_request_recommendation_config_dto = {
|
||||
"scoreThreshold" : 0.5,
|
||||
"startDateAttribute" : "startDate",
|
||||
"restrictionAttribute" : "location",
|
||||
"moverAttribute" : "isMover",
|
||||
"joinerAttribute" : "isJoiner",
|
||||
"useRestrictionAttribute" : true
|
||||
} # AccessRequestRecommendationConfigDto | The desired configurations for Access Request Recommender for the tenant.
|
||||
|
||||
try:
|
||||
# Update Access Request Recommendations config
|
||||
new_access_request_recommendation_config_dto = AccessRequestRecommendationConfigDto()
|
||||
new_access_request_recommendation_config_dto.from_json(access_request_recommendation_config_dto)
|
||||
results =IAIAccessRequestRecommendationsApi(api_client).set_access_request_recommendations_config(x_sail_point_experimental, new_access_request_recommendation_config_dto)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = IAIAccessRequestRecommendationsApi(api_client).set_access_request_recommendations_config(x_sail_point_experimental, new_access_request_recommendation_config_dto)
|
||||
print("The response of IAIAccessRequestRecommendationsApi->set_access_request_recommendations_config:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
print("Exception when calling IAIAccessRequestRecommendationsApi->set_access_request_recommendations_config: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
@@ -25,22 +25,22 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
|
||||
|
||||
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
|
||||
[**generate-identity-preview**](#generate-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview
|
||||
[**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
|
||||
[**show-identity-preview**](#show-identity-preview) | **POST** `/identity-profiles/identity-preview` | Generate Identity Profile Preview
|
||||
[**list-identity-profiles**](#list-identity-profiles) | **GET** `/identity-profiles` | List Identity Profiles
|
||||
[**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/v2024/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/v2024/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
|
||||
@@ -342,6 +338,98 @@ with ApiClient(configuration) as api_client:
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## generate-identity-preview
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Generate Identity Profile Preview
|
||||
This generates a non-persisted IdentityDetails object that will represent as the preview of the identities attribute when the given policy''s attribute config is applied.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/generate-identity-preview)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Body | identity_preview_request | [**IdentityPreviewRequest**](../models/identity-preview-request) | True | Identity Preview request body.
|
||||
|
||||
### Return type
|
||||
[**IdentityPreviewResponse**](../models/identity-preview-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Object representing the preview object with all of the identity attributes using the current mappings. | IdentityPreviewResponse | - |
|
||||
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 | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.identity_profiles_api import IdentityProfilesApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.identity_preview_request import IdentityPreviewRequest
|
||||
from sailpoint.v2024.models.identity_preview_response import IdentityPreviewResponse
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
identity_preview_request = {
|
||||
"identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
||||
"identityAttributeConfig" : {
|
||||
"attributeTransforms" : [ {
|
||||
"transformDefinition" : {
|
||||
"attributes" : {
|
||||
"attributeName" : "e-mail",
|
||||
"sourceName" : "MySource",
|
||||
"sourceId" : "2c9180877a826e68017a8c0b03da1a53"
|
||||
},
|
||||
"type" : "accountAttribute"
|
||||
},
|
||||
"identityAttributeName" : "email"
|
||||
}, {
|
||||
"transformDefinition" : {
|
||||
"attributes" : {
|
||||
"attributeName" : "e-mail",
|
||||
"sourceName" : "MySource",
|
||||
"sourceId" : "2c9180877a826e68017a8c0b03da1a53"
|
||||
},
|
||||
"type" : "accountAttribute"
|
||||
},
|
||||
"identityAttributeName" : "email"
|
||||
} ],
|
||||
"enabled" : true
|
||||
}
|
||||
} # IdentityPreviewRequest | Identity Preview request body.
|
||||
|
||||
try:
|
||||
# Generate Identity Profile Preview
|
||||
new_identity_preview_request = IdentityPreviewRequest()
|
||||
new_identity_preview_request.from_json(identity_preview_request)
|
||||
results =IdentityProfilesApi(api_client).generate_identity_preview(x_sail_point_experimental, new_identity_preview_request)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = IdentityProfilesApi(api_client).generate_identity_preview(x_sail_point_experimental, new_identity_preview_request)
|
||||
print("The response of IdentityProfilesApi->generate_identity_preview:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
print("Exception when calling IdentityProfilesApi->generate_identity_preview: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-default-identity-attribute-config
|
||||
@@ -405,8 +493,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/v2024/get-identity-profile)
|
||||
|
||||
@@ -414,7 +502,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 +510,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 +534,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 +672,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/v2024/list-identity-profiles)
|
||||
|
||||
@@ -596,7 +684,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 +693,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 +719,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
|
||||
@@ -648,94 +736,6 @@ with ApiClient(configuration) as api_client:
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## show-identity-preview
|
||||
Generate Identity Profile Preview
|
||||
Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body.
|
||||
This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/show-identity-preview)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Body | identity_preview_request | [**IdentityPreviewRequest**](../models/identity-preview-request) | True | Identity Preview request body.
|
||||
|
||||
### Return type
|
||||
[**IdentityPreviewResponse**](../models/identity-preview-response)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | A preview of the identity attributes after applying identity attributes config sent in request body. | IdentityPreviewResponse | - |
|
||||
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 | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.identity_profiles_api import IdentityProfilesApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.identity_preview_request import IdentityPreviewRequest
|
||||
from sailpoint.v2024.models.identity_preview_response import IdentityPreviewResponse
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
identity_preview_request = {
|
||||
"identityId" : "046b6c7f-0b8a-43b9-b35d-6489e6daee91",
|
||||
"identityAttributeConfig" : {
|
||||
"attributeTransforms" : [ {
|
||||
"transformDefinition" : {
|
||||
"attributes" : {
|
||||
"attributeName" : "e-mail",
|
||||
"sourceName" : "MySource",
|
||||
"sourceId" : "2c9180877a826e68017a8c0b03da1a53"
|
||||
},
|
||||
"type" : "accountAttribute"
|
||||
},
|
||||
"identityAttributeName" : "email"
|
||||
}, {
|
||||
"transformDefinition" : {
|
||||
"attributes" : {
|
||||
"attributeName" : "e-mail",
|
||||
"sourceName" : "MySource",
|
||||
"sourceId" : "2c9180877a826e68017a8c0b03da1a53"
|
||||
},
|
||||
"type" : "accountAttribute"
|
||||
},
|
||||
"identityAttributeName" : "email"
|
||||
} ],
|
||||
"enabled" : true
|
||||
}
|
||||
} # IdentityPreviewRequest | Identity Preview request body.
|
||||
|
||||
try:
|
||||
# Generate Identity Profile Preview
|
||||
new_identity_preview_request = IdentityPreviewRequest()
|
||||
new_identity_preview_request.from_json(identity_preview_request)
|
||||
results =IdentityProfilesApi(api_client).show_identity_preview(new_identity_preview_request)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = IdentityProfilesApi(api_client).show_identity_preview(new_identity_preview_request)
|
||||
print("The response of IdentityProfilesApi->show_identity_preview:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
print("Exception when calling IdentityProfilesApi->show_identity_preview: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## sync-identity-profile
|
||||
@@ -802,18 +802,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/v2024/update-identity-profile)
|
||||
|
||||
@@ -821,8 +819,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 +828,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 +853,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)
|
||||
|
||||
@@ -0,0 +1,233 @@
|
||||
---
|
||||
id: v2024-machine-accounts
|
||||
title: Machine_Accounts
|
||||
pagination_label: Machine_Accounts
|
||||
sidebar_label: Machine_Accounts
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'Machine_Accounts', 'V2024Machine_Accounts']
|
||||
slug: /tools/sdk/python/v2024/methods/machine-accounts
|
||||
tags: ['SDK', 'Software Development Kit', 'Machine_Accounts', 'V2024Machine_Accounts']
|
||||
---
|
||||
|
||||
# sailpoint.v2024.MachineAccountsApi
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get-machine-account**](#get-machine-account) | **GET** `/machine-accounts/{id}` | Machine Account Details
|
||||
[**list-machine-accounts**](#list-machine-accounts) | **GET** `/machine-accounts` | Machine Accounts List
|
||||
[**update-machine-account**](#update-machine-account) | **PATCH** `/machine-accounts/{id}` | Update a Machine Account
|
||||
|
||||
|
||||
## get-machine-account
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Machine Account Details
|
||||
Use this API to return the details for a single machine account by its ID.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-machine-account)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | Machine Account ID.
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**MachineAccount**](../models/machine-account)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Machine Account object. | MachineAccount | - |
|
||||
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 | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
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.v2024
|
||||
from sailpoint.v2024.api.machine_accounts_api import MachineAccountsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.machine_account import MachineAccount
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID.
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
|
||||
try:
|
||||
# Machine Account Details
|
||||
|
||||
results =MachineAccountsApi(api_client).get_machine_account(id, x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = MachineAccountsApi(api_client).get_machine_account(id, x_sail_point_experimental)
|
||||
print("The response of MachineAccountsApi->get_machine_account:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
print("Exception when calling MachineAccountsApi->get_machine_account: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-machine-accounts
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Machine Accounts List
|
||||
This returns a list of machine accounts.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-machine-accounts)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
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* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **source.name**: *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: **id, name, created, modified, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type**
|
||||
|
||||
### Return type
|
||||
[**List[MachineAccount]**](../models/machine-account)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | List of machine account objects | List[MachineAccount] | - |
|
||||
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 | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
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.v2024
|
||||
from sailpoint.v2024.api.machine_accounts_api import MachineAccountsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.machine_account import MachineAccount
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
||||
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* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **source.name**: *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, sw* **name**: *eq, in, sw* **nativeIdentity**: *eq, in, sw* **machineIdentity**: *eq, in, sw* **entitlements**: *eq* **accessType**: *eq, in, sw* **subType**: *eq, in, sw* **classificationMethod**: *eq, in, sw* **manuallyCorrelated**: *eq* **identity.name**: *eq, in, sw* **source.name**: *eq, in* (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, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (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, machineIdentity, identity.id, nativeIdentity, uuid, manuallyCorrelated, connectorAttributes, entitlements, identity.name, identity.type, source.id, source.name, source.type** (optional)
|
||||
|
||||
try:
|
||||
# Machine Accounts List
|
||||
|
||||
results =MachineAccountsApi(api_client).list_machine_accounts(x_sail_point_experimental, )
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = MachineAccountsApi(api_client).list_machine_accounts(x_sail_point_experimental, limit, offset, count, filters, sorters)
|
||||
print("The response of MachineAccountsApi->list_machine_accounts:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
print("Exception when calling MachineAccountsApi->list_machine_accounts: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## update-machine-account
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Update a Machine Account
|
||||
Use this API to update machine accounts details.
|
||||
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-machine-account)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | Machine Account ID.
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Body | request_body | **[]object** | True | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
||||
|
||||
### Return type
|
||||
[**MachineAccount**](../models/machine-account)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Updated Machine Account object. | MachineAccount | - |
|
||||
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 | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json-patch+json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.machine_accounts_api import MachineAccountsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.machine_account import MachineAccount
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Account ID. # str | Machine Account ID.
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
request_body = {Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}} # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
||||
request_body = {Add machine identity attribute={value=[{op=add, path=/environment, value=test}]}, Replace machine identity attribute={value=[{op=replace, path=/environment, value=test}]}, Remove machine identity attribute={value=[{op=remove, path=/environment}]}} # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
||||
|
||||
|
||||
try:
|
||||
# Update a Machine Account
|
||||
new_request_body = RequestBody()
|
||||
new_request_body.from_json(request_body)
|
||||
results =MachineAccountsApi(api_client).update_machine_account(id, x_sail_point_experimental, new_request_body)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = MachineAccountsApi(api_client).update_machine_account(id, x_sail_point_experimental, new_request_body)
|
||||
print("The response of MachineAccountsApi->update_machine_account:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
print("Exception when calling MachineAccountsApi->update_machine_account: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,371 @@
|
||||
---
|
||||
id: v2024-machine-identities
|
||||
title: Machine_Identities
|
||||
pagination_label: Machine_Identities
|
||||
sidebar_label: Machine_Identities
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'Machine_Identities', 'V2024Machine_Identities']
|
||||
slug: /tools/sdk/python/v2024/methods/machine-identities
|
||||
tags: ['SDK', 'Software Development Kit', 'Machine_Identities', 'V2024Machine_Identities']
|
||||
---
|
||||
|
||||
# sailpoint.v2024.MachineIdentitiesApi
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create-machine-identity**](#create-machine-identity) | **POST** `/machine-identities` | Create Machine Identities
|
||||
[**delete-machine-identity**](#delete-machine-identity) | **DELETE** `/machine-identities/{id}` | Delete machine identity
|
||||
[**get-machine-identity**](#get-machine-identity) | **GET** `/machine-identities/{id}` | Machine Identity Details
|
||||
[**list-machine-identities**](#list-machine-identities) | **GET** `/machine-identities` | List Machine Identities
|
||||
[**update-machine-identity**](#update-machine-identity) | **PATCH** `/machine-identities/{id}` | Update a Machine Identity
|
||||
|
||||
|
||||
## create-machine-identity
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Create Machine Identities
|
||||
Use this API to create a machine identity.
|
||||
The maximum supported length for the description field is 2000 characters.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-machine-identity)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Body | machine_identity | [**MachineIdentity**](../models/machine-identity) | True |
|
||||
|
||||
### Return type
|
||||
[**MachineIdentity**](../models/machine-identity)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Machine Identity created. | MachineIdentity | - |
|
||||
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 | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.machine_identities_api import MachineIdentitiesApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.machine_identity import MachineIdentity
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
machine_identity = {
|
||||
"created" : "2015-05-28T14:07:17Z",
|
||||
"businessApplication" : "ADService",
|
||||
"name" : "aName",
|
||||
"modified" : "2015-05-28T14:07:17Z",
|
||||
"description" : "",
|
||||
"attributes" : "{\"Region\":\"EU\"}",
|
||||
"id" : "id12345",
|
||||
"manuallyEdited" : true
|
||||
} # MachineIdentity |
|
||||
|
||||
try:
|
||||
# Create Machine Identities
|
||||
new_machine_identity = MachineIdentity()
|
||||
new_machine_identity.from_json(machine_identity)
|
||||
results =MachineIdentitiesApi(api_client).create_machine_identity(x_sail_point_experimental, new_machine_identity)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = MachineIdentitiesApi(api_client).create_machine_identity(x_sail_point_experimental, new_machine_identity)
|
||||
print("The response of MachineIdentitiesApi->create_machine_identity:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
print("Exception when calling MachineIdentitiesApi->create_machine_identity: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-machine-identity
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Delete machine identity
|
||||
The API returns successful response if the requested machine identity was deleted.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-machine-identity)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | Machine Identity ID
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
204 | No content - indicates the request was successful but there is no content to be returned in the response. | | - |
|
||||
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 | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
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.v2024
|
||||
from sailpoint.v2024.api.machine_identities_api import MachineIdentitiesApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine Identity ID
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
|
||||
try:
|
||||
# Delete machine identity
|
||||
|
||||
MachineIdentitiesApi(api_client).delete_machine_identity(id, x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# MachineIdentitiesApi(api_client).delete_machine_identity(id, x_sail_point_experimental)
|
||||
except Exception as e:
|
||||
print("Exception when calling MachineIdentitiesApi->delete_machine_identity: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-machine-identity
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Machine Identity Details
|
||||
This API returns a single machine identity using the Machine Identity ID.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-machine-identity)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | Machine Identity ID
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**MachineIdentity**](../models/machine-identity)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | A machine identity object | MachineIdentity | - |
|
||||
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 | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
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.v2024
|
||||
from sailpoint.v2024.api.machine_identities_api import MachineIdentitiesApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.machine_identity import MachineIdentity
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID # str | Machine Identity ID
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
|
||||
try:
|
||||
# Machine Identity Details
|
||||
|
||||
results =MachineIdentitiesApi(api_client).get_machine_identity(id, x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = MachineIdentitiesApi(api_client).get_machine_identity(id, x_sail_point_experimental)
|
||||
print("The response of MachineIdentitiesApi->get_machine_identity:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
print("Exception when calling MachineIdentitiesApi->get_machine_identity: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-machine-identities
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
List Machine Identities
|
||||
This API returns a list of machine identities.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-machine-identities)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
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: **businessApplication, name**
|
||||
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 | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
||||
|
||||
### Return type
|
||||
[**List[MachineIdentity]**](../models/machine-identity)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | List of machine identities. | List[MachineIdentity] | - |
|
||||
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 | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
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.v2024
|
||||
from sailpoint.v2024.api.machine_identities_api import MachineIdentitiesApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.machine_identity import MachineIdentity
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
sorters = 'businessApplication' # 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: **businessApplication, 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: **businessApplication, name** (optional)
|
||||
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)
|
||||
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
|
||||
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
|
||||
|
||||
try:
|
||||
# List Machine Identities
|
||||
|
||||
results =MachineIdentitiesApi(api_client).list_machine_identities(x_sail_point_experimental, )
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = MachineIdentitiesApi(api_client).list_machine_identities(x_sail_point_experimental, sorters, count, limit, offset)
|
||||
print("The response of MachineIdentitiesApi->list_machine_identities:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
print("Exception when calling MachineIdentitiesApi->list_machine_identities: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## update-machine-identity
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Update a Machine Identity
|
||||
Use this API to update machine identity details.
|
||||
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-machine-identity)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | Machine Identity ID.
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Body | request_body | **[]object** | True | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
||||
|
||||
### Return type
|
||||
[**MachineIdentity**](../models/machine-identity)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Updated Machine Identity object. | MachineIdentity | - |
|
||||
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 | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json-patch+json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.machine_identities_api import MachineIdentitiesApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.machine_identity import MachineIdentity
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Machine Identity ID. # str | Machine Identity ID.
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
request_body = {Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}} # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
||||
request_body = {Add machine identity attribute={value=[{op=add, path=/attributes/securityRisk, value=medium}]}, Replace machine identity attribute={value=[{op=replace, path=/attributes/securityRisk, value=medium}]}, Remove machine identity attribute={value=[{op=remove, path=/attributes/securityRisk}]}} # List[object] | A JSON of updated values [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
||||
|
||||
|
||||
try:
|
||||
# Update a Machine Identity
|
||||
new_request_body = RequestBody()
|
||||
new_request_body.from_json(request_body)
|
||||
results =MachineIdentitiesApi(api_client).update_machine_identity(id, x_sail_point_experimental, new_request_body)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = MachineIdentitiesApi(api_client).update_machine_identity(id, x_sail_point_experimental, new_request_body)
|
||||
print("The response of MachineIdentitiesApi->update_machine_identity:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
print("Exception when calling MachineIdentitiesApi->update_machine_identity: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
@@ -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/v2024/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/v2024/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:
|
||||
|
||||
@@ -529,12 +529,12 @@ Path | id | **str** | True | Id of the Notification Template
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**List[TemplateDto]**](../models/template-dto)
|
||||
[**TemplateDto**](../models/template-dto)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | A template object for your site | List[TemplateDto] | - |
|
||||
200 | A template object for your site | TemplateDto | - |
|
||||
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 | - |
|
||||
@@ -726,12 +726,12 @@ Param Type | Name | Data Type | Required | Description
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**List[PreferencesDto]**](../models/preferences-dto)
|
||||
[**PreferencesDto**](../models/preferences-dto)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Return preference for the given notification key. | List[PreferencesDto] | - |
|
||||
200 | Return preference for the given notification key. | PreferencesDto | - |
|
||||
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 | - |
|
||||
|
||||
@@ -79,9 +79,9 @@ with ApiClient(configuration) as api_client:
|
||||
"requireStrongAuthUntrustedGeographies" : true,
|
||||
"enablePasswdExpiration" : true,
|
||||
"minNumeric" : 8,
|
||||
"lastUpdated" : "2000-01-23T04:56:07.000+00:00",
|
||||
"lastUpdated" : 1939056206564,
|
||||
"validateAgainstAccountId" : false,
|
||||
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
|
||||
"dateCreated" : 1639056206564,
|
||||
"accountNameMinWordLength" : 6,
|
||||
"minUpper" : 8,
|
||||
"firstExpirationReminder" : 45,
|
||||
@@ -355,9 +355,9 @@ with ApiClient(configuration) as api_client:
|
||||
"requireStrongAuthUntrustedGeographies" : true,
|
||||
"enablePasswdExpiration" : true,
|
||||
"minNumeric" : 8,
|
||||
"lastUpdated" : "2000-01-23T04:56:07.000+00:00",
|
||||
"lastUpdated" : 1939056206564,
|
||||
"validateAgainstAccountId" : false,
|
||||
"dateCreated" : "2000-01-23T04:56:07.000+00:00",
|
||||
"dateCreated" : 1639056206564,
|
||||
"accountNameMinWordLength" : 6,
|
||||
"minUpper" : 8,
|
||||
"firstExpirationReminder" : 45,
|
||||
|
||||
@@ -73,6 +73,9 @@ Method | HTTP request | Description
|
||||
## create-role
|
||||
Create a Role
|
||||
This API creates a role.
|
||||
|
||||
You must have a token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority to call this API.
|
||||
|
||||
In addition, a ROLE_SUBADMIN may not create a role including an access profile if that access profile is associated with a source the ROLE_SUBADMIN is not associated with themselves.
|
||||
|
||||
The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles. However, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.
|
||||
@@ -420,7 +423,7 @@ with ApiClient(configuration) as api_client:
|
||||
Delete a Role
|
||||
This API deletes a Role by its ID.
|
||||
|
||||
A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
|
||||
A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-role)
|
||||
|
||||
@@ -593,7 +596,7 @@ with ApiClient(configuration) as api_client:
|
||||
## get-role
|
||||
Get a Role
|
||||
This API returns a Role by its ID.
|
||||
A user with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
|
||||
A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all Access Profiles included in the Role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-role)
|
||||
|
||||
@@ -741,12 +744,12 @@ Path | id | **str** | True | ID of the containing role
|
||||
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, attribute, value, created, modified**
|
||||
|
||||
### Return type
|
||||
[**List[Entitlement1]**](../models/entitlement1)
|
||||
[**List[Entitlement]**](../models/entitlement)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | List of Entitlements | List[Entitlement1] | - |
|
||||
200 | List of 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 | - |
|
||||
@@ -763,7 +766,7 @@ Code | Description | Data Type | Response headers |
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.roles_api import RolesApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.entitlement1 import Entitlement1
|
||||
from sailpoint.v2024.models.entitlement import Entitlement
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
@@ -797,6 +800,8 @@ with ApiClient(configuration) as api_client:
|
||||
List Roles
|
||||
This API returns a list of Roles.
|
||||
|
||||
A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-roles)
|
||||
|
||||
### Parameters
|
||||
@@ -869,7 +874,9 @@ with ApiClient(configuration) as api_client:
|
||||
## patch-role
|
||||
Patch a specified Role
|
||||
This API updates an existing role using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
|
||||
|
||||
The following fields are patchable:
|
||||
|
||||
* name
|
||||
* description
|
||||
* enabled
|
||||
@@ -881,13 +888,12 @@ The following fields are patchable:
|
||||
* accessRequestConfig
|
||||
* revokeRequestConfig
|
||||
* segments
|
||||
* accessModelMetadata
|
||||
|
||||
A user with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
|
||||
* accessModelMetadata
|
||||
A token with API, ORG_ADMIN, ROLE_ADMIN, or ROLE_SUBADMIN authority is required to call this API. In addition, a token with ROLE_SUBADMIN authority may only call this API if all access profiles included in the role are associated to Sources with management workgroups of which the ROLE_SUBADMIN is a member.
|
||||
|
||||
The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing roles, however, any new roles as well as any updates to existing descriptions will be limited to 2000 characters.
|
||||
|
||||
When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time.
|
||||
When you use this API to modify a role's membership identities, you can only modify up to a limit of 500 membership identities at a time.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-role)
|
||||
|
||||
|
||||
@@ -48,12 +48,12 @@ Param Type | Name | Data Type | Required | Description
|
||||
Body | sim_integration_details | [**SimIntegrationDetails**](../models/sim-integration-details) | True | DTO containing the details of the SIM integration
|
||||
|
||||
### Return type
|
||||
[**ServiceDeskIntegrationDto1**](../models/service-desk-integration-dto1)
|
||||
[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | details of the created integration | ServiceDeskIntegrationDto1 | - |
|
||||
200 | details of the created integration | ServiceDeskIntegrationDto | - |
|
||||
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 | - |
|
||||
@@ -71,7 +71,7 @@ Code | Description | Data Type | Response headers |
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.service_desk_integration_dto1 import ServiceDeskIntegrationDto1
|
||||
from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto
|
||||
from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
@@ -84,9 +84,9 @@ with ApiClient(configuration) as api_client:
|
||||
"statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}",
|
||||
"request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}",
|
||||
"sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ],
|
||||
"created" : "2023-01-03T21:16:22.432Z",
|
||||
"created" : "2015-05-28T14:07:17Z",
|
||||
"name" : "aName",
|
||||
"modified" : "2023-01-03T21:16:22.432Z",
|
||||
"modified" : "2015-05-28T14:07:17Z",
|
||||
"description" : "Integration description",
|
||||
"attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}",
|
||||
"id" : "id12345",
|
||||
@@ -194,12 +194,12 @@ Path | id | **str** | True | The id of the integration.
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**ServiceDeskIntegrationDto1**](../models/service-desk-integration-dto1)
|
||||
[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | The DTO containing the details of the SIM integration | ServiceDeskIntegrationDto1 | - |
|
||||
200 | The DTO containing the details of the SIM integration | ServiceDeskIntegrationDto | - |
|
||||
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 | - |
|
||||
@@ -217,7 +217,7 @@ Code | Description | Data Type | Response headers |
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.service_desk_integration_dto1 import ServiceDeskIntegrationDto1
|
||||
from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
@@ -258,12 +258,12 @@ Param Type | Name | Data Type | Required | Description
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**ServiceDeskIntegrationDto1**](../models/service-desk-integration-dto1)
|
||||
[**List[ServiceDeskIntegrationDto]**](../models/service-desk-integration-dto)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | The DTO containing the details of the SIM integration | ServiceDeskIntegrationDto1 | - |
|
||||
200 | The DTO containing the details of the SIM integration | List[ServiceDeskIntegrationDto] | - |
|
||||
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 | - |
|
||||
@@ -281,7 +281,7 @@ Code | Description | Data Type | Response headers |
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.service_desk_integration_dto1 import ServiceDeskIntegrationDto1
|
||||
from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
@@ -323,12 +323,12 @@ Path | id | **str** | True | SIM integration id
|
||||
Body | json_patch | [**JsonPatch**](../models/json-patch) | True | The JsonPatch object that describes the changes of SIM beforeProvisioningRule.
|
||||
|
||||
### Return type
|
||||
[**ServiceDeskIntegrationDto1**](../models/service-desk-integration-dto1)
|
||||
[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | The updated DTO containing the details of the SIM integration. | ServiceDeskIntegrationDto1 | - |
|
||||
200 | The updated DTO containing the details of the SIM integration. | ServiceDeskIntegrationDto | - |
|
||||
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 | - |
|
||||
@@ -347,7 +347,7 @@ import sailpoint.v2024
|
||||
from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.json_patch import JsonPatch
|
||||
from sailpoint.v2024.models.service_desk_integration_dto1 import ServiceDeskIntegrationDto1
|
||||
from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
@@ -355,7 +355,17 @@ configuration = Configuration()
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = '12345' # str | SIM integration id # str | SIM integration id
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
json_patch = "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule.
|
||||
json_patch = {
|
||||
"operations" : [ {
|
||||
"op" : "replace",
|
||||
"path" : "/description",
|
||||
"value" : "New description"
|
||||
}, {
|
||||
"op" : "replace",
|
||||
"path" : "/description",
|
||||
"value" : "New description"
|
||||
} ]
|
||||
} # JsonPatch | The JsonPatch object that describes the changes of SIM beforeProvisioningRule.
|
||||
|
||||
try:
|
||||
# Patch a SIM beforeProvisioningRule attribute.
|
||||
@@ -392,12 +402,12 @@ Path | id | **str** | True | SIM integration id
|
||||
Body | json_patch | [**JsonPatch**](../models/json-patch) | True | The JsonPatch object that describes the changes of SIM
|
||||
|
||||
### Return type
|
||||
[**ServiceDeskIntegrationDto1**](../models/service-desk-integration-dto1)
|
||||
[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | The updated DTO containing the details of the SIM integration. | ServiceDeskIntegrationDto1 | - |
|
||||
200 | The updated DTO containing the details of the SIM integration. | ServiceDeskIntegrationDto | - |
|
||||
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 | - |
|
||||
@@ -416,7 +426,7 @@ import sailpoint.v2024
|
||||
from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.json_patch import JsonPatch
|
||||
from sailpoint.v2024.models.service_desk_integration_dto1 import ServiceDeskIntegrationDto1
|
||||
from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
@@ -424,7 +434,17 @@ configuration = Configuration()
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = '12345' # str | SIM integration id # str | SIM integration id
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
json_patch = "[\n {\n\t \"op\": \"replace\",\n\t \"path\": \"/description\",\n\t \"value\": \"A new description\"\n }\n]" # JsonPatch | The JsonPatch object that describes the changes of SIM
|
||||
json_patch = {
|
||||
"operations" : [ {
|
||||
"op" : "replace",
|
||||
"path" : "/description",
|
||||
"value" : "New description"
|
||||
}, {
|
||||
"op" : "replace",
|
||||
"path" : "/description",
|
||||
"value" : "New description"
|
||||
} ]
|
||||
} # JsonPatch | The JsonPatch object that describes the changes of SIM
|
||||
|
||||
try:
|
||||
# Patch a SIM attribute.
|
||||
@@ -461,12 +481,12 @@ Path | id | **str** | True | The id of the integration.
|
||||
Body | sim_integration_details | [**SimIntegrationDetails**](../models/sim-integration-details) | True | The full DTO of the integration containing the updated model
|
||||
|
||||
### Return type
|
||||
[**ServiceDeskIntegrationDto1**](../models/service-desk-integration-dto1)
|
||||
[**ServiceDeskIntegrationDto**](../models/service-desk-integration-dto)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | details of the updated integration | ServiceDeskIntegrationDto1 | - |
|
||||
200 | details of the updated integration | ServiceDeskIntegrationDto | - |
|
||||
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 | - |
|
||||
@@ -484,7 +504,7 @@ Code | Description | Data Type | Response headers |
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.sim_integrations_api import SIMIntegrationsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.service_desk_integration_dto1 import ServiceDeskIntegrationDto1
|
||||
from sailpoint.v2024.models.service_desk_integration_dto import ServiceDeskIntegrationDto
|
||||
from sailpoint.v2024.models.sim_integration_details import SimIntegrationDetails
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
@@ -498,9 +518,9 @@ with ApiClient(configuration) as api_client:
|
||||
"statusMap" : "{closed_cancelled=Failed, closed_complete=Committed, closed_incomplete=Failed, closed_rejected=Failed, in_process=Queued, requested=Queued}",
|
||||
"request" : "{description=SailPoint Access Request,, req_description=The Service Request created by SailPoint ServiceNow Service Integration Module (SIM).,, req_short_description=SailPoint New Access Request Created from IdentityNow,, short_description=SailPoint Access Request $!plan.arguments.identityRequestId}",
|
||||
"sources" : [ "2c9180835d191a86015d28455b4a2329", "2c5680835d191a85765d28455b4a9823" ],
|
||||
"created" : "2023-01-03T21:16:22.432Z",
|
||||
"created" : "2015-05-28T14:07:17Z",
|
||||
"name" : "aName",
|
||||
"modified" : "2023-01-03T21:16:22.432Z",
|
||||
"modified" : "2015-05-28T14:07:17Z",
|
||||
"description" : "Integration description",
|
||||
"attributes" : "{\"uid\":\"Walter White\",\"firstname\":\"walter\",\"cloudStatus\":\"UNREGISTERED\",\"displayName\":\"Walter White\",\"identificationNumber\":\"942\",\"lastSyncDate\":1470348809380,\"email\":\"walter@gmail.com\",\"lastname\":\"white\"}",
|
||||
"id" : "id12345",
|
||||
|
||||
@@ -25,9 +25,6 @@ Method | HTTP request | Description
|
||||
|
||||
|
||||
## export-sp-config
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Initiates configuration objects export job
|
||||
This post will export objects from the tenant to a JSON configuration file.
|
||||
For more information about the object types that currently support export functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
|
||||
@@ -38,7 +35,6 @@ For more information about the object types that currently support export functi
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Body | export_payload | [**ExportPayload**](../models/export-payload) | True | Export options control what will be included in the export.
|
||||
|
||||
### Return type
|
||||
@@ -72,7 +68,6 @@ from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
export_payload = {
|
||||
"description" : "Export Job 1 Test"
|
||||
} # ExportPayload | Export options control what will be included in the export.
|
||||
@@ -81,9 +76,9 @@ with ApiClient(configuration) as api_client:
|
||||
# Initiates configuration objects export job
|
||||
new_export_payload = ExportPayload()
|
||||
new_export_payload.from_json(export_payload)
|
||||
results =SPConfigApi(api_client).export_sp_config(x_sail_point_experimental, new_export_payload)
|
||||
results =SPConfigApi(api_client).export_sp_config(new_export_payload)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SPConfigApi(api_client).export_sp_config(x_sail_point_experimental, new_export_payload)
|
||||
# results = SPConfigApi(api_client).export_sp_config(new_export_payload)
|
||||
print("The response of SPConfigApi->export_sp_config:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
@@ -95,9 +90,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-sp-config-export
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Download export job result.
|
||||
This endpoint gets the export file resulting from the export job with the requested `id` and downloads it to a file.
|
||||
The request will need one of the following security scopes:
|
||||
@@ -110,7 +102,6 @@ The request will need one of the following security scopes:
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | The ID of the export job whose results will be downloaded.
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**SpConfigExportResults**](../models/sp-config-export-results)
|
||||
@@ -143,14 +134,13 @@ configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose results will be downloaded. # str | The ID of the export job whose results will be downloaded.
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
|
||||
try:
|
||||
# Download export job result.
|
||||
|
||||
results =SPConfigApi(api_client).get_sp_config_export(id, x_sail_point_experimental)
|
||||
results =SPConfigApi(api_client).get_sp_config_export(id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SPConfigApi(api_client).get_sp_config_export(id, x_sail_point_experimental)
|
||||
# results = SPConfigApi(api_client).get_sp_config_export(id)
|
||||
print("The response of SPConfigApi->get_sp_config_export:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
@@ -162,9 +152,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-sp-config-export-status
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Get export job status
|
||||
This gets the status of the export job identified by the `id` parameter.
|
||||
The request will need one of the following security scopes:
|
||||
@@ -177,7 +164,6 @@ The request will need one of the following security scopes:
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | The ID of the export job whose status will be returned.
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**SpConfigExportJobStatus**](../models/sp-config-export-job-status)
|
||||
@@ -210,14 +196,13 @@ configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the export job whose status will be returned. # str | The ID of the export job whose status will be returned.
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
|
||||
try:
|
||||
# Get export job status
|
||||
|
||||
results =SPConfigApi(api_client).get_sp_config_export_status(id, x_sail_point_experimental)
|
||||
results =SPConfigApi(api_client).get_sp_config_export_status(id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SPConfigApi(api_client).get_sp_config_export_status(id, x_sail_point_experimental)
|
||||
# results = SPConfigApi(api_client).get_sp_config_export_status(id)
|
||||
print("The response of SPConfigApi->get_sp_config_export_status:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
@@ -229,9 +214,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-sp-config-import
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Download import job result
|
||||
This gets import file resulting from the import job with the requested id and downloads it to a file. The downloaded file will contain the results of the import operation, including any error, warning or informational messages associated with the import.
|
||||
The request will need the following security scope:
|
||||
@@ -244,7 +226,6 @@ The request will need the following security scope:
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | The ID of the import job whose results will be downloaded.
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**SpConfigImportResults**](../models/sp-config-import-results)
|
||||
@@ -277,14 +258,13 @@ configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose results will be downloaded. # str | The ID of the import job whose results will be downloaded.
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
|
||||
try:
|
||||
# Download import job result
|
||||
|
||||
results =SPConfigApi(api_client).get_sp_config_import(id, x_sail_point_experimental)
|
||||
results =SPConfigApi(api_client).get_sp_config_import(id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SPConfigApi(api_client).get_sp_config_import(id, x_sail_point_experimental)
|
||||
# results = SPConfigApi(api_client).get_sp_config_import(id)
|
||||
print("The response of SPConfigApi->get_sp_config_import:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
@@ -296,9 +276,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-sp-config-import-status
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Get import job status
|
||||
'This gets the status of the import job identified by the `id` parameter.
|
||||
|
||||
@@ -313,7 +290,6 @@ Get import job status
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | The ID of the import job whose status will be returned.
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**SpConfigImportJobStatus**](../models/sp-config-import-job-status)
|
||||
@@ -346,14 +322,13 @@ configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the import job whose status will be returned. # str | The ID of the import job whose status will be returned.
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
|
||||
try:
|
||||
# Get import job status
|
||||
|
||||
results =SPConfigApi(api_client).get_sp_config_import_status(id, x_sail_point_experimental)
|
||||
results =SPConfigApi(api_client).get_sp_config_import_status(id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SPConfigApi(api_client).get_sp_config_import_status(id, x_sail_point_experimental)
|
||||
# results = SPConfigApi(api_client).get_sp_config_import_status(id)
|
||||
print("The response of SPConfigApi->get_sp_config_import_status:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
@@ -365,22 +340,17 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## import-sp-config
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Initiates configuration objects import job
|
||||
"This post will import objects from a JSON configuration file into\
|
||||
\ a tenant. By default, every import will first export all existing objects supported\
|
||||
\ by sp-config as a backup before the import is attempted. The backup is provided\
|
||||
\ so that the state of the configuration prior to the import is available for\
|
||||
\ inspection or restore if needed. The backup can be skipped by setting \"excludeBackup\"\
|
||||
\ to true in the import options. If a backup is performed, the id of the backup\
|
||||
\ will be provided in the ImportResult as the \"exportJobId\". This can be downloaded\
|
||||
\ using the `/sp-config/export/{exportJobId}/download` endpoint.\nYou cannot currently\
|
||||
\ import from the Non-Employee Lifecycle Management (NELM) source. You cannot\
|
||||
\ use this endpoint to back up or store NELM data. \nFor more information about\
|
||||
\ the object types that currently support import functionality, refer to [SaaS\
|
||||
\ Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects)."
|
||||
This post will import objects from a JSON configuration file into a tenant.
|
||||
By default, every import will first export all existing objects supported by sp-config as a backup before the import is attempted.
|
||||
The backup is provided so that the state of the configuration prior to the import is available for inspection or restore if needed.
|
||||
The backup can be skipped by setting "excludeBackup" to true in the import options.
|
||||
If a backup is performed, the id of the backup will be provided in the ImportResult as the "exportJobId". This can be downloaded
|
||||
using the `/sp-config/export/{exportJobId}/download` endpoint.
|
||||
|
||||
You cannot currently import from the Non-Employee Lifecycle Management (NELM) source. You cannot use this endpoint to back up or store NELM data.
|
||||
|
||||
For more information about the object types that currently support import functionality, refer to [SaaS Configuration](https://developer.sailpoint.com/idn/docs/saas-configuration/#supported-objects).
|
||||
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-sp-config)
|
||||
@@ -389,7 +359,6 @@ Initiates configuration objects import job
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
| data | **bytearray** | True | JSON file containing the objects to be imported.
|
||||
Query | preview | **bool** | (optional) (default to False) | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported.
|
||||
| options | [**ImportOptions**](../models/import-options) | (optional) |
|
||||
@@ -425,7 +394,6 @@ from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
data = None # bytearray | JSON file containing the objects to be imported. # bytearray | JSON file containing the objects to be imported.
|
||||
preview = False # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False) # bool | This option is intended to give the user information about how an import operation would proceed, without having any effect on the target tenant. If this parameter is \"true\", no objects will be imported. Instead, the import process will pre-process the import file and attempt to resolve references within imported objects. The import result file will contain messages pertaining to how specific references were resolved, any errors associated with the preprocessing, and messages indicating which objects would be imported. (optional) (default to False)
|
||||
options = sailpoint.v2024.ImportOptions() # ImportOptions | (optional)
|
||||
@@ -433,9 +401,9 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# Initiates configuration objects import job
|
||||
|
||||
results =SPConfigApi(api_client).import_sp_config(x_sail_point_experimental, data, )
|
||||
results =SPConfigApi(api_client).import_sp_config(data, )
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SPConfigApi(api_client).import_sp_config(x_sail_point_experimental, data, preview, options)
|
||||
# results = SPConfigApi(api_client).import_sp_config(data, preview, options)
|
||||
print("The response of SPConfigApi->import_sp_config:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
@@ -447,19 +415,13 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-sp-config-objects
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Get config object details
|
||||
This gets the list of object configurations which are known to the tenant export/import service. Object configurations that contain "importUrl" and "exportUrl" are available for export/import.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-sp-config-objects)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
[**List[SpConfigObject]**](../models/sp-config-object)
|
||||
@@ -491,14 +453,13 @@ from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
|
||||
try:
|
||||
# Get config object details
|
||||
|
||||
results =SPConfigApi(api_client).list_sp_config_objects(x_sail_point_experimental)
|
||||
results =SPConfigApi(api_client).list_sp_config_objects()
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SPConfigApi(api_client).list_sp_config_objects(x_sail_point_experimental)
|
||||
# results = SPConfigApi(api_client).list_sp_config_objects()
|
||||
print("The response of SPConfigApi->list_sp_config_objects:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
|
||||
@@ -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:
|
||||
|
||||
@@ -41,6 +41,9 @@ Method | HTTP request | Description
|
||||
|
||||
|
||||
## create-search-attribute-config
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Create Extended Search Attributes
|
||||
Create and configure extended search attributes. This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create and attribute promotion configuration in the Link ObjectConfig.
|
||||
|
||||
@@ -50,6 +53,7 @@ Create and configure extended search attributes. This API accepts an attribute n
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Body | search_attribute_config | [**SearchAttributeConfig**](../models/search-attribute-config) | True |
|
||||
|
||||
### Return type
|
||||
@@ -82,6 +86,7 @@ from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
search_attribute_config = {
|
||||
"displayName" : "New Mail Attribute",
|
||||
"name" : "newMailAttribute",
|
||||
@@ -95,9 +100,9 @@ with ApiClient(configuration) as api_client:
|
||||
# Create Extended Search Attributes
|
||||
new_search_attribute_config = SearchAttributeConfig()
|
||||
new_search_attribute_config.from_json(search_attribute_config)
|
||||
results =SearchAttributeConfigurationApi(api_client).create_search_attribute_config(new_search_attribute_config)
|
||||
results =SearchAttributeConfigurationApi(api_client).create_search_attribute_config(x_sail_point_experimental, new_search_attribute_config)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(new_search_attribute_config)
|
||||
# results = SearchAttributeConfigurationApi(api_client).create_search_attribute_config(x_sail_point_experimental, new_search_attribute_config)
|
||||
print("The response of SearchAttributeConfigurationApi->create_search_attribute_config:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
@@ -109,6 +114,9 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-search-attribute-config
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Delete Extended Search Attribute
|
||||
Delete an extended attribute configuration by name.
|
||||
|
||||
@@ -119,6 +127,7 @@ Delete an extended attribute configuration by name.
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | name | **str** | True | Name of the extended search attribute configuration to delete.
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
@@ -127,7 +136,6 @@ Path | name | **str** | True | Name of the extended search attribute configur
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
204 | No content - indicates the request was successful but there is no content to be returned in the response. | | - |
|
||||
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 | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
@@ -150,13 +158,14 @@ configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
name = 'newMailAttribute' # str | Name of the extended search attribute configuration to delete. # str | Name of the extended search attribute configuration to delete.
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
|
||||
try:
|
||||
# Delete Extended Search Attribute
|
||||
|
||||
SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name)
|
||||
SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name, x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name)
|
||||
# SearchAttributeConfigurationApi(api_client).delete_search_attribute_config(name, x_sail_point_experimental)
|
||||
except Exception as e:
|
||||
print("Exception when calling SearchAttributeConfigurationApi->delete_search_attribute_config: %s\n" % e)
|
||||
```
|
||||
@@ -166,13 +175,19 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-search-attribute-config
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
List Extended Search Attributes
|
||||
Get a list of attribute/application associates currently configured in Identity Security Cloud (ISC).
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-search-attribute-config)
|
||||
|
||||
### Parameters
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**List[SearchAttributeConfig]**](../models/search-attribute-config)
|
||||
@@ -180,8 +195,7 @@ This endpoint does not need any parameter.
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | List of attribute configurations in IdentityNow. | List[SearchAttributeConfig] | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
200 | List of attribute configurations in ISC. | List[SearchAttributeConfig] | - |
|
||||
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 | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
@@ -203,13 +217,14 @@ from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
|
||||
try:
|
||||
# List Extended Search Attributes
|
||||
|
||||
results =SearchAttributeConfigurationApi(api_client).get_search_attribute_config()
|
||||
results =SearchAttributeConfigurationApi(api_client).get_search_attribute_config(x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config()
|
||||
# results = SearchAttributeConfigurationApi(api_client).get_search_attribute_config(x_sail_point_experimental)
|
||||
print("The response of SearchAttributeConfigurationApi->get_search_attribute_config:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
@@ -221,6 +236,9 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-single-search-attribute-config
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Get Extended Search Attribute
|
||||
Get an extended attribute configuration by name.
|
||||
|
||||
@@ -230,17 +248,17 @@ Get an extended attribute configuration by name.
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | name | **str** | True | Name of the extended search attribute configuration to retrieve.
|
||||
Path | name | **str** | True | Name of the extended search attribute configuration to get.
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**List[SearchAttributeConfig]**](../models/search-attribute-config)
|
||||
[**SearchAttributeConfig**](../models/search-attribute-config)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Specific attribute configuration in ISC. | List[SearchAttributeConfig] | - |
|
||||
200 | Specific attribute configuration in IdentityNow. | SearchAttributeConfig | - |
|
||||
204 | No content - indicates the request was successful but there is no content to be returned in the response. | | - |
|
||||
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 | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
@@ -263,14 +281,15 @@ from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
name = 'newMailAttribute' # str | Name of the extended search attribute configuration to retrieve. # str | Name of the extended search attribute configuration to retrieve.
|
||||
name = 'newMailAttribute' # str | Name of the extended search attribute configuration to get. # str | Name of the extended search attribute configuration to get.
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
|
||||
try:
|
||||
# Get Extended Search Attribute
|
||||
|
||||
results =SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name)
|
||||
results =SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name, x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name)
|
||||
# results = SearchAttributeConfigurationApi(api_client).get_single_search_attribute_config(name, x_sail_point_experimental)
|
||||
print("The response of SearchAttributeConfigurationApi->get_single_search_attribute_config:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
@@ -282,6 +301,9 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## patch-search-attribute-config
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Update Extended Search Attribute
|
||||
Update an existing search attribute configuration.
|
||||
You can patch these fields:
|
||||
@@ -294,6 +316,7 @@ You can patch these fields:
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | name | **str** | True | Name of the search attribute configuration to patch.
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True |
|
||||
|
||||
### Return type
|
||||
@@ -302,7 +325,7 @@ Path | name | **str** | True | Name of the search attribute configuration to
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | The updated search attribute configuration. | SearchAttributeConfig | - |
|
||||
200 | Responds with the search attribute configuration as updated. | SearchAttributeConfig | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
@@ -328,6 +351,7 @@ configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
name = 'promotedMailAttribute' # str | Name of the search attribute configuration to patch. # str | Name of the search attribute configuration to patch.
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
[{op=replace, path=/name, value=newAttributeName}, {op=replace, path=/displayName, value=new attribute display name}, {op=add, path=/applicationAttributes, value={2c91808b79fd2422017a0b35d30f3968=employeeNumber}}] # List[JsonPatchOperation] |
|
||||
json_patch_operation = {
|
||||
"op" : "replace",
|
||||
@@ -340,9 +364,9 @@ with ApiClient(configuration) as api_client:
|
||||
# Update Extended Search Attribute
|
||||
new_json_patch_operation = JsonPatchOperation()
|
||||
new_json_patch_operation.from_json(json_patch_operation)
|
||||
results =SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, new_json_patch_operation)
|
||||
results =SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, x_sail_point_experimental, new_json_patch_operation)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, new_json_patch_operation)
|
||||
# results = SearchAttributeConfigurationApi(api_client).patch_search_attribute_config(name, x_sail_point_experimental, new_json_patch_operation)
|
||||
print("The response of SearchAttributeConfigurationApi->patch_search_attribute_config:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
|
||||
@@ -1318,12 +1318,12 @@ Path | id | **str** | True | The Source id
|
||||
Query | locale | **str** | (optional) | The locale to apply to the config. If no viable locale is given, it will default to \"en\"
|
||||
|
||||
### Return type
|
||||
[**ConnectorDetail1**](../models/connector-detail1)
|
||||
[**ConnectorDetail**](../models/connector-detail)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | A Connector Detail object | ConnectorDetail1 | - |
|
||||
200 | A Connector Detail object | ConnectorDetail | - |
|
||||
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 | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
@@ -1340,7 +1340,7 @@ Code | Description | Data Type | Response headers |
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.sources_api import SourcesApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.connector_detail1 import ConnectorDetail1
|
||||
from sailpoint.v2024.models.connector_detail import ConnectorDetail
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
@@ -28,9 +28,6 @@ Method | HTTP request | Description
|
||||
|
||||
|
||||
## get-sed-batch-stats
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Submit Sed Batch Stats Request
|
||||
'Submit Sed Batch Stats Request.
|
||||
|
||||
@@ -45,7 +42,6 @@ Submit Sed Batch Stats Request
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | batch_id | **str** | True | Batch Id
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
|
||||
### Return type
|
||||
[**SedBatchStats**](../models/sed-batch-stats)
|
||||
@@ -78,14 +74,13 @@ configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
batch_id = '8c190e67-87aa-4ed9-a90b-d9d5344523fb' # str | Batch Id # str | Batch Id
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
|
||||
try:
|
||||
# Submit Sed Batch Stats Request
|
||||
|
||||
results =SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id, x_sail_point_experimental)
|
||||
results =SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id, x_sail_point_experimental)
|
||||
# results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batch_stats(batch_id)
|
||||
print("The response of SuggestedEntitlementDescriptionApi->get_sed_batch_stats:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
@@ -97,9 +92,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-sed-batches
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
List Sed Batch Request
|
||||
List Sed Batches.
|
||||
API responses with Sed Batch Status
|
||||
@@ -107,10 +99,7 @@ API responses with Sed Batch Status
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-sed-batches)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
[**SedBatchStatus**](../models/sed-batch-status)
|
||||
@@ -142,14 +131,13 @@ from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
|
||||
try:
|
||||
# List Sed Batch Request
|
||||
|
||||
results =SuggestedEntitlementDescriptionApi(api_client).get_sed_batches(x_sail_point_experimental)
|
||||
results =SuggestedEntitlementDescriptionApi(api_client).get_sed_batches()
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batches(x_sail_point_experimental)
|
||||
# results = SuggestedEntitlementDescriptionApi(api_client).get_sed_batches()
|
||||
print("The response of SuggestedEntitlementDescriptionApi->get_sed_batches:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
@@ -161,9 +149,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-seds
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
List Suggested Entitlement Descriptions
|
||||
List of Suggested Entitlement Descriptions (SED)
|
||||
|
||||
@@ -187,14 +172,14 @@ SED field descriptions:
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Query | limit | **int** | (optional) | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used.
|
||||
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: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co*
|
||||
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: **displayName, sourceName, status**
|
||||
Query | count | **bool** | (optional) | 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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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.
|
||||
Query | count_only | **bool** | (optional) | 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. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array.
|
||||
Query | requested_by_anyone | **bool** | (optional) | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested
|
||||
Query | show_pending_status_only | **bool** | (optional) | Will limit records to items that are in \"suggested\" or \"approved\" status
|
||||
Query | count_only | **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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array.
|
||||
Query | requested_by_anyone | **bool** | (optional) (default to False) | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested
|
||||
Query | show_pending_status_only | **bool** | (optional) (default to False) | Will limit records to items that are in \"suggested\" or \"approved\" status
|
||||
|
||||
### Return type
|
||||
[**List[Sed]**](../models/sed)
|
||||
@@ -226,21 +211,21 @@ from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
limit = limit=25 # int | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional) # int | Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional)
|
||||
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 = 'displayName co \"Read and Write\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **batchId**: *eq, ne* **displayName**: *eq, ne, co* **sourceName**: *eq, ne, co* **sourceId**: *eq, ne* **status**: *eq, ne* **fullText**: *co* (optional)
|
||||
sorters = 'sorters=displayName' # 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: **displayName, sourceName, status** (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: **displayName, sourceName, status** (optional)
|
||||
count = count=true # 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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. (optional) # 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. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). 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. (optional)
|
||||
count_only = count-only=true # 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. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. (optional) # 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. This parameter differs from the Coun parameter in that this one skip executing the actual query and always return an empty array. (optional)
|
||||
requested_by_anyone = requested-by-anyone=true # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional)
|
||||
show_pending_status_only = show-pending-status-only=true # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional)
|
||||
count_only = 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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (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. This parameter differs from the count parameter in that this one skips executing the actual query and always return an empty array. (optional) (default to False)
|
||||
requested_by_anyone = False # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to False) # bool | By default, the ListSeds API will only return items that you have requested to be generated. This option will allow you to see all items that have been requested (optional) (default to False)
|
||||
show_pending_status_only = False # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) (default to False) # bool | Will limit records to items that are in \"suggested\" or \"approved\" status (optional) (default to False)
|
||||
|
||||
try:
|
||||
# List Suggested Entitlement Descriptions
|
||||
|
||||
results =SuggestedEntitlementDescriptionApi(api_client).list_seds(x_sail_point_experimental, )
|
||||
results =SuggestedEntitlementDescriptionApi(api_client).list_seds()
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SuggestedEntitlementDescriptionApi(api_client).list_seds(x_sail_point_experimental, limit, filters, sorters, count, count_only, requested_by_anyone, show_pending_status_only)
|
||||
# results = SuggestedEntitlementDescriptionApi(api_client).list_seds(limit, offset, count, filters, sorters, count_only, requested_by_anyone, show_pending_status_only)
|
||||
print("The response of SuggestedEntitlementDescriptionApi->list_seds:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
@@ -252,9 +237,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## patch-sed
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Patch Suggested Entitlement Description
|
||||
Patch Suggested Entitlement Description
|
||||
|
||||
@@ -265,7 +247,6 @@ Patch Suggested Entitlement Description
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | id is sed id
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Body | sed_patch | [**[]SedPatch**](../models/sed-patch) | True | Sed Patch Request
|
||||
|
||||
### Return type
|
||||
@@ -300,7 +281,6 @@ configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'ebab396f-0af1-4050-89b7-dafc63ec70e7' # str | id is sed id # str | id is sed id
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
[sailpoint.v2024.SedPatch()] # List[SedPatch] | Sed Patch Request
|
||||
sed_patch = {
|
||||
"op" : "replace",
|
||||
@@ -313,9 +293,9 @@ with ApiClient(configuration) as api_client:
|
||||
# Patch Suggested Entitlement Description
|
||||
new_sed_patch = SedPatch()
|
||||
new_sed_patch.from_json(sed_patch)
|
||||
results =SuggestedEntitlementDescriptionApi(api_client).patch_sed(id, x_sail_point_experimental, new_sed_patch)
|
||||
results =SuggestedEntitlementDescriptionApi(api_client).patch_sed(id, new_sed_patch)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SuggestedEntitlementDescriptionApi(api_client).patch_sed(id, x_sail_point_experimental, new_sed_patch)
|
||||
# results = SuggestedEntitlementDescriptionApi(api_client).patch_sed(id, new_sed_patch)
|
||||
print("The response of SuggestedEntitlementDescriptionApi->patch_sed:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
@@ -327,9 +307,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## submit-sed-approval
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Submit Bulk Approval Request
|
||||
Submit Bulk Approval Request for SED.
|
||||
Request body takes list of SED Ids. API responses with list of SED Approval Status
|
||||
@@ -340,7 +317,6 @@ Request body takes list of SED Ids. API responses with list of SED Approval Stat
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Body | sed_approval | [**[]SedApproval**](../models/sed-approval) | True | Sed Approval
|
||||
|
||||
### Return type
|
||||
@@ -374,7 +350,6 @@ from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
[sailpoint.v2024.SedApproval()] # List[SedApproval] | Sed Approval
|
||||
sed_approval = {
|
||||
"items" : "016629d1-1d25-463f-97f3-c6686846650"
|
||||
@@ -385,9 +360,9 @@ with ApiClient(configuration) as api_client:
|
||||
# Submit Bulk Approval Request
|
||||
new_sed_approval = SedApproval()
|
||||
new_sed_approval.from_json(sed_approval)
|
||||
results =SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(x_sail_point_experimental, new_sed_approval)
|
||||
results =SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(new_sed_approval)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(x_sail_point_experimental, new_sed_approval)
|
||||
# results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_approval(new_sed_approval)
|
||||
print("The response of SuggestedEntitlementDescriptionApi->submit_sed_approval:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
@@ -399,9 +374,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## submit-sed-assignment
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Submit Sed Assignment Request
|
||||
Submit Assignment Request.
|
||||
Request body has an assignee, and list of SED Ids that are assigned to that assignee API responses with batchId that groups all approval requests together
|
||||
@@ -412,7 +384,6 @@ Request body has an assignee, and list of SED Ids that are assigned to that assi
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Body | sed_assignment | [**SedAssignment**](../models/sed-assignment) | True | Sed Assignment Request
|
||||
|
||||
### Return type
|
||||
@@ -446,7 +417,6 @@ from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
sed_assignment = {
|
||||
"assignee" : {
|
||||
"type" : "SOURCE_OWNER",
|
||||
@@ -459,9 +429,9 @@ with ApiClient(configuration) as api_client:
|
||||
# Submit Sed Assignment Request
|
||||
new_sed_assignment = SedAssignment()
|
||||
new_sed_assignment.from_json(sed_assignment)
|
||||
results =SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(x_sail_point_experimental, new_sed_assignment)
|
||||
results =SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(new_sed_assignment)
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(x_sail_point_experimental, new_sed_assignment)
|
||||
# results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_assignment(new_sed_assignment)
|
||||
print("The response of SuggestedEntitlementDescriptionApi->submit_sed_assignment:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
@@ -473,9 +443,6 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## submit-sed-batch-request
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Submit Sed Batch Request
|
||||
Submit Sed Batch Request.
|
||||
Request body has one of the following: - a list of entitlement Ids - a list of SED Ids that user wants to have description generated by LLM. API responses with batchId that groups Ids together
|
||||
@@ -486,7 +453,6 @@ Request body has one of the following: - a list of entitlement Ids - a list of S
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Body | sed_batch_request | [**SedBatchRequest**](../models/sed-batch-request) | (optional) | Sed Batch Request
|
||||
|
||||
### Return type
|
||||
@@ -520,7 +486,6 @@ from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
sed_batch_request = {
|
||||
"entitlements" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ],
|
||||
"seds" : [ "016629d1-1d25-463f-97f3-c6686846650", "016629d1-1d25-463f-97f3-c6686846650" ]
|
||||
@@ -529,9 +494,9 @@ with ApiClient(configuration) as api_client:
|
||||
try:
|
||||
# Submit Sed Batch Request
|
||||
|
||||
results =SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request(x_sail_point_experimental, )
|
||||
results =SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request()
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request(x_sail_point_experimental, new_sed_batch_request)
|
||||
# results = SuggestedEntitlementDescriptionApi(api_client).submit_sed_batch_request(new_sed_batch_request)
|
||||
print("The response of SuggestedEntitlementDescriptionApi->submit_sed_batch_request:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
|
||||
@@ -19,19 +19,13 @@ Method | HTTP request | Description
|
||||
|
||||
|
||||
## get-tenant
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Get Tenant Information.
|
||||
This rest endpoint can be used to retrieve tenant details.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-tenant)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
This endpoint does not need any parameter.
|
||||
|
||||
### Return type
|
||||
[**Tenant**](../models/tenant)
|
||||
@@ -63,14 +57,13 @@ from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
|
||||
try:
|
||||
# Get Tenant Information.
|
||||
|
||||
results =TenantApi(api_client).get_tenant(x_sail_point_experimental)
|
||||
results =TenantApi(api_client).get_tenant()
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = TenantApi(api_client).get_tenant(x_sail_point_experimental)
|
||||
# results = TenantApi(api_client).get_tenant()
|
||||
print("The response of TenantApi->get_tenant:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
|
||||
@@ -32,6 +32,7 @@ Method | HTTP request | Description
|
||||
[**approve-approval-item**](#approve-approval-item) | **POST** `/work-items/{id}/approve/{approvalItemId}` | Approve an Approval Item
|
||||
[**approve-approval-items-in-bulk**](#approve-approval-items-in-bulk) | **POST** `/work-items/bulk-approve/{id}` | Bulk approve Approval Items
|
||||
[**complete-work-item**](#complete-work-item) | **POST** `/work-items/{id}` | Complete a Work Item
|
||||
[**forward-work-item**](#forward-work-item) | **POST** `/work-items/{id}/forward` | Forward a Work Item
|
||||
[**get-completed-work-items**](#get-completed-work-items) | **GET** `/work-items/completed` | Completed Work Items
|
||||
[**get-count-completed-work-items**](#get-count-completed-work-items) | **GET** `/work-items/completed/count` | Count Completed Work Items
|
||||
[**get-count-work-items**](#get-count-work-items) | **GET** `/work-items/count` | Count Work Items
|
||||
@@ -40,7 +41,6 @@ Method | HTTP request | Description
|
||||
[**list-work-items**](#list-work-items) | **GET** `/work-items` | List Work Items
|
||||
[**reject-approval-item**](#reject-approval-item) | **POST** `/work-items/{id}/reject/{approvalItemId}` | Reject an Approval Item
|
||||
[**reject-approval-items-in-bulk**](#reject-approval-items-in-bulk) | **POST** `/work-items/bulk-reject/{id}` | Bulk reject Approval Items
|
||||
[**send-work-item-forward**](#send-work-item-forward) | **POST** `/work-items/{id}/forward` | Forward a Work Item
|
||||
[**submit-account-selection**](#submit-account-selection) | **POST** `/work-items/{id}/submit-account-selection` | Submit Account Selections
|
||||
|
||||
|
||||
@@ -224,6 +224,75 @@ with ApiClient(configuration) as api_client:
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## forward-work-item
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Forward a Work Item
|
||||
This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/forward-work-item)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | The ID of the work item
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Body | work_item_forward | [**WorkItemForward**](../models/work-item-forward) | True |
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Success, but no data is returned. | | - |
|
||||
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 | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.work_items_api import WorkItemsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.work_item_forward import WorkItemForward
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
work_item_forward = {
|
||||
"targetOwnerId" : "2c9180835d2e5168015d32f890ca1581",
|
||||
"comment" : "I'm going on vacation.",
|
||||
"sendNotifications" : true
|
||||
} # WorkItemForward |
|
||||
|
||||
try:
|
||||
# Forward a Work Item
|
||||
new_work_item_forward = WorkItemForward()
|
||||
new_work_item_forward.from_json(work_item_forward)
|
||||
WorkItemsApi(api_client).forward_work_item(id, x_sail_point_experimental, new_work_item_forward)
|
||||
# Below is a request that includes all optional parameters
|
||||
# WorkItemsApi(api_client).forward_work_item(id, x_sail_point_experimental, new_work_item_forward)
|
||||
except Exception as e:
|
||||
print("Exception when calling WorkItemsApi->forward_work_item: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-completed-work-items
|
||||
@@ -292,6 +361,9 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-count-completed-work-items
|
||||
:::warning experimental
|
||||
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to `true` to use this endpoint.
|
||||
:::
|
||||
Count Completed Work Items
|
||||
This gets a count of completed work items belonging to either the specified user(admin required), or the current user.
|
||||
|
||||
@@ -301,6 +373,7 @@ This gets a count of completed work items belonging to either the specified user
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
|
||||
Query | owner_id | **str** | (optional) | ID of the work item owner.
|
||||
|
||||
### Return type
|
||||
@@ -310,11 +383,9 @@ Param Type | Name | Data Type | Required | Description
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | List of work items | WorkItemsCount | - |
|
||||
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
|
||||
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
|
||||
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
|
||||
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
|
||||
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: Not defined
|
||||
@@ -332,14 +403,15 @@ from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
owner_id = '1211bcaa32112bcef6122adb21cef1ac' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
|
||||
x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
|
||||
owner_id = 'owner_id_example' # str | ID of the work item owner. (optional) # str | ID of the work item owner. (optional)
|
||||
|
||||
try:
|
||||
# Count Completed Work Items
|
||||
|
||||
results =WorkItemsApi(api_client).get_count_completed_work_items()
|
||||
results =WorkItemsApi(api_client).get_count_completed_work_items(x_sail_point_experimental, )
|
||||
# Below is a request that includes all optional parameters
|
||||
# results = WorkItemsApi(api_client).get_count_completed_work_items(owner_id)
|
||||
# results = WorkItemsApi(api_client).get_count_completed_work_items(x_sail_point_experimental, owner_id)
|
||||
print("The response of WorkItemsApi->get_count_completed_work_items:\n")
|
||||
pprint(results)
|
||||
except Exception as e:
|
||||
@@ -712,70 +784,6 @@ with ApiClient(configuration) as api_client:
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## send-work-item-forward
|
||||
Forward a Work Item
|
||||
This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. Accessible to work-item Owner, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/send-work-item-forward)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | The ID of the work item
|
||||
Body | work_item_forward | [**WorkItemForward**](../models/work-item-forward) | True |
|
||||
|
||||
### Return type
|
||||
(empty response body)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Success, but no data is returned. | | - |
|
||||
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 | - |
|
||||
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. | ListAccessProfiles429Response | - |
|
||||
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
|
||||
|
||||
### HTTP request headers
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
### Example
|
||||
|
||||
```python
|
||||
import sailpoint.v2024
|
||||
from sailpoint.v2024.api.work_items_api import WorkItemsApi
|
||||
from sailpoint.v2024.api_client import ApiClient
|
||||
from sailpoint.v2024.models.work_item_forward import WorkItemForward
|
||||
from pprint import pprint
|
||||
from sailpoint.configuration import Configuration
|
||||
configuration = Configuration()
|
||||
|
||||
with ApiClient(configuration) as api_client:
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8' # str | The ID of the work item # str | The ID of the work item
|
||||
work_item_forward = {
|
||||
"targetOwnerId" : "2c9180835d2e5168015d32f890ca1581",
|
||||
"comment" : "I'm going on vacation.",
|
||||
"sendNotifications" : true
|
||||
} # WorkItemForward |
|
||||
|
||||
try:
|
||||
# Forward a Work Item
|
||||
new_work_item_forward = WorkItemForward()
|
||||
new_work_item_forward.from_json(work_item_forward)
|
||||
WorkItemsApi(api_client).send_work_item_forward(id, new_work_item_forward)
|
||||
# Below is a request that includes all optional parameters
|
||||
# WorkItemsApi(api_client).send_work_item_forward(id, new_work_item_forward)
|
||||
except Exception as e:
|
||||
print("Exception when calling WorkItemsApi->send_work_item_forward: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## submit-account-selection
|
||||
|
||||
@@ -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/V2024/Models/AccessApps.md
Normal file
43
docs/tools/sdk/python/Reference/V2024/Models/AccessApps.md
Normal file
@@ -0,0 +1,43 @@
|
||||
---
|
||||
id: v2024-access-apps
|
||||
title: AccessApps
|
||||
pagination_label: AccessApps
|
||||
sidebar_label: AccessApps
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessApps', 'V2024AccessApps']
|
||||
slug: /tools/sdk/python/v2024/models/access-apps
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessApps', 'V2024AccessApps']
|
||||
---
|
||||
|
||||
# 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.v2024.models.access_apps import AccessApps
|
||||
|
||||
access_apps = AccessApps(
|
||||
id='2c91808568c529c60168cca6f90c1313',
|
||||
name='Travel and Expense',
|
||||
description='Travel and Expense Application',
|
||||
owner=sailpoint.v2024.models.access_apps_owner.AccessApps_owner(
|
||||
type = 'IDENTITY',
|
||||
id = '2c9180a46faadee4016fb4e018c20639',
|
||||
name = 'John Doe',
|
||||
email = 'john.doe@sailpoint.com', )
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,40 @@
|
||||
---
|
||||
id: v2024-access-apps-owner
|
||||
title: AccessAppsOwner
|
||||
pagination_label: AccessAppsOwner
|
||||
sidebar_label: AccessAppsOwner
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessAppsOwner', 'V2024AccessAppsOwner']
|
||||
slug: /tools/sdk/python/v2024/models/access-apps-owner
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessAppsOwner', 'V2024AccessAppsOwner']
|
||||
---
|
||||
|
||||
# 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.v2024.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]](#)
|
||||
|
||||
@@ -0,0 +1,55 @@
|
||||
---
|
||||
id: v2024-access-model-metadata
|
||||
title: AccessModelMetadata
|
||||
pagination_label: AccessModelMetadata
|
||||
sidebar_label: AccessModelMetadata
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessModelMetadata', 'V2024AccessModelMetadata']
|
||||
slug: /tools/sdk/python/v2024/models/access-model-metadata
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessModelMetadata', 'V2024AccessModelMetadata']
|
||||
---
|
||||
|
||||
# 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.v2024.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.v2024.models.access_model_metadata_values_inner.AccessModelMetadata_values_inner(
|
||||
value = 'development',
|
||||
name = 'Development',
|
||||
status = 'active', )
|
||||
]
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
id: v2024-access-model-metadata-values-inner
|
||||
title: AccessModelMetadataValuesInner
|
||||
pagination_label: AccessModelMetadataValuesInner
|
||||
sidebar_label: AccessModelMetadataValuesInner
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessModelMetadataValuesInner', 'V2024AccessModelMetadataValuesInner']
|
||||
slug: /tools/sdk/python/v2024/models/access-model-metadata-values-inner
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessModelMetadataValuesInner', 'V2024AccessModelMetadataValuesInner']
|
||||
---
|
||||
|
||||
# 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.v2024.models.access_model_metadata_values_inner import AccessModelMetadataValuesInner
|
||||
|
||||
access_model_metadata_values_inner = AccessModelMetadataValuesInner(
|
||||
value='development',
|
||||
name='Development',
|
||||
status='active'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -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.v2024.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.v2024.models.base_access_all_of_owner.BaseAccess_allOf_owner(
|
||||
owner=sailpoint.v2024.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.v2024.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.v2024.models.base_segment.BaseSegment(
|
||||
id = 'b009b6e3-b56d-41d9-8735-cb532ea0b017',
|
||||
name = 'Test Segment', )
|
||||
],
|
||||
segment_count=1,
|
||||
tags=[TAG_1, TAG_2],
|
||||
apps=[
|
||||
sailpoint.v2024.models.access_apps.AccessApps(
|
||||
id = '2c91808568c529c60168cca6f90c1313',
|
||||
name = 'Travel and Expense',
|
||||
description = 'Travel and Expense Application',
|
||||
owner = sailpoint.v2024.models.access_apps_owner.AccessApps_owner(
|
||||
type = 'IDENTITY',
|
||||
id = '2c9180a46faadee4016fb4e018c20639',
|
||||
name = 'John Doe',
|
||||
email = 'john.doe@sailpoint.com', ), )
|
||||
]
|
||||
)
|
||||
|
||||
```
|
||||
|
||||
@@ -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.v2024.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',
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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.v2024.models.reference.Reference(
|
||||
id = '2c91808568c529c60168cca6f90c1313',
|
||||
name = 'John Doe', ),
|
||||
|
||||
@@ -16,13 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequestAdminItemStatus', 'V2024
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | ID of the access request. This is a new property as of 2025. Older access requests may not have an ID. | [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** | [**AccessRequestAdminItemStatusCancelledRequestDetails**](access-request-admin-item-status-cancelled-request-details) | | [optional]
|
||||
**error_messages** | [**[]List[ErrorMessageDto1]**](error-message-dto) | List of localized error messages, if any, encountered during the approval/provisioning process. | [optional]
|
||||
**cancelled_request_details** | [**RequestedItemStatusCancelledRequestDetails**](requested-item-status-cancelled-request-details) | | [optional]
|
||||
**error_messages** | [**[]List[ErrorMessageDto]**](error-message-dto) | List of localized error messages, if any, encountered during the approval/provisioning process. | [optional]
|
||||
**state** | [**RequestedItemStatusRequestState**](requested-item-status-request-state) | | [optional]
|
||||
**approval_details** | [**[]ApprovalStatusDto1**](approval-status-dto1) | Approval details for each item. | [optional]
|
||||
**manual_work_item_details** | [**[]ManualWorkItemDetails1**](manual-work-item-details1) | Manual work items created for provisioning the item. | [optional]
|
||||
**approval_details** | [**[]ApprovalStatusDto**](approval-status-dto) | Approval details for each item. | [optional]
|
||||
**manual_work_item_details** | [**[]ManualWorkItemDetails**](manual-work-item-details) | Manual work items created for provisioning the item. | [optional]
|
||||
**account_activity_item_id** | **str** | Id of associated account activity item. | [optional]
|
||||
**request_type** | [**AccessRequestType**](access-request-type) | | [optional]
|
||||
**modified** | **datetime** | When the request was last modified. | [optional]
|
||||
@@ -30,7 +31,7 @@ Name | Type | Description | Notes
|
||||
**requester** | [**AccessItemRequester**](access-item-requester) | | [optional]
|
||||
**requested_for** | [**RequestedItemStatusRequestedFor**](requested-item-status-requested-for) | | [optional]
|
||||
**requester_comment** | [**RequestedItemStatusRequesterComment**](requested-item-status-requester-comment) | | [optional]
|
||||
**sod_violation_context** | [**AccessRequestAdminItemStatusSodViolationContext**](access-request-admin-item-status-sod-violation-context) | | [optional]
|
||||
**sod_violation_context** | [**RequestedItemStatusSodViolationContext**](requested-item-status-sod-violation-context) | | [optional]
|
||||
**provisioning_details** | [**RequestedItemStatusProvisioningDetails**](requested-item-status-provisioning-details) | | [optional]
|
||||
**pre_approval_trigger_details** | [**RequestedItemStatusPreApprovalTriggerDetails**](requested-item-status-pre-approval-trigger-details) | | [optional]
|
||||
**access_request_phases** | [**[]AccessRequestPhases**](access-request-phases) | A list of Phases that the Access Request has gone through in order, to help determine the status of the request. | [optional]
|
||||
@@ -48,6 +49,7 @@ Name | Type | Description | Notes
|
||||
from sailpoint.v2024.models.access_request_admin_item_status import AccessRequestAdminItemStatus
|
||||
|
||||
access_request_admin_item_status = AccessRequestAdminItemStatus(
|
||||
id='2c9180926cbfbddd016cbfc7c3b10010',
|
||||
name='AccessProfile1',
|
||||
type='ACCESS_PROFILE',
|
||||
cancelled_request_details=,
|
||||
@@ -56,7 +58,7 @@ error_messages=[
|
||||
],
|
||||
state='EXECUTING',
|
||||
approval_details=[
|
||||
sailpoint.v2024.models.approval_status_dto_1.ApprovalStatusDto_1(
|
||||
sailpoint.v2024.models.approval_status_dto.ApprovalStatusDto(
|
||||
forwarded = False,
|
||||
original_owner = sailpoint.v2024.models.approval_status_dto_original_owner.ApprovalStatusDto_originalOwner(
|
||||
type = 'IDENTITY',
|
||||
@@ -67,7 +69,7 @@ approval_details=[
|
||||
status = 'PENDING',
|
||||
scheme = 'MANAGER',
|
||||
error_messages = [
|
||||
sailpoint.v2024.models.error_message_dto_1.ErrorMessageDto_1(
|
||||
sailpoint.v2024.models.error_message_dto.ErrorMessageDto(
|
||||
locale = 'en-US',
|
||||
locale_origin = 'DEFAULT',
|
||||
text = 'The request was syntactically correct but its content is semantically invalid.', )
|
||||
@@ -76,7 +78,7 @@ approval_details=[
|
||||
remove_date = '2020-07-11T00:00Z', )
|
||||
],
|
||||
manual_work_item_details=[
|
||||
sailpoint.v2024.models.manual_work_item_details_1.ManualWorkItemDetails_1(
|
||||
sailpoint.v2024.models.manual_work_item_details.ManualWorkItemDetails(
|
||||
forwarded = True,
|
||||
original_owner = sailpoint.v2024.models.manual_work_item_details_original_owner.ManualWorkItemDetails_originalOwner(
|
||||
type = 'IDENTITY',
|
||||
@@ -89,7 +91,7 @@ manual_work_item_details=[
|
||||
modified = '2019-08-23T18:52:57.398Z',
|
||||
status = 'PENDING',
|
||||
forward_history = [
|
||||
sailpoint.v2024.models.approval_forward_history_1.ApprovalForwardHistory_1(
|
||||
sailpoint.v2024.models.approval_forward_history.ApprovalForwardHistory(
|
||||
old_approver_name = 'Frank Mir',
|
||||
new_approver_name = 'Al Volta',
|
||||
comment = 'Forwarding from Frank to Al',
|
||||
|
||||
@@ -1,40 +0,0 @@
|
||||
---
|
||||
id: v2024-access-request-admin-item-status-cancelled-request-details
|
||||
title: AccessRequestAdminItemStatusCancelledRequestDetails
|
||||
pagination_label: AccessRequestAdminItemStatusCancelledRequestDetails
|
||||
sidebar_label: AccessRequestAdminItemStatusCancelledRequestDetails
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessRequestAdminItemStatusCancelledRequestDetails', 'V2024AccessRequestAdminItemStatusCancelledRequestDetails']
|
||||
slug: /tools/sdk/python/v2024/models/access-request-admin-item-status-cancelled-request-details
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessRequestAdminItemStatusCancelledRequestDetails', 'V2024AccessRequestAdminItemStatusCancelledRequestDetails']
|
||||
---
|
||||
|
||||
# AccessRequestAdminItemStatusCancelledRequestDetails
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**comment** | **str** | Comment made by the owner when cancelling the associated request. | [optional]
|
||||
**owner** | [**OwnerDto**](owner-dto) | | [optional]
|
||||
**modified** | **datetime** | Date comment was added by the owner when cancelling the associated request. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.access_request_admin_item_status_cancelled_request_details import AccessRequestAdminItemStatusCancelledRequestDetails
|
||||
|
||||
access_request_admin_item_status_cancelled_request_details = AccessRequestAdminItemStatusCancelledRequestDetails(
|
||||
comment='This request must be cancelled.',
|
||||
owner=sailpoint.v2024.models.owner_dto.OwnerDto(
|
||||
type = 'IDENTITY',
|
||||
id = '2c9180a46faadee4016fb4e018c20639',
|
||||
name = 'Support', ),
|
||||
modified='2019-12-20T09:17:12.192Z'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,64 +0,0 @@
|
||||
---
|
||||
id: v2024-access-request-admin-item-status-sod-violation-context
|
||||
title: AccessRequestAdminItemStatusSodViolationContext
|
||||
pagination_label: AccessRequestAdminItemStatusSodViolationContext
|
||||
sidebar_label: AccessRequestAdminItemStatusSodViolationContext
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessRequestAdminItemStatusSodViolationContext', 'V2024AccessRequestAdminItemStatusSodViolationContext']
|
||||
slug: /tools/sdk/python/v2024/models/access-request-admin-item-status-sod-violation-context
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessRequestAdminItemStatusSodViolationContext', 'V2024AccessRequestAdminItemStatusSodViolationContext']
|
||||
---
|
||||
|
||||
# AccessRequestAdminItemStatusSodViolationContext
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**state** | **Enum** [ 'SUCCESS', 'ERROR' ] | The status of SOD violation check | [optional]
|
||||
**uuid** | **str** | The id of the Violation check event | [optional]
|
||||
**violation_check_result** | [**SodViolationCheckResult1**](sod-violation-check-result1) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.access_request_admin_item_status_sod_violation_context import AccessRequestAdminItemStatusSodViolationContext
|
||||
|
||||
access_request_admin_item_status_sod_violation_context = AccessRequestAdminItemStatusSodViolationContext(
|
||||
state='SUCCESS',
|
||||
uuid='f73d16e9-a038-46c5-b217-1246e15fdbdd',
|
||||
violation_check_result=sailpoint.v2024.models.sod_violation_check_result_1.SodViolationCheckResult_1(
|
||||
message = sailpoint.v2024.models.error_message_dto_1.ErrorMessageDto_1(
|
||||
locale = 'en-US',
|
||||
locale_origin = 'DEFAULT',
|
||||
text = 'The request was syntactically correct but its content is semantically invalid.', ),
|
||||
client_metadata = {requestedAppName=test-app, requestedAppId=2c91808f7892918f0178b78da4a305a1},
|
||||
violation_contexts = [
|
||||
sailpoint.v2024.models.sod_violation_context_1.SodViolationContext_1(
|
||||
policy = sailpoint.v2024.models.sod_policy_dto.SodPolicyDto(
|
||||
type = 'SOD_POLICY',
|
||||
id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde',
|
||||
name = 'Business SOD Policy', ),
|
||||
conflicting_access_criteria = sailpoint.v2024.models.sod_violation_context_1_conflicting_access_criteria.SodViolationContext_1_conflictingAccessCriteria(
|
||||
left_criteria = sailpoint.v2024.models.sod_violation_context_1_conflicting_access_criteria_left_criteria.SodViolationContext_1_conflictingAccessCriteria_leftCriteria(
|
||||
criteria_list = [
|
||||
sailpoint.v2024.models.sod_exempt_criteria_1.SodExemptCriteria_1(
|
||||
existing = True,
|
||||
type = 'IDENTITY',
|
||||
id = '2c918085771e9d3301773b3cb66f6398',
|
||||
name = 'My HR Entitlement', )
|
||||
], ),
|
||||
right_criteria = sailpoint.v2024.models.sod_violation_context_1_conflicting_access_criteria_left_criteria.SodViolationContext_1_conflictingAccessCriteria_leftCriteria(), ), )
|
||||
],
|
||||
violated_policies = [
|
||||
sailpoint.v2024.models.sod_policy_dto.SodPolicyDto(
|
||||
id = '0f11f2a4-7c94-4bf3-a2bd-742580fe3bde',
|
||||
name = 'Business SOD Policy', )
|
||||
], )
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -21,7 +21,7 @@ Name | Type | Description | Notes
|
||||
**reauthorization_enabled** | **bool** | If this is true, reauthorization will be enforced for appropriately configured access items. Enablement of this feature is currently in a limited state. | [optional] [default to False]
|
||||
**request_on_behalf_of_config** | [**RequestOnBehalfOfConfig**](request-on-behalf-of-config) | | [optional]
|
||||
**approval_reminder_and_escalation_config** | [**ApprovalReminderAndEscalationConfig**](approval-reminder-and-escalation-config) | | [optional]
|
||||
**entitlement_request_config** | [**EntitlementRequestConfig1**](entitlement-request-config1) | | [optional]
|
||||
**entitlement_request_config** | [**EntitlementRequestConfig**](entitlement-request-config) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
@@ -45,7 +45,7 @@ approval_reminder_and_escalation_config=sailpoint.v2024.models.approval_reminder
|
||||
id = '5168015d32f890ca15812c9180835d2e',
|
||||
name = 'Alison Ferguso',
|
||||
email = 'alison.ferguso@identitysoon.com', ), ),
|
||||
entitlement_request_config=sailpoint.v2024.models.entitlement_request_config_1.EntitlementRequestConfig_1(
|
||||
entitlement_request_config=sailpoint.v2024.models.entitlement_request_config.EntitlementRequestConfig(
|
||||
allow_entitlement_request = True,
|
||||
request_comments_required = False,
|
||||
denied_comments_required = False,
|
||||
|
||||
@@ -0,0 +1,43 @@
|
||||
---
|
||||
id: v2024-access-request-recommendation-config-dto
|
||||
title: AccessRequestRecommendationConfigDto
|
||||
pagination_label: AccessRequestRecommendationConfigDto
|
||||
sidebar_label: AccessRequestRecommendationConfigDto
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccessRequestRecommendationConfigDto', 'V2024AccessRequestRecommendationConfigDto']
|
||||
slug: /tools/sdk/python/v2024/models/access-request-recommendation-config-dto
|
||||
tags: ['SDK', 'Software Development Kit', 'AccessRequestRecommendationConfigDto', 'V2024AccessRequestRecommendationConfigDto']
|
||||
---
|
||||
|
||||
# AccessRequestRecommendationConfigDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**score_threshold** | **float** | The value that internal calculations need to exceed for recommendations to be made. | [required]
|
||||
**start_date_attribute** | **str** | Use to map an attribute name for determining identities' start date. | [optional]
|
||||
**restriction_attribute** | **str** | Use to only give recommendations based on this attribute. | [optional]
|
||||
**mover_attribute** | **str** | Use to map an attribute name for determining whether identities are movers. | [optional]
|
||||
**joiner_attribute** | **str** | Use to map an attribute name for determining whether identities are joiners. | [optional]
|
||||
**use_restriction_attribute** | **bool** | Use only the attribute named in restrictionAttribute to make recommendations. | [optional] [default to False]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.access_request_recommendation_config_dto import AccessRequestRecommendationConfigDto
|
||||
|
||||
access_request_recommendation_config_dto = AccessRequestRecommendationConfigDto(
|
||||
score_threshold=0.5,
|
||||
start_date_attribute='startDate',
|
||||
restriction_attribute='location',
|
||||
mover_attribute='isMover',
|
||||
joiner_attribute='isJoiner',
|
||||
use_restriction_attribute=True
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -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.v2024.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.v2024.models.base_reference_dto.BaseReferenceDto(
|
||||
identity=sailpoint.v2024.models.account_all_of_identity.Account_allOf_identity(
|
||||
id = '2c918084660f45d6016617daa9210584',
|
||||
type = 'IDENTITY',
|
||||
id = '2c91808568c529c60168cca6f90c1313',
|
||||
name = 'William Wilson', ),
|
||||
source_owner=sailpoint.v2024.models.base_reference_dto.BaseReferenceDto(
|
||||
name = 'John Doe', ),
|
||||
source_owner=sailpoint.v2024.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.v2024.models.base_reference_dto.BaseReferenceDto(
|
||||
type = 'IDENTITY',
|
||||
id = '2c91808568c529c60168cca6f90c1313',
|
||||
name = 'William Wilson', )
|
||||
owner_identity=
|
||||
)
|
||||
|
||||
```
|
||||
|
||||
@@ -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.v2024.models.account_activity_document import AccountActivityDocu
|
||||
|
||||
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.v2024.models.attribute_request.AttributeRequest(
|
||||
name = 'groups',
|
||||
op = 'Add',
|
||||
value = null, ),
|
||||
source = null, )
|
||||
],
|
||||
original_requests=[
|
||||
sailpoint.v2024.models.original_request.OriginalRequest(
|
||||
account_id = 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com',
|
||||
result = sailpoint.v2024.models.result.Result(
|
||||
status = 'Manual Task Created', ),
|
||||
attribute_requests = [
|
||||
sailpoint.v2024.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.v2024.models.attribute_request.AttributeRequest(
|
||||
name = 'groups',
|
||||
op = 'Add',
|
||||
value = '3203537556531076', )
|
||||
],
|
||||
source = null, )
|
||||
attribute_request = sailpoint.v2024.models.attribute_request.AttributeRequest(
|
||||
name = 'groups',
|
||||
op = 'Add',
|
||||
value = null, ),
|
||||
source = null,
|
||||
id = 'ac2887ffe0e7435a8c18c73f7ae94c7b',
|
||||
state = 'EXECUTING', )
|
||||
],
|
||||
account_requests=[
|
||||
sailpoint.v2024.models.account_request.AccountRequest(
|
||||
@@ -108,7 +109,7 @@ account_requests=[
|
||||
sailpoint.v2024.models.attribute_request.AttributeRequest(
|
||||
name = 'groups',
|
||||
op = 'Add',
|
||||
value = '3203537556531076', )
|
||||
value = null, )
|
||||
],
|
||||
op = 'Modify',
|
||||
provisioning_target = null,
|
||||
|
||||
@@ -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.v2024.models.account_activity_searched_item import AccountActivit
|
||||
|
||||
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.v2024.models.attribute_request.AttributeRequest(
|
||||
name = 'groups',
|
||||
op = 'Add',
|
||||
value = null, ),
|
||||
source = null, )
|
||||
],
|
||||
original_requests=[
|
||||
sailpoint.v2024.models.original_request.OriginalRequest(
|
||||
account_id = 'CN=Abby Smith,OU=Austin,OU=Americas,OU=Demo,DC=seri,DC=acme,DC=com',
|
||||
result = sailpoint.v2024.models.result.Result(
|
||||
status = 'Manual Task Created', ),
|
||||
attribute_requests = [
|
||||
sailpoint.v2024.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.v2024.models.attribute_request.AttributeRequest(
|
||||
name = 'groups',
|
||||
op = 'Add',
|
||||
value = '3203537556531076', )
|
||||
],
|
||||
source = null, )
|
||||
attribute_request = sailpoint.v2024.models.attribute_request.AttributeRequest(
|
||||
name = 'groups',
|
||||
op = 'Add',
|
||||
value = null, ),
|
||||
source = null,
|
||||
id = 'ac2887ffe0e7435a8c18c73f7ae94c7b',
|
||||
state = 'EXECUTING', )
|
||||
],
|
||||
account_requests=[
|
||||
sailpoint.v2024.models.account_request.AccountRequest(
|
||||
@@ -108,7 +109,7 @@ account_requests=[
|
||||
sailpoint.v2024.models.attribute_request.AttributeRequest(
|
||||
name = 'groups',
|
||||
op = 'Add',
|
||||
value = '3203537556531076', )
|
||||
value = null, )
|
||||
],
|
||||
op = 'Modify',
|
||||
provisioning_target = null,
|
||||
|
||||
@@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'AccountAggregationStatus', 'V2024Acco
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**start** | **datetime** | When the aggregation started. | [optional]
|
||||
**status** | **Enum** [ 'STARTED', 'ACCOUNTS_COLLECTED', 'COMPLETED', 'CANCELLED', 'RETRIED', 'TERMINATED' ] | STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. | [optional]
|
||||
**status** | **Enum** [ 'STARTED', 'ACCOUNTS_COLLECTED', 'COMPLETED', 'CANCELLED', 'RETRIED', 'TERMINATED', 'NOT_FOUND' ] | STARTED - Aggregation started, but source account iteration has not completed. ACCOUNTS_COLLECTED - Source account iteration completed, but all accounts have not yet been processed. COMPLETED - Aggregation completed (*possibly with errors*). CANCELLED - Aggregation cancelled by user. RETRIED - Aggregation retried because of connectivity issues with the Virtual Appliance. TERMINATED - Aggregation marked as failed after 3 tries after connectivity issues with the Virtual Appliance. | [optional]
|
||||
**total_accounts** | **int** | The total number of *NEW, CHANGED and DELETED* accounts that need to be processed for this aggregation. This does not include accounts that were unchanged since the previous aggregation. This can be zero if there were no new, changed or deleted accounts since the previous aggregation. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
|
||||
**processed_accounts** | **int** | The number of *NEW, CHANGED and DELETED* accounts that have been processed so far. This reflects the number of accounts that have been processed at the time of the API call, and may increase on subsequent API calls while the status is ACCOUNTS_COLLECTED. *Only available when status is ACCOUNTS_COLLECTED or COMPLETED.* | [optional]
|
||||
}
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
id: v2024-account-all-of-identity
|
||||
title: AccountAllOfIdentity
|
||||
pagination_label: AccountAllOfIdentity
|
||||
sidebar_label: AccountAllOfIdentity
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccountAllOfIdentity', 'V2024AccountAllOfIdentity']
|
||||
slug: /tools/sdk/python/v2024/models/account-all-of-identity
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountAllOfIdentity', 'V2024AccountAllOfIdentity']
|
||||
---
|
||||
|
||||
# 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.v2024.models.account_all_of_identity import AccountAllOfIdentity
|
||||
|
||||
account_all_of_identity = AccountAllOfIdentity(
|
||||
id='2c918084660f45d6016617daa9210584',
|
||||
type='IDENTITY',
|
||||
name='John Doe'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2024-account-all-of-owner-identity
|
||||
title: AccountAllOfOwnerIdentity
|
||||
pagination_label: AccountAllOfOwnerIdentity
|
||||
sidebar_label: AccountAllOfOwnerIdentity
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccountAllOfOwnerIdentity', 'V2024AccountAllOfOwnerIdentity']
|
||||
slug: /tools/sdk/python/v2024/models/account-all-of-owner-identity
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountAllOfOwnerIdentity', 'V2024AccountAllOfOwnerIdentity']
|
||||
---
|
||||
|
||||
# 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.v2024.models.account_all_of_owner_identity import AccountAllOfOwnerIdentity
|
||||
|
||||
account_all_of_owner_identity = AccountAllOfOwnerIdentity(
|
||||
type='IDENTITY',
|
||||
id='2c91808568c529c60168cca6f90c1313',
|
||||
name='William Wilson'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,35 @@
|
||||
---
|
||||
id: v2024-account-all-of-recommendation
|
||||
title: AccountAllOfRecommendation
|
||||
pagination_label: AccountAllOfRecommendation
|
||||
sidebar_label: AccountAllOfRecommendation
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccountAllOfRecommendation', 'V2024AccountAllOfRecommendation']
|
||||
slug: /tools/sdk/python/v2024/models/account-all-of-recommendation
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountAllOfRecommendation', 'V2024AccountAllOfRecommendation']
|
||||
---
|
||||
|
||||
# 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.v2024.models.account_all_of_recommendation import AccountAllOfRecommendation
|
||||
|
||||
account_all_of_recommendation = AccountAllOfRecommendation(
|
||||
type='MACHINE',
|
||||
method='DISCOVERY'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
id: v2024-account-all-of-source-owner
|
||||
title: AccountAllOfSourceOwner
|
||||
pagination_label: AccountAllOfSourceOwner
|
||||
sidebar_label: AccountAllOfSourceOwner
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AccountAllOfSourceOwner', 'V2024AccountAllOfSourceOwner']
|
||||
slug: /tools/sdk/python/v2024/models/account-all-of-source-owner
|
||||
tags: ['SDK', 'Software Development Kit', 'AccountAllOfSourceOwner', 'V2024AccountAllOfSourceOwner']
|
||||
---
|
||||
|
||||
# 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.v2024.models.account_all_of_source_owner import AccountAllOfSourceOwner
|
||||
|
||||
account_all_of_source_owner = AccountAllOfSourceOwner(
|
||||
id='2c918084660f45d6016617daa9210584',
|
||||
type='IDENTITY',
|
||||
name='Adam Kennedy'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -35,7 +35,7 @@ attribute_requests=[
|
||||
sailpoint.v2024.models.attribute_request.AttributeRequest(
|
||||
name = 'groups',
|
||||
op = 'Add',
|
||||
value = '3203537556531076', )
|
||||
value = null, )
|
||||
],
|
||||
op='Modify',
|
||||
provisioning_target=,
|
||||
|
||||
@@ -16,9 +16,9 @@ tags: ['SDK', 'Software Development Kit', 'AccountRequestResult', 'V2024AccountR
|
||||
|
||||
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
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
id: v2024-activity-identity
|
||||
title: ActivityIdentity
|
||||
pagination_label: ActivityIdentity
|
||||
sidebar_label: ActivityIdentity
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ActivityIdentity', 'V2024ActivityIdentity']
|
||||
slug: /tools/sdk/python/v2024/models/activity-identity
|
||||
tags: ['SDK', 'Software Development Kit', 'ActivityIdentity', 'V2024ActivityIdentity']
|
||||
---
|
||||
|
||||
# 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.v2024.models.activity_identity import ActivityIdentity
|
||||
|
||||
activity_identity = ActivityIdentity(
|
||||
id='2c91808568c529c60168cca6f90c1313',
|
||||
name='John Doe',
|
||||
type='Identity'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -28,7 +28,7 @@ from sailpoint.v2024.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.v2024.models.search_document.SearchDocument()
|
||||
sailpoint.v2024.models.search_documents.SearchDocuments()
|
||||
]
|
||||
)
|
||||
|
||||
|
||||
@@ -17,11 +17,11 @@ tags: ['SDK', 'Software Development Kit', 'Approval1', 'V2024Approval1']
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**comments** | [**[]ApprovalComment2**](approval-comment2) | | [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.v2024.models.attribute_request.AttributeRequest(
|
||||
name = 'groups',
|
||||
op = 'Add',
|
||||
value = null, ),
|
||||
source=
|
||||
)
|
||||
|
||||
```
|
||||
|
||||
@@ -1,43 +0,0 @@
|
||||
---
|
||||
id: v2024-approval-forward-history1
|
||||
title: ApprovalForwardHistory1
|
||||
pagination_label: ApprovalForwardHistory1
|
||||
sidebar_label: ApprovalForwardHistory1
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ApprovalForwardHistory1', 'V2024ApprovalForwardHistory1']
|
||||
slug: /tools/sdk/python/v2024/models/approval-forward-history1
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalForwardHistory1', 'V2024ApprovalForwardHistory1']
|
||||
---
|
||||
|
||||
# ApprovalForwardHistory1
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**old_approver_name** | **str** | Display name of approver from whom the approval was forwarded. | [optional]
|
||||
**new_approver_name** | **str** | Display name of approver to whom the approval was forwarded. | [optional]
|
||||
**comment** | **str** | Comment made while forwarding. | [optional]
|
||||
**modified** | **datetime** | Time at which approval was forwarded. | [optional]
|
||||
**forwarder_name** | **str** | Display name of forwarder who forwarded the approval. | [optional]
|
||||
**reassignment_type** | [**ReassignmentType**](reassignment-type) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.approval_forward_history1 import ApprovalForwardHistory1
|
||||
|
||||
approval_forward_history1 = ApprovalForwardHistory1(
|
||||
old_approver_name='Frank Mir',
|
||||
new_approver_name='Al Volta',
|
||||
comment='Forwarding from Frank to Al',
|
||||
modified='2019-08-23T18:52:57.398Z',
|
||||
forwarder_name='William Wilson',
|
||||
reassignment_type='AUTOMATIC_REASSIGNMENT'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -16,7 +16,6 @@ tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDto', 'V2024ApprovalSta
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**approval_id** | **str** | Unique identifier for the approval. | [optional]
|
||||
**forwarded** | **bool** | True if the request for this item was forwarded from one owner to another. | [optional] [default to False]
|
||||
**original_owner** | [**ApprovalStatusDtoOriginalOwner**](approval-status-dto-original-owner) | | [optional]
|
||||
**current_owner** | [**ApprovalStatusDtoCurrentOwner**](approval-status-dto-current-owner) | | [optional]
|
||||
@@ -34,7 +33,6 @@ Name | Type | Description | Notes
|
||||
from sailpoint.v2024.models.approval_status_dto import ApprovalStatusDto
|
||||
|
||||
approval_status_dto = ApprovalStatusDto(
|
||||
approval_id='2c9180877b2b6ea4017b2c545f971429',
|
||||
forwarded=False,
|
||||
original_owner=sailpoint.v2024.models.approval_status_dto_original_owner.ApprovalStatusDto_originalOwner(
|
||||
type = 'IDENTITY',
|
||||
|
||||
@@ -1,57 +0,0 @@
|
||||
---
|
||||
id: v2024-approval-status-dto1
|
||||
title: ApprovalStatusDto1
|
||||
pagination_label: ApprovalStatusDto1
|
||||
sidebar_label: ApprovalStatusDto1
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'ApprovalStatusDto1', 'V2024ApprovalStatusDto1']
|
||||
slug: /tools/sdk/python/v2024/models/approval-status-dto1
|
||||
tags: ['SDK', 'Software Development Kit', 'ApprovalStatusDto1', 'V2024ApprovalStatusDto1']
|
||||
---
|
||||
|
||||
# ApprovalStatusDto1
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**forwarded** | **bool** | True if the request for this item was forwarded from one owner to another. | [optional] [default to False]
|
||||
**original_owner** | [**ApprovalStatusDtoOriginalOwner**](approval-status-dto-original-owner) | | [optional]
|
||||
**current_owner** | [**ApprovalStatusDtoCurrentOwner**](approval-status-dto-current-owner) | | [optional]
|
||||
**modified** | **datetime** | Time at which item was modified. | [optional]
|
||||
**status** | [**ManualWorkItemState**](manual-work-item-state) | | [optional]
|
||||
**scheme** | [**ApprovalScheme**](approval-scheme) | | [optional]
|
||||
**error_messages** | [**[]ErrorMessageDto1**](error-message-dto1) | If the request failed, includes any error messages that were generated. | [optional]
|
||||
**comment** | **str** | Comment, if any, provided by the approver. | [optional]
|
||||
**remove_date** | **datetime** | The date the role or access profile or entitlement is no longer assigned to the specified identity. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.approval_status_dto1 import ApprovalStatusDto1
|
||||
|
||||
approval_status_dto1 = ApprovalStatusDto1(
|
||||
forwarded=False,
|
||||
original_owner=sailpoint.v2024.models.approval_status_dto_original_owner.ApprovalStatusDto_originalOwner(
|
||||
type = 'IDENTITY',
|
||||
id = '2c7180a46faadee4016fb4e018c20642',
|
||||
name = 'Michael Michaels', ),
|
||||
current_owner=,
|
||||
modified='2019-08-23T18:52:57.398Z',
|
||||
status='PENDING',
|
||||
scheme='MANAGER',
|
||||
error_messages=[
|
||||
sailpoint.v2024.models.error_message_dto_1.ErrorMessageDto_1(
|
||||
locale = 'en-US',
|
||||
locale_origin = 'DEFAULT',
|
||||
text = 'The request was syntactically correct but its content is semantically invalid.', )
|
||||
],
|
||||
comment='I approve this request',
|
||||
remove_date='2020-07-11T00:00Z'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -36,9 +36,10 @@ requested=sailpoint.v2024.models.access_request_context.AccessRequestContext(
|
||||
], ),
|
||||
matched=[
|
||||
sailpoint.v2024.models.role_match_dto.RoleMatchDto(
|
||||
role_ref = sailpoint.v2024.models.base_reference_dto_1.BaseReferenceDto_1(
|
||||
id = 'ff8081814d977c21014da056804a0af3',
|
||||
name = 'Github', ),
|
||||
role_ref = sailpoint.v2024.models.base_reference_dto.BaseReferenceDto(
|
||||
type = 'IDENTITY',
|
||||
id = '2c91808568c529c60168cca6f90c1313',
|
||||
name = 'William Wilson', ),
|
||||
matched_attributes = [
|
||||
sailpoint.v2024.models.context_attribute_dto.ContextAttributeDto(
|
||||
attribute = 'location',
|
||||
|
||||
@@ -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.v2024.models.attribute_request import AttributeRequest
|
||||
attribute_request = AttributeRequest(
|
||||
name='groups',
|
||||
op='Add',
|
||||
value='3203537556531076'
|
||||
value=
|
||||
)
|
||||
|
||||
```
|
||||
|
||||
@@ -0,0 +1,32 @@
|
||||
---
|
||||
id: v2024-attribute-request-value
|
||||
title: AttributeRequestValue
|
||||
pagination_label: AttributeRequestValue
|
||||
sidebar_label: AttributeRequestValue
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'AttributeRequestValue', 'V2024AttributeRequestValue']
|
||||
slug: /tools/sdk/python/v2024/models/attribute-request-value
|
||||
tags: ['SDK', 'Software Development Kit', 'AttributeRequestValue', 'V2024AttributeRequestValue']
|
||||
---
|
||||
|
||||
# AttributeRequestValue
|
||||
|
||||
Value of attribute.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.attribute_request_value import AttributeRequestValue
|
||||
|
||||
attribute_request_value = AttributeRequestValue(
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -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'
|
||||
]
|
||||
|
||||
@@ -16,8 +16,6 @@ tags: ['SDK', 'Software Development Kit', 'BaseAccess', 'V2024BaseAccess']
|
||||
|
||||
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.v2024.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.v2024.models.base_access_all_of_owner.BaseAccess_allOf_owner(
|
||||
owner=sailpoint.v2024.models.base_access_owner.BaseAccess_owner(
|
||||
type = 'IDENTITY',
|
||||
id = '2c9180a46faadee4016fb4e018c20639',
|
||||
name = 'Support',
|
||||
|
||||
@@ -1,15 +1,15 @@
|
||||
---
|
||||
id: base-access-all-of-owner
|
||||
title: BaseAccessAllOfOwner
|
||||
pagination_label: BaseAccessAllOfOwner
|
||||
sidebar_label: BaseAccessAllOfOwner
|
||||
id: v2024-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', 'V2024BaseAccessOwner']
|
||||
slug: /tools/sdk/python/v2024/models/base-access-owner
|
||||
tags: ['SDK', 'Software Development Kit', 'BaseAccessOwner', 'V2024BaseAccessOwner']
|
||||
---
|
||||
|
||||
# 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.v2024.models.base_access_owner import BaseAccessOwner
|
||||
|
||||
base_access_all_of_owner = BaseAccessAllOfOwner(
|
||||
base_access_owner = BaseAccessOwner(
|
||||
type='IDENTITY',
|
||||
id='2c9180a46faadee4016fb4e018c20639',
|
||||
name='Support',
|
||||
@@ -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}
|
||||
)
|
||||
|
||||
```
|
||||
|
||||
@@ -1,39 +0,0 @@
|
||||
---
|
||||
id: v2024-base-common-dto1
|
||||
title: BaseCommonDto1
|
||||
pagination_label: BaseCommonDto1
|
||||
sidebar_label: BaseCommonDto1
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'BaseCommonDto1', 'V2024BaseCommonDto1']
|
||||
slug: /tools/sdk/python/v2024/models/base-common-dto1
|
||||
tags: ['SDK', 'Software Development Kit', 'BaseCommonDto1', 'V2024BaseCommonDto1']
|
||||
---
|
||||
|
||||
# BaseCommonDto1
|
||||
|
||||
|
||||
## 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]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.base_common_dto1 import BaseCommonDto1
|
||||
|
||||
base_common_dto1 = BaseCommonDto1(
|
||||
id='id12345',
|
||||
name='aName',
|
||||
created='2023-01-03T21:16:22.432Z',
|
||||
modified='2023-01-03T21:16:22.432Z'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -16,9 +16,8 @@ tags: ['SDK', 'Software Development Kit', 'BaseDocument', 'V2024BaseDocument']
|
||||
|
||||
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.v2024.models.base_document import BaseDocument
|
||||
|
||||
base_document = BaseDocument(
|
||||
id='2c91808375d8e80a0175e1f88a575222',
|
||||
name='john.doe',
|
||||
type='identity'
|
||||
name='john.doe'
|
||||
)
|
||||
|
||||
```
|
||||
|
||||
@@ -1,35 +0,0 @@
|
||||
---
|
||||
id: v2024-base-reference-dto1
|
||||
title: BaseReferenceDto1
|
||||
pagination_label: BaseReferenceDto1
|
||||
sidebar_label: BaseReferenceDto1
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'BaseReferenceDto1', 'V2024BaseReferenceDto1']
|
||||
slug: /tools/sdk/python/v2024/models/base-reference-dto1
|
||||
tags: ['SDK', 'Software Development Kit', 'BaseReferenceDto1', 'V2024BaseReferenceDto1']
|
||||
---
|
||||
|
||||
# BaseReferenceDto1
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **str** | the application ID | [optional]
|
||||
**name** | **str** | the application name | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.base_reference_dto1 import BaseReferenceDto1
|
||||
|
||||
base_reference_dto1 = BaseReferenceDto1(
|
||||
id='ff8081814d977c21014da056804a0af3',
|
||||
name='Github'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -94,7 +94,8 @@ search_campaign_info=sailpoint.v2024.models.campaign_all_of_search_campaign_info
|
||||
operator = 'SELECTED', )
|
||||
], ),
|
||||
role_composition_campaign_info=sailpoint.v2024.models.campaign_all_of_role_composition_campaign_info.Campaign_allOf_roleCompositionCampaignInfo(
|
||||
reviewer = sailpoint.v2024.models.campaign_all_of_search_campaign_info_reviewer.Campaign_allOf_searchCampaignInfo_reviewer(
|
||||
reviewer_id = '2c91808568c529c60168cca6f90c1313',
|
||||
reviewer = sailpoint.v2024.models.campaign_all_of_role_composition_campaign_info_reviewer.Campaign_allOf_roleCompositionCampaignInfo_reviewer(
|
||||
type = 'IDENTITY',
|
||||
id = '2c91808568c529c60168cca6f90c1313',
|
||||
name = 'William Wilson', ),
|
||||
|
||||
@@ -17,7 +17,8 @@ Optional configuration options for role composition campaigns.
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**reviewer** | [**CampaignAllOfSearchCampaignInfoReviewer**](campaign-all-of-search-campaign-info-reviewer) | | [optional]
|
||||
**reviewer_id** | **str** | The ID of the identity or governance group reviewing this campaign. Deprecated in favor of the \"reviewer\" object. | [optional]
|
||||
**reviewer** | [**CampaignAllOfRoleCompositionCampaignInfoReviewer**](campaign-all-of-role-composition-campaign-info-reviewer) | | [optional]
|
||||
**role_ids** | **[]str** | Optional list of roles to include in this campaign. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. | [optional]
|
||||
**remediator_ref** | [**CampaignAllOfRoleCompositionCampaignInfoRemediatorRef**](campaign-all-of-role-composition-campaign-info-remediator-ref) | | [required]
|
||||
**query** | **str** | Optional search query to scope this campaign to a set of roles. Only one of `roleIds` and `query` may be set; if neither are set, all roles are included. | [optional]
|
||||
@@ -30,7 +31,8 @@ Name | Type | Description | Notes
|
||||
from sailpoint.v2024.models.campaign_all_of_role_composition_campaign_info import CampaignAllOfRoleCompositionCampaignInfo
|
||||
|
||||
campaign_all_of_role_composition_campaign_info = CampaignAllOfRoleCompositionCampaignInfo(
|
||||
reviewer=sailpoint.v2024.models.campaign_all_of_search_campaign_info_reviewer.Campaign_allOf_searchCampaignInfo_reviewer(
|
||||
reviewer_id='2c91808568c529c60168cca6f90c1313',
|
||||
reviewer=sailpoint.v2024.models.campaign_all_of_role_composition_campaign_info_reviewer.Campaign_allOf_roleCompositionCampaignInfo_reviewer(
|
||||
type = 'IDENTITY',
|
||||
id = '2c91808568c529c60168cca6f90c1313',
|
||||
name = 'William Wilson', ),
|
||||
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
id: v2024-campaign-all-of-role-composition-campaign-info-reviewer
|
||||
title: CampaignAllOfRoleCompositionCampaignInfoReviewer
|
||||
pagination_label: CampaignAllOfRoleCompositionCampaignInfoReviewer
|
||||
sidebar_label: CampaignAllOfRoleCompositionCampaignInfoReviewer
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'CampaignAllOfRoleCompositionCampaignInfoReviewer', 'V2024CampaignAllOfRoleCompositionCampaignInfoReviewer']
|
||||
slug: /tools/sdk/python/v2024/models/campaign-all-of-role-composition-campaign-info-reviewer
|
||||
tags: ['SDK', 'Software Development Kit', 'CampaignAllOfRoleCompositionCampaignInfoReviewer', 'V2024CampaignAllOfRoleCompositionCampaignInfoReviewer']
|
||||
---
|
||||
|
||||
# CampaignAllOfRoleCompositionCampaignInfoReviewer
|
||||
|
||||
If specified, this identity or governance group will be the reviewer for all certifications in this campaign. The allowed DTO types are IDENTITY and GOVERNANCE_GROUP.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **Enum** [ 'GOVERNANCE_GROUP', 'IDENTITY' ] | The reviewer's DTO type. | [optional]
|
||||
**id** | **str** | The reviewer's ID. | [optional]
|
||||
**name** | **str** | The reviewer's name. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.campaign_all_of_role_composition_campaign_info_reviewer import CampaignAllOfRoleCompositionCampaignInfoReviewer
|
||||
|
||||
campaign_all_of_role_composition_campaign_info_reviewer = CampaignAllOfRoleCompositionCampaignInfoReviewer(
|
||||
type='IDENTITY',
|
||||
id='2c91808568c529c60168cca6f90c1313',
|
||||
name='William Wilson'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,41 +0,0 @@
|
||||
---
|
||||
id: v2024-cancelled-request-details1
|
||||
title: CancelledRequestDetails1
|
||||
pagination_label: CancelledRequestDetails1
|
||||
sidebar_label: CancelledRequestDetails1
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'CancelledRequestDetails1', 'V2024CancelledRequestDetails1']
|
||||
slug: /tools/sdk/python/v2024/models/cancelled-request-details1
|
||||
tags: ['SDK', 'Software Development Kit', 'CancelledRequestDetails1', 'V2024CancelledRequestDetails1']
|
||||
---
|
||||
|
||||
# CancelledRequestDetails1
|
||||
|
||||
Provides additional details for a request that has been cancelled.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**comment** | **str** | Comment made by the owner when cancelling the associated request. | [optional]
|
||||
**owner** | [**OwnerDto**](owner-dto) | | [optional]
|
||||
**modified** | **datetime** | Date comment was added by the owner when cancelling the associated request. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.cancelled_request_details1 import CancelledRequestDetails1
|
||||
|
||||
cancelled_request_details1 = CancelledRequestDetails1(
|
||||
comment='This request must be cancelled.',
|
||||
owner=sailpoint.v2024.models.owner_dto.OwnerDto(
|
||||
type = 'IDENTITY',
|
||||
id = '2c9180a46faadee4016fb4e018c20639',
|
||||
name = 'Support', ),
|
||||
modified='2019-12-20T09:17:12.192Z'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -20,8 +20,8 @@ Name | Type | Description | Notes
|
||||
**phase** | [**CertificationPhase**](certification-phase) | | [required]
|
||||
**due** | **datetime** | The due date of the certification. | [required]
|
||||
**signed** | **datetime** | The date the reviewer signed off on the certification. | [required]
|
||||
**reviewer** | [**Reviewer1**](reviewer1) | | [required]
|
||||
**reassignment** | [**Reassignment1**](reassignment1) | | [optional]
|
||||
**reviewer** | [**Reviewer**](reviewer) | | [required]
|
||||
**reassignment** | [**Reassignment**](reassignment) | | [optional]
|
||||
**has_errors** | **bool** | Indicates it the certification has any errors. | [required]
|
||||
**error_message** | **str** | A message indicating what the error is. | [optional]
|
||||
**completed** | **bool** | Indicates if all certification decisions have been made. | [required]
|
||||
@@ -48,14 +48,26 @@ campaign_ref=sailpoint.v2024.models.campaign_reference.CampaignReference(
|
||||
phase='ACTIVE',
|
||||
due='2018-10-19T13:49:37.385Z',
|
||||
signed='2018-10-19T13:49:37.385Z',
|
||||
reviewer=sailpoint.v2024.models.reviewer_1.Reviewer_1(
|
||||
reviewer=sailpoint.v2024.models.reviewer.Reviewer(
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8',
|
||||
name = 'Reviewer Name',
|
||||
email = 'reviewer@test.com',
|
||||
type = 'IDENTITY',
|
||||
id = '2c7180a46faadee4016fb4e018c20642',
|
||||
name = 'Michael Michaels',
|
||||
email = 'reviewer@test.com', ),
|
||||
reassignment=sailpoint.v2024.models.reassignment_1.Reassignment_1(
|
||||
from = sailpoint.v2024.models.certification_reference_1.CertificationReference_1(),
|
||||
comment = 'Please review', ),
|
||||
created = '2018-06-25T20:22:28.104Z',
|
||||
modified = '2018-06-25T20:22:28.104Z', ),
|
||||
reassignment=sailpoint.v2024.models.reassignment.Reassignment(
|
||||
from = sailpoint.v2024.models.certification_reference.CertificationReference(
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8',
|
||||
name = 'Certification Name',
|
||||
type = 'CERTIFICATION',
|
||||
reviewer = sailpoint.v2024.models.reviewer.Reviewer(
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8',
|
||||
name = 'Reviewer Name',
|
||||
email = 'reviewer@test.com',
|
||||
type = 'IDENTITY',
|
||||
created = '2018-06-25T20:22:28.104Z',
|
||||
modified = '2018-06-25T20:22:28.104Z', ), ),
|
||||
comment = 'Reassigned for a reason', ),
|
||||
has_errors=False,
|
||||
error_message='The certification has an error',
|
||||
completed=False,
|
||||
|
||||
@@ -1,44 +0,0 @@
|
||||
---
|
||||
id: v2024-certification-reference1
|
||||
title: CertificationReference1
|
||||
pagination_label: CertificationReference1
|
||||
sidebar_label: CertificationReference1
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'CertificationReference1', 'V2024CertificationReference1']
|
||||
slug: /tools/sdk/python/v2024/models/certification-reference1
|
||||
tags: ['SDK', 'Software Development Kit', 'CertificationReference1', 'V2024CertificationReference1']
|
||||
---
|
||||
|
||||
# CertificationReference1
|
||||
|
||||
Previous certification.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **Enum** [ 'CERTIFICATION' ] | DTO type of certification for review. | [optional]
|
||||
**id** | **str** | ID of certification for review. | [optional]
|
||||
**name** | **str** | Display name of certification for review. | [optional]
|
||||
**reviewer** | [**Reviewer1**](reviewer1) | | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.certification_reference1 import CertificationReference1
|
||||
|
||||
certification_reference1 = CertificationReference1(
|
||||
type='IDENTITY',
|
||||
id='7589a83cec4b4f138ce56c1a5ef0756d',
|
||||
name='Manager Access for Michael Michaels',
|
||||
reviewer=sailpoint.v2024.models.reviewer_1.Reviewer_1(
|
||||
type = 'IDENTITY',
|
||||
id = '2c7180a46faadee4016fb4e018c20642',
|
||||
name = 'Michael Michaels',
|
||||
email = 'reviewer@test.com', )
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -1,38 +0,0 @@
|
||||
---
|
||||
id: v2024-certification-reference-dto
|
||||
title: CertificationReferenceDto
|
||||
pagination_label: CertificationReferenceDto
|
||||
sidebar_label: CertificationReferenceDto
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'CertificationReferenceDto', 'V2024CertificationReferenceDto']
|
||||
slug: /tools/sdk/python/v2024/models/certification-reference-dto
|
||||
tags: ['SDK', 'Software Development Kit', 'CertificationReferenceDto', 'V2024CertificationReferenceDto']
|
||||
---
|
||||
|
||||
# CertificationReferenceDto
|
||||
|
||||
Certification for review.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**type** | **Enum** [ 'CERTIFICATION' ] | DTO type of certification for review. | [optional]
|
||||
**id** | **str** | ID of certification for review. | [optional]
|
||||
**name** | **str** | Display name of certification for review. | [optional]
|
||||
}
|
||||
|
||||
## Example
|
||||
|
||||
```python
|
||||
from sailpoint.v2024.models.certification_reference_dto import CertificationReferenceDto
|
||||
|
||||
certification_reference_dto = CertificationReferenceDto(
|
||||
type='IDENTITY',
|
||||
id='7589a83cec4b4f138ce56c1a5ef0756d',
|
||||
name='Manager Access for Michael Michaels'
|
||||
)
|
||||
|
||||
```
|
||||
[[Back to top]](#)
|
||||
|
||||
@@ -25,8 +25,8 @@ Name | Type | Description | Notes
|
||||
**phase** | [**CertificationPhase**](certification-phase) | | [required]
|
||||
**due** | **datetime** | The due date of the certification. | [required]
|
||||
**signed** | **datetime** | The date the reviewer signed off on the certification. | [required]
|
||||
**reviewer** | [**Reviewer1**](reviewer1) | | [required]
|
||||
**reassignment** | [**Reassignment1**](reassignment1) | | [optional]
|
||||
**reviewer** | [**Reviewer**](reviewer) | | [required]
|
||||
**reassignment** | [**Reassignment**](reassignment) | | [optional]
|
||||
**has_errors** | **bool** | Indicates it the certification has any errors. | [required]
|
||||
**error_message** | **str** | A message indicating what the error is. | [optional]
|
||||
**completed** | **bool** | Indicates if all certification decisions have been made. | [required]
|
||||
@@ -57,14 +57,26 @@ campaign_ref=sailpoint.v2024.models.campaign_reference.CampaignReference(
|
||||
phase='ACTIVE',
|
||||
due='2018-10-19T13:49:37.385Z',
|
||||
signed='2018-10-19T13:49:37.385Z',
|
||||
reviewer=sailpoint.v2024.models.reviewer_1.Reviewer_1(
|
||||
reviewer=sailpoint.v2024.models.reviewer.Reviewer(
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8',
|
||||
name = 'Reviewer Name',
|
||||
email = 'reviewer@test.com',
|
||||
type = 'IDENTITY',
|
||||
id = '2c7180a46faadee4016fb4e018c20642',
|
||||
name = 'Michael Michaels',
|
||||
email = 'reviewer@test.com', ),
|
||||
reassignment=sailpoint.v2024.models.reassignment_1.Reassignment_1(
|
||||
from = sailpoint.v2024.models.certification_reference_1.CertificationReference_1(),
|
||||
comment = 'Please review', ),
|
||||
created = '2018-06-25T20:22:28.104Z',
|
||||
modified = '2018-06-25T20:22:28.104Z', ),
|
||||
reassignment=sailpoint.v2024.models.reassignment.Reassignment(
|
||||
from = sailpoint.v2024.models.certification_reference.CertificationReference(
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8',
|
||||
name = 'Certification Name',
|
||||
type = 'CERTIFICATION',
|
||||
reviewer = sailpoint.v2024.models.reviewer.Reviewer(
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8',
|
||||
name = 'Reviewer Name',
|
||||
email = 'reviewer@test.com',
|
||||
type = 'IDENTITY',
|
||||
created = '2018-06-25T20:22:28.104Z',
|
||||
modified = '2018-06-25T20:22:28.104Z', ), ),
|
||||
comment = 'Reassigned for a reason', ),
|
||||
has_errors=False,
|
||||
error_message='The certification has an error',
|
||||
completed=False,
|
||||
|
||||
@@ -21,7 +21,7 @@ Name | Type | Description | Notes
|
||||
**target_type** | **Enum** [ 'CERTIFICATION', 'CAMPAIGN' ] | The type of item that is being operated on by this task whose ID is stored in the targetId field. | [optional]
|
||||
**target_id** | **str** | The ID of the item being operated on by this task. | [optional]
|
||||
**status** | **Enum** [ 'QUEUED', 'IN_PROGRESS', 'SUCCESS', 'ERROR' ] | The status of the task. | [optional]
|
||||
**errors** | [**[]ErrorMessageDto**](error-message-dto) | | [optional]
|
||||
**errors** | [**[]ErrorMessageDto**](error-message-dto) | List of error messages | [optional]
|
||||
**reassignment_trail_dtos** | [**[]ReassignmentTrailDTO**](reassignment-trail-dto) | Reassignment trails that lead to self certification identity | [optional]
|
||||
**created** | **datetime** | The date and time on which this task was created. | [optional]
|
||||
}
|
||||
@@ -37,12 +37,7 @@ type='ADMIN_REASSIGN',
|
||||
target_type='CAMPAIGN',
|
||||
target_id='2c918086719eec070171a7e3355a834c',
|
||||
status='QUEUED',
|
||||
errors=[
|
||||
sailpoint.v2024.models.error_message_dto.ErrorMessageDto(
|
||||
locale = 'en-US',
|
||||
locale_origin = 'DEFAULT',
|
||||
text = 'The request was syntactically correct but its content is semantically invalid.', )
|
||||
],
|
||||
errors={locale=en-US, localeOrigin=DEFAULT, text=Error Message},
|
||||
reassignment_trail_dtos={previousOwner=ef38f94347e94562b5bb8424a56397d8, newOwner=ef38f94347e94562b5bb8424a56397a3, reassignmentType=AUTOMATIC_REASSIGNMENT},
|
||||
created='2020-09-24T18:10:47.693Z'
|
||||
)
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user