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
| Method | HTTP request | Description |
|---|---|---|
| get-auth-user-v1 | GET /auth-users/v1/{id} | Auth user details |
| patch-auth-user-v1 | PATCH /auth-users/v1/{id} | Auth user update |
get-auth-user-v1
Auth user details Return the specified user's authentication system details.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | Identity ID | [default to undefined] |
Return type
Authuser
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { AuthUsersApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new AuthUsersApi(configuration);
const id: string = ef38f94347e94562b5bb8424a56397d8; // Identity ID
const result = await apiInstance.getAuthUserV1({ id: id });
console.log(result);
patch-auth-user-v1
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.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | Identity ID | [default to undefined] |
| jsonpatchoperation | Array<Jsonpatchoperation> | A list of auth user update operations according to the JSON Patch standard. |
Return type
Authuser
HTTP request headers
- Content-Type: application/json-patch+json
- Accept: application/json
Example
import { AuthUsersApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new AuthUsersApi(configuration);
const id: string = ef38f94347e94562b5bb8424a56397d8; // Identity ID
const jsonpatchoperation: Array<Jsonpatchoperation> = [{"op":"replace","path":"/capabilities","value":["ORG_ADMIN"]}]; // A list of auth user update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
const result = await apiInstance.patchAuthUserV1({ id: id, jsonpatchoperation: jsonpatchoperation });
console.log(result);