mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-09 04:19:37 +00:00
Update python SDK docs: 15116515953
This commit is contained in:
developer-relations-sp
@@ -52,18 +52,18 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/beta*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create-role**](#create-role) | **POST** `/roles` | Create a Role
|
||||
[**delete-bulk-roles**](#delete-bulk-roles) | **POST** `/roles/bulk-delete` | Delete Role(s)
|
||||
[**delete-role**](#delete-role) | **DELETE** `/roles/{id}` | Delete a Role
|
||||
[**get-role**](#get-role) | **GET** `/roles/{id}` | Get a Role
|
||||
[**get-role-assigned-identities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | Identities assigned a Role
|
||||
[**get-role-entitlements**](#get-role-entitlements) | **GET** `/roles/{id}/entitlements` | List Role's Entitlements
|
||||
[**list-roles**](#list-roles) | **GET** `/roles` | List Roles
|
||||
[**patch-role**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified Role
|
||||
[**create-role**](#create-role) | **POST** `/roles` | Create a role
|
||||
[**delete-bulk-roles**](#delete-bulk-roles) | **POST** `/roles/bulk-delete` | Delete role(s)
|
||||
[**delete-role**](#delete-role) | **DELETE** `/roles/{id}` | Delete a role
|
||||
[**get-role**](#get-role) | **GET** `/roles/{id}` | Get a role
|
||||
[**get-role-assigned-identities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | Identities assigned a role
|
||||
[**get-role-entitlements**](#get-role-entitlements) | **GET** `/roles/{id}/entitlements` | List role's entitlements
|
||||
[**list-roles**](#list-roles) | **GET** `/roles` | List roles
|
||||
[**patch-role**](#patch-role) | **PATCH** `/roles/{id}` | Patch a specified role
|
||||
|
||||
|
||||
## create-role
|
||||
Create a 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.
|
||||
@@ -269,7 +269,7 @@ with ApiClient(configuration) as api_client:
|
||||
}''' # Role |
|
||||
|
||||
try:
|
||||
# Create a Role
|
||||
# Create a role
|
||||
new_role = Role.from_json(role)
|
||||
results = RolesApi(api_client).create_role(role=new_role)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -285,7 +285,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-bulk-roles
|
||||
Delete Role(s)
|
||||
Delete role(s)
|
||||
This endpoint initiates a bulk deletion of one or more roles.
|
||||
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 roles per request.
|
||||
@@ -333,7 +333,7 @@ with ApiClient(configuration) as api_client:
|
||||
}''' # RoleBulkDeleteRequest |
|
||||
|
||||
try:
|
||||
# Delete Role(s)
|
||||
# Delete role(s)
|
||||
new_role_bulk_delete_request = RoleBulkDeleteRequest.from_json(role_bulk_delete_request)
|
||||
results = RolesApi(api_client).delete_bulk_roles(role_bulk_delete_request=new_role_bulk_delete_request)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -349,7 +349,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-role
|
||||
Delete a Role
|
||||
Delete a role
|
||||
This API deletes a Role by its ID.
|
||||
|
||||
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.
|
||||
@@ -392,7 +392,7 @@ with ApiClient(configuration) as api_client:
|
||||
id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role
|
||||
|
||||
try:
|
||||
# Delete a Role
|
||||
# Delete a role
|
||||
|
||||
RolesApi(api_client).delete_role(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -406,7 +406,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-role
|
||||
Get a Role
|
||||
Get a role
|
||||
This API returns a Role by its ID.
|
||||
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.
|
||||
|
||||
@@ -449,7 +449,7 @@ with ApiClient(configuration) as api_client:
|
||||
id = '2c91808a7813090a017814121e121518' # str | ID of the Role # str | ID of the Role
|
||||
|
||||
try:
|
||||
# Get a Role
|
||||
# Get a role
|
||||
|
||||
results = RolesApi(api_client).get_role(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -465,7 +465,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-role-assigned-identities
|
||||
Identities assigned a Role
|
||||
Identities assigned a role
|
||||
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-assigned-identities)
|
||||
@@ -517,7 +517,7 @@ with ApiClient(configuration) as api_client:
|
||||
sorters = 'aliasName,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, aliasName, email** (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, aliasName, email** (optional)
|
||||
|
||||
try:
|
||||
# Identities assigned a Role
|
||||
# Identities assigned a role
|
||||
|
||||
results = RolesApi(api_client).get_role_assigned_identities(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -534,7 +534,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-role-entitlements
|
||||
List Role's Entitlements
|
||||
List role's entitlements
|
||||
Get a list of entitlements associated with a specified role.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/beta/get-role-entitlements)
|
||||
@@ -586,7 +586,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 Role's Entitlements
|
||||
# List role's entitlements
|
||||
|
||||
results = RolesApi(api_client).get_role_entitlements(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -603,7 +603,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-roles
|
||||
List Roles
|
||||
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.
|
||||
@@ -661,7 +661,7 @@ with ApiClient(configuration) as api_client:
|
||||
include_unsegmented = True # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True) # bool | Whether or not the response list should contain unsegmented Roles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error. (optional) (default to True)
|
||||
|
||||
try:
|
||||
# List Roles
|
||||
# List roles
|
||||
|
||||
results = RolesApi(api_client).list_roles()
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -678,7 +678,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## patch-role
|
||||
Patch a specified 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:
|
||||
@@ -743,7 +743,7 @@ with ApiClient(configuration) as api_client:
|
||||
json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/enabled, value=true}]''' # List[JsonPatchOperation] |
|
||||
|
||||
try:
|
||||
# Patch a specified Role
|
||||
# Patch a specified role
|
||||
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
|
||||
results = RolesApi(api_client).patch_role(id=id, json_patch_operation=new_json_patch_operation)
|
||||
# Below is a request that includes all optional parameters
|
||||
|
||||
Reference in New Issue
Block a user