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,17 +52,17 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v3*
|
||||
|
||||
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 Role
|
||||
[**get-role**](#get-role) | **GET** `/roles/{id}` | Get Role
|
||||
[**get-role-assigned-identities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | List Identities assigned a Role
|
||||
[**list-roles**](#list-roles) | **GET** `/roles` | List Roles
|
||||
[**patch-role**](#patch-role) | **PATCH** `/roles/{id}` | Patch 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 role
|
||||
[**get-role**](#get-role) | **GET** `/roles/{id}` | Get role
|
||||
[**get-role-assigned-identities**](#get-role-assigned-identities) | **GET** `/roles/{id}/assigned-identities` | List identities assigned a role
|
||||
[**list-roles**](#list-roles) | **GET** `/roles` | List roles
|
||||
[**patch-role**](#patch-role) | **PATCH** `/roles/{id}` | Patch role
|
||||
|
||||
|
||||
## create-role
|
||||
Create a Role
|
||||
Create a role
|
||||
This API creates a role.
|
||||
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.
|
||||
|
||||
@@ -265,7 +265,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
|
||||
@@ -281,7 +281,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.
|
||||
@@ -329,7 +329,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
|
||||
@@ -345,7 +345,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-role
|
||||
Delete Role
|
||||
Delete role
|
||||
Delete a role by 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 the ROLE_SUBADMIN is a member of.
|
||||
@@ -388,7 +388,7 @@ with ApiClient(configuration) as api_client:
|
||||
id = '2c91808a7813090a017814121e121518' # str | Role ID. # str | Role ID.
|
||||
|
||||
try:
|
||||
# Delete Role
|
||||
# Delete role
|
||||
|
||||
RolesApi(api_client).delete_role(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -402,7 +402,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-role
|
||||
Get Role
|
||||
Get role
|
||||
Get a role by 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 the ROLE_SUBADMIN is a member of.
|
||||
|
||||
@@ -445,7 +445,7 @@ with ApiClient(configuration) as api_client:
|
||||
id = '2c91808a7813090a017814121e121518' # str | Role ID. # str | Role ID.
|
||||
|
||||
try:
|
||||
# Get Role
|
||||
# Get role
|
||||
|
||||
results = RolesApi(api_client).get_role(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -461,7 +461,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-role-assigned-identities
|
||||
List Identities assigned a Role
|
||||
List identities assigned a role
|
||||
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/get-role-assigned-identities)
|
||||
@@ -513,7 +513,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:
|
||||
# List Identities assigned a Role
|
||||
# List identities assigned a role
|
||||
|
||||
results = RolesApi(api_client).get_role_assigned_identities(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -530,7 +530,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-roles
|
||||
List Roles
|
||||
List roles
|
||||
This API returns a list of Roles.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v3/list-roles)
|
||||
@@ -586,7 +586,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
|
||||
@@ -603,7 +603,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## patch-role
|
||||
Patch Role
|
||||
Patch role
|
||||
Update an existing role, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
|
||||
The following fields are patchable:
|
||||
* name
|
||||
@@ -667,7 +667,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 Role
|
||||
# Patch 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