mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 12:27:47 +00:00
starting point for adding python sdk docs
This commit is contained in:
darrell-thobe-sp
155
docs/tools/sdk/python/Reference/V2024/Methods/AuthUsersApi.md
Normal file
155
docs/tools/sdk/python/Reference/V2024/Methods/AuthUsersApi.md
Normal file
@@ -0,0 +1,155 @@
|
||||
---
|
||||
id: v2024-auth-users
|
||||
title: Auth_Users
|
||||
pagination_label: Auth_Users
|
||||
sidebar_label: Auth_Users
|
||||
sidebar_class_name: pythonsdk
|
||||
keywords: ['python', 'Python', 'sdk', 'Auth_Users', 'V2024Auth_Users']
|
||||
slug: /tools/sdk/python/v2024/methods/auth-users
|
||||
tags: ['SDK', 'Software Development Kit', 'Auth_Users', 'V2024Auth_Users']
|
||||
---
|
||||
|
||||
# sailpoint.v2024.AuthUsersApi
|
||||
Use this API to implement user authentication system functionality.
|
||||
With this functionality in place, users can get a user's authentication system details, including their capabilities, and modify those capabilities.
|
||||
The user's capabilities refer to their access to different systems, or authorization, within the tenant, like access to certifications (CERT_ADMIN) or reports (REPORT_ADMIN).
|
||||
These capabilities also determine a user's access to the different APIs.
|
||||
This API provides users with a way to determine a user's access and make quick and easy changes to that access.
|
||||
|
||||
All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**get_auth_user**](AuthUsersApi#get-auth-user) | **GET** `/auth-users/{id}` | Auth User Details
|
||||
[**patch_auth_user**](AuthUsersApi#patch-auth-user) | **PATCH** `/auth-users/{id}` | Auth User Update
|
||||
|
||||
|
||||
## get-auth-user
|
||||
Auth User Details
|
||||
Return the specified user's authentication system details.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-auth-user)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | Identity ID
|
||||
|
||||
### Return type
|
||||
[**AuthUser**](../models/auth-user)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | The specified user's authentication system details. | AuthUser | - |
|
||||
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.models.auth_user import AuthUser
|
||||
from sailpoint.v2024.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID
|
||||
|
||||
try:
|
||||
# Auth User Details
|
||||
|
||||
api_response = api_instance.get_auth_user(id)
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.get_auth_user(id)
|
||||
print("The response of AuthUsersApi->get_auth_user:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AuthUsersApi->get_auth_user: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
## patch-auth-user
|
||||
Auth User Update
|
||||
Use a PATCH request to update an existing user in the authentication system.
|
||||
Use this endpoint to modify these fields:
|
||||
* `capabilities`
|
||||
|
||||
A '400.1.1 Illegal update attempt' detail code indicates that you attempted to PATCH a field that is not allowed.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/patch-auth-user)
|
||||
|
||||
### Parameters
|
||||
|
||||
Param Type | Name | Data Type | Required | Description
|
||||
------------- | ------------- | ------------- | ------------- | -------------
|
||||
Path | id | **str** | True | Identity ID
|
||||
Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | True | A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
||||
|
||||
### Return type
|
||||
[**AuthUser**](../models/auth-user)
|
||||
|
||||
### Responses
|
||||
Code | Description | Data Type | Response headers |
|
||||
------------- | ------------- | ------------- |------------------|
|
||||
200 | Auth user updated. | AuthUser | - |
|
||||
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.models.auth_user import AuthUser
|
||||
from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
|
||||
from sailpoint.v2024.rest import ApiException
|
||||
from pprint import pprint
|
||||
|
||||
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity ID # str | Identity ID
|
||||
[{op=replace, path=/capabilities, value=[ORG_ADMIN]}] # List[JsonPatchOperation] | A list of auth user 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 auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
||||
|
||||
|
||||
try:
|
||||
# Auth User Update
|
||||
Result = json_patch_operation.from_json(json_patch_operation)
|
||||
api_response = api_instance.patch_auth_user(id, Result)
|
||||
|
||||
# Below is a request that includes all optional parameters
|
||||
# api_response = api_instance.patch_auth_user(id, Result)
|
||||
print("The response of AuthUsersApi->patch_auth_user:\n")
|
||||
pprint(api_response)
|
||||
except Exception as e:
|
||||
print("Exception when calling AuthUsersApi->patch_auth_user: %s\n" % e)
|
||||
```
|
||||
|
||||
|
||||
|
||||
[[Back to top]](#)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user