mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 20:37:46 +00:00
Update python SDK docs: 15116515953
This commit is contained in:
developer-relations-sp
@@ -49,18 +49,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create-access-profile**](#create-access-profile) | **POST** `/access-profiles` | Create Access Profile
|
||||
[**delete-access-profile**](#delete-access-profile) | **DELETE** `/access-profiles/{id}` | Delete the specified Access Profile
|
||||
[**delete-access-profiles-in-bulk**](#delete-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-delete` | Delete Access Profile(s)
|
||||
[**get-access-profile**](#get-access-profile) | **GET** `/access-profiles/{id}` | Get an Access Profile
|
||||
[**get-access-profile-entitlements**](#get-access-profile-entitlements) | **GET** `/access-profiles/{id}/entitlements` | List Access Profile's Entitlements
|
||||
[**list-access-profiles**](#list-access-profiles) | **GET** `/access-profiles` | List Access Profiles
|
||||
[**patch-access-profile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified Access Profile
|
||||
[**update-access-profiles-in-bulk**](#update-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-update-requestable` | Update Access Profile(s) requestable field.
|
||||
[**create-access-profile**](#create-access-profile) | **POST** `/access-profiles` | Create access profile
|
||||
[**delete-access-profile**](#delete-access-profile) | **DELETE** `/access-profiles/{id}` | Delete the specified access profile
|
||||
[**delete-access-profiles-in-bulk**](#delete-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-delete` | Delete access profile(s)
|
||||
[**get-access-profile**](#get-access-profile) | **GET** `/access-profiles/{id}` | Get an access profile
|
||||
[**get-access-profile-entitlements**](#get-access-profile-entitlements) | **GET** `/access-profiles/{id}/entitlements` | List access profile's entitlements
|
||||
[**list-access-profiles**](#list-access-profiles) | **GET** `/access-profiles` | List access profiles
|
||||
[**patch-access-profile**](#patch-access-profile) | **PATCH** `/access-profiles/{id}` | Patch a specified access profile
|
||||
[**update-access-profiles-in-bulk**](#update-access-profiles-in-bulk) | **POST** `/access-profiles/bulk-update-requestable` | Update access profile(s) requestable field.
|
||||
|
||||
|
||||
## create-access-profile
|
||||
Create Access Profile
|
||||
Create access profile
|
||||
Create an access profile.
|
||||
A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile's source.
|
||||
The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters.
|
||||
@@ -190,7 +190,7 @@ with ApiClient(configuration) as api_client:
|
||||
}''' # AccessProfile |
|
||||
|
||||
try:
|
||||
# Create Access Profile
|
||||
# Create access profile
|
||||
new_access_profile = AccessProfile.from_json(access_profile)
|
||||
results = AccessProfilesApi(api_client).create_access_profile(access_profile=new_access_profile)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -206,7 +206,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-access-profile
|
||||
Delete the specified Access Profile
|
||||
Delete the specified access profile
|
||||
This API deletes an existing Access Profile.
|
||||
|
||||
The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned.
|
||||
@@ -251,7 +251,7 @@ with ApiClient(configuration) as api_client:
|
||||
id = '2c91808a7813090a017814121919ecca' # str | ID of the Access Profile to delete # str | ID of the Access Profile to delete
|
||||
|
||||
try:
|
||||
# Delete the specified Access Profile
|
||||
# Delete the specified access profile
|
||||
|
||||
AccessProfilesApi(api_client).delete_access_profile(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -265,7 +265,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-access-profiles-in-bulk
|
||||
Delete Access Profile(s)
|
||||
Delete access profile(s)
|
||||
This endpoint initiates a bulk deletion of one or more access profiles.
|
||||
When the request is successful, the endpoint returns the bulk delete's task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/beta/get-task-status), which will return the task result's status and information.
|
||||
This endpoint can only bulk delete up to a limit of 50 access profiles per request.
|
||||
@@ -315,7 +315,7 @@ with ApiClient(configuration) as api_client:
|
||||
}''' # AccessProfileBulkDeleteRequest |
|
||||
|
||||
try:
|
||||
# Delete Access Profile(s)
|
||||
# Delete access profile(s)
|
||||
new_access_profile_bulk_delete_request = AccessProfileBulkDeleteRequest.from_json(access_profile_bulk_delete_request)
|
||||
results = AccessProfilesApi(api_client).delete_access_profiles_in_bulk(access_profile_bulk_delete_request=new_access_profile_bulk_delete_request)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -331,7 +331,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-access-profile
|
||||
Get an Access Profile
|
||||
Get an access profile
|
||||
This API returns an Access Profile by its ID.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-access-profile)
|
||||
@@ -373,7 +373,7 @@ with ApiClient(configuration) as api_client:
|
||||
id = '2c9180837ca6693d017ca8d097500149' # str | ID of the Access Profile # str | ID of the Access Profile
|
||||
|
||||
try:
|
||||
# Get an Access Profile
|
||||
# Get an access profile
|
||||
|
||||
results = AccessProfilesApi(api_client).get_access_profile(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -389,7 +389,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-access-profile-entitlements
|
||||
List Access Profile's Entitlements
|
||||
List access profile's entitlements
|
||||
Use this API to get a list of an access profile's entitlements.
|
||||
A user with SOURCE_SUBADMIN authority must have access to the source associated with the specified access profile.
|
||||
|
||||
@@ -442,7 +442,7 @@ with ApiClient(configuration) as api_client:
|
||||
sorters = 'name,-modified' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified** (optional)
|
||||
|
||||
try:
|
||||
# List Access Profile's Entitlements
|
||||
# List access profile's entitlements
|
||||
|
||||
results = AccessProfilesApi(api_client).get_access_profile_entitlements(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -459,7 +459,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-access-profiles
|
||||
List Access Profiles
|
||||
List access profiles
|
||||
Get a list of access profiles.
|
||||
>**Note:** When you filter for access profiles that have the '+' symbol in their names, the response is blank.
|
||||
|
||||
@@ -516,7 +516,7 @@ with ApiClient(configuration) as api_client:
|
||||
include_unsegmented = True # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True) # bool | Indicates whether the response list should contain unsegmented access profiles. If `for-segment-ids` is absent or empty, specifying *include-unsegmented* as `false` results in an error. (optional) (default to True)
|
||||
|
||||
try:
|
||||
# List Access Profiles
|
||||
# List access profiles
|
||||
|
||||
results = AccessProfilesApi(api_client).list_access_profiles()
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -533,7 +533,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## patch-access-profile
|
||||
Patch a specified Access Profile
|
||||
Patch a specified access profile
|
||||
This API updates an existing Access Profile. The following fields are patchable:
|
||||
**name**, **description**, **enabled**, **owner**, **requestable**, **accessRequestConfig**, **revokeRequestConfig**, **segments**, **entitlements**, **provisioningCriteria**
|
||||
A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer.
|
||||
@@ -583,7 +583,7 @@ with ApiClient(configuration) as api_client:
|
||||
json_patch_operation = '''[{op=add, path=/entitlements, value=[{id=2c9180857725c14301772a93bb77242d, type=ENTITLEMENT, name=AD User Group}]}]''' # List[JsonPatchOperation] |
|
||||
|
||||
try:
|
||||
# Patch a specified Access Profile
|
||||
# Patch a specified access profile
|
||||
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
|
||||
results = AccessProfilesApi(api_client).patch_access_profile(id=id, json_patch_operation=new_json_patch_operation)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -599,7 +599,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## update-access-profiles-in-bulk
|
||||
Update Access Profile(s) requestable field.
|
||||
Update access profile(s) requestable field.
|
||||
This API initiates a bulk update of field requestable for one or more Access Profiles.
|
||||
|
||||
> If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated**
|
||||
@@ -649,7 +649,7 @@ with ApiClient(configuration) as api_client:
|
||||
access_profile_bulk_update_request_inner = '''[{id=464ae7bf-791e-49fd-b746-06a2e4a89635, requestable=false}]''' # List[AccessProfileBulkUpdateRequestInner] |
|
||||
|
||||
try:
|
||||
# Update Access Profile(s) requestable field.
|
||||
# Update access profile(s) requestable field.
|
||||
new_access_profile_bulk_update_request_inner = AccessProfileBulkUpdateRequestInner.from_json(access_profile_bulk_update_request_inner)
|
||||
results = AccessProfilesApi(api_client).update_access_profiles_in_bulk(access_profile_bulk_update_request_inner=new_access_profile_bulk_update_request_inner)
|
||||
# Below is a request that includes all optional parameters
|
||||
|
||||
Reference in New Issue
Block a user