AuthProfileApi
Use this API to implement Auth Profile functionality. With this functionality in place, users can read authentication profiles and make changes to them.
An authentication profile represents an identity profile's authentication configuration. When the identity profile is created, its authentication profile is also created. An authentication profile includes information like its authentication profile type (`BLOCK`, `MFA`, `NON_PTA`, PTA`) and settings controlling whether or not it blocks access from off network or untrusted geographies.
All URIs are relative to https://sailpoint.api.identitynow.com
| Method | HTTP request | Description |
|---|---|---|
| get-profile-config-list-v1 | GET /auth-profiles/v1 | Get list of auth profiles |
| get-profile-config-v1 | GET /auth-profiles/v1/{id} | Get auth profile |
| patch-profile-config-v1 | PATCH /auth-profiles/v1/{id} | Patch a specified auth profile |
get-profile-config-list-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Get list of auth profiles This API returns a list of auth profiles.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Array<Authprofilesummary>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { AuthProfileApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new AuthProfileApi(configuration);
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getProfileConfigListV1({ });
console.log(result);
get-profile-config-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Get auth profile This API returns auth profile information.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the Auth Profile to patch. | [default to undefined] |
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Authprofile
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { AuthProfileApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new AuthProfileApi(configuration);
const id: string = 2c91808a7813090a017814121919ecca; // ID of the Auth Profile to patch.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getProfileConfigV1({ id: id });
console.log(result);
patch-profile-config-v1
This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.
Patch a specified auth profile This API updates an existing Auth Profile. The following fields are patchable: offNetwork, untrustedGeography, applicationId, applicationName, type
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| id | string | ID of the Auth Profile to patch. | [default to undefined] |
| jsonpatchoperation | Array<Jsonpatchoperation> | ||
| xSailPointExperimental | string | Use this header to enable this experimental API. | [optional] [default to 'true'] |
Return type
Authprofile
HTTP request headers
- Content-Type: application/json-patch+json
- Accept: application/json
Example
import { AuthProfileApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new AuthProfileApi(configuration);
const id: string = 2c91808a7813090a017814121919ecca; // ID of the Auth Profile to patch.
const jsonpatchoperation: Array<Jsonpatchoperation> = ; //
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.patchProfileConfigV1({ id: id, jsonpatchoperation: jsonpatchoperation });
console.log(result);