IAIRoleMiningApi

All URIs are relative to https://sailpoint.api.identitynow.com

Method	HTTP request	Description
create-potential-role-provision-request-v1	POST `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/provision`	Create request to provision a potential role into an actual role.
create-role-mining-sessions-v1	POST `/role-mining-sessions/v1`	Create a role mining session
download-role-mining-potential-role-zip-v1	GET `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}/download`	Export (download) details for a potential role in a role mining session
export-role-mining-potential-role-async-v1	POST `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/export-async`	Asynchronously export details for a potential role in a role mining session and upload to S3
export-role-mining-potential-role-status-v1	GET `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/export-async/{exportId}`	Retrieve status of a potential role export job
export-role-mining-potential-role-v1	GET `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/export`	Export (download) details for a potential role in a role mining session
get-all-potential-role-summaries-v1	GET `/role-mining-potential-roles/v1`	Retrieves all potential role summaries
get-entitlement-distribution-potential-role-v1	GET `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularity-distribution`	Retrieves entitlement popularity distribution for a potential role in a role mining session
get-entitlements-potential-role-v1	GET `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/entitlement-popularities`	Retrieves entitlements for a potential role in a role mining session
get-excluded-entitlements-potential-role-v1	GET `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/excluded-entitlements`	Retrieves excluded entitlements for a potential role in a role mining session
get-identities-potential-role-v1	GET `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/identities`	Retrieves identities for a potential role in a role mining session
get-potential-role-applications-v1	GET `/role-mining-sessions/v1/{sessionId}/potential-role-summaries/{potentialRoleId}/applications`	Retrieves the applications of a potential role for a role mining session
get-potential-role-entitlements-v1	GET `/role-mining-sessions/v1/{sessionId}/potential-role-summaries/{potentialRoleId}/entitlements`	Retrieves the entitlements of a potential role for a role mining session
get-potential-role-source-identity-usage-v1	GET `/role-mining-potential-roles/v1/{potentialRoleId}/sources/{sourceId}/identityUsage`	Retrieves potential role source usage
get-potential-role-summaries-v1	GET `/role-mining-sessions/v1/{sessionId}/potential-role-summaries`	Retrieves all potential role summaries
get-potential-role-v1	GET `/role-mining-sessions/v1/{sessionId}/potential-role-summaries/{potentialRoleId}`	Retrieves a specific potential role
get-role-mining-potential-role-v1	GET `/role-mining-potential-roles/v1/{potentialRoleId}`	Retrieves a specific potential role
get-role-mining-session-status-v1	GET `/role-mining-sessions/v1/{sessionId}/status`	Get role mining session status state
get-role-mining-session-v1	GET `/role-mining-sessions/v1/{sessionId}`	Get a role mining session
get-role-mining-sessions-v1	GET `/role-mining-sessions/v1`	Retrieves all role mining sessions
get-saved-potential-roles-v1	GET `/role-mining-potential-roles/v1/saved`	Retrieves all saved potential roles
patch-potential-role-session-v1	PATCH `/role-mining-sessions/v1/{sessionId}/potential-role-summaries/{potentialRoleId}`	Update a potential role session
patch-potential-role-v1	PATCH `/role-mining-potential-roles/v1/{potentialRoleId}`	Update a potential role
patch-role-mining-session-v1	PATCH `/role-mining-sessions/v1/{sessionId}`	Patch a role mining session
update-entitlements-potential-role-v1	POST `/role-mining-sessions/v1/{sessionId}/potential-roles/{potentialRoleId}/edit-entitlements`	Edit entitlements for a potential role to exclude some entitlements

create-potential-role-provision-request-v1

experimental

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.

Create request to provision a potential role into an actual role. This method starts a job to provision a potential role

API Spec

Parameters

Name	Type	Description	Notes
sessionId	`string`	The role mining session id	[default to undefined]
potentialRoleId	`string`	A potential role id in a role mining session	[default to undefined]
minEntitlementPopularity	`number`	Minimum popularity required for an entitlement to be included in the provisioned role.	[optional] [default to 0]
includeCommonAccess	`boolean`	Boolean determining whether common access entitlements will be included in the provisioned role.	[optional] [default to true]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']
roleminingpotentialroleprovisionrequest	`Roleminingpotentialroleprovisionrequest`	Required information to create a new role	[optional]

Return type

Roleminingpotentialrolesummary

HTTP request headers

Content-Type: application/json
Accept: application/json

Example

import { IAIRoleMiningApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Roleminingpotentialroleprovisionrequest } from 'sailpoint-api-client/dist/iai_role_mining/api';

const configuration = new Configuration();
const apiInstance = new IAIRoleMiningApi(configuration);
const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id
const potentialRoleId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // A potential role id in a role mining session
const minEntitlementPopularity: number = 56; // Minimum popularity required for an entitlement to be included in the provisioned role. (optional)
const includeCommonAccess: boolean = true; // Boolean determining whether common access entitlements will be included in the provisioned role. (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const roleminingpotentialroleprovisionrequest: Roleminingpotentialroleprovisionrequest = ; // Required information to create a new role (optional)
const result = await apiInstance.createPotentialRoleProvisionRequestV1({ sessionId: sessionId, potentialRoleId: potentialRoleId });
console.log(result);

[Back to top]

create-role-mining-sessions-v1

experimental

Create a role mining session This submits a create role mining session request to the role mining application.

API Spec

Parameters

Name	Type	Description	Notes
roleminingsessiondto	`Roleminingsessiondto`	Role mining session parameters
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Roleminingsessionresponse

HTTP request headers

Content-Type: application/json
Accept: application/json

Example

import { IAIRoleMiningApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Roleminingsessiondto } from 'sailpoint-api-client/dist/iai_role_mining/api';

const configuration = new Configuration();
const apiInstance = new IAIRoleMiningApi(configuration);
const roleminingsessiondto: Roleminingsessiondto = ; // Role mining session parameters
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.createRoleMiningSessionsV1({ roleminingsessiondto: roleminingsessiondto });
console.log(result);

[Back to top]

download-role-mining-potential-role-zip-v1

experimental

Export (download) details for a potential role in a role mining session This endpoint downloads a completed export of information for a potential role in a role mining session.

API Spec

Parameters

Name	Type	Description	Notes
sessionId	`string`	The role mining session id	[default to undefined]
potentialRoleId	`string`	A potential role id in a role mining session	[default to undefined]
exportId	`string`	The id of a previously run export job for this potential role	[default to undefined]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

File

HTTP request headers

Content-Type: Not defined
Accept: application/zip, application/json

Example

import { IAIRoleMiningApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new IAIRoleMiningApi(configuration);
const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id
const potentialRoleId: string = 278359a6-04b7-4669-9468-924cf580964a; // A potential role id in a role mining session
const exportId: string = 4940ffd4-836f-48a3-b2b0-6d498c3fdf40; // The id of a previously run export job for this potential role
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.downloadRoleMiningPotentialRoleZipV1({ sessionId: sessionId, potentialRoleId: potentialRoleId, exportId: exportId });
console.log(result);

[Back to top]

export-role-mining-potential-role-async-v1

experimental

Asynchronously export details for a potential role in a role mining session and upload to S3 This endpoint uploads all the information for a potential role in a role mining session to S3 as a downloadable zip archive. Includes identities and entitlements in the potential role.

API Spec

Parameters

Name	Type	Description	Notes
sessionId	`string`	The role mining session id	[default to undefined]
potentialRoleId	`string`	A potential role id in a role mining session	[default to undefined]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']
roleminingpotentialroleexportrequest	`Roleminingpotentialroleexportrequest`		[optional]

Return type

Roleminingpotentialroleexportresponse

HTTP request headers

Content-Type: application/json
Accept: application/json

Example

import { IAIRoleMiningApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Roleminingpotentialroleexportrequest } from 'sailpoint-api-client/dist/iai_role_mining/api';

const configuration = new Configuration();
const apiInstance = new IAIRoleMiningApi(configuration);
const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id
const potentialRoleId: string = 278359a6-04b7-4669-9468-924cf580964a; // A potential role id in a role mining session
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const roleminingpotentialroleexportrequest: Roleminingpotentialroleexportrequest = ; //  (optional)
const result = await apiInstance.exportRoleMiningPotentialRoleAsyncV1({ sessionId: sessionId, potentialRoleId: potentialRoleId });
console.log(result);

[Back to top]

export-role-mining-potential-role-status-v1

experimental

Retrieve status of a potential role export job This endpoint retrieves information about the current status of a potential role export.

API Spec

Parameters

Name	Type	Description	Notes
sessionId	`string`	The role mining session id	[default to undefined]
potentialRoleId	`string`	A potential role id in a role mining session	[default to undefined]
exportId	`string`	The id of a previously run export job for this potential role	[default to undefined]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Roleminingpotentialroleexportresponse

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { IAIRoleMiningApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new IAIRoleMiningApi(configuration);
const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id
const potentialRoleId: string = 278359a6-04b7-4669-9468-924cf580964a; // A potential role id in a role mining session
const exportId: string = 4940ffd4-836f-48a3-b2b0-6d498c3fdf40; // The id of a previously run export job for this potential role
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.exportRoleMiningPotentialRoleStatusV1({ sessionId: sessionId, potentialRoleId: potentialRoleId, exportId: exportId });
console.log(result);

[Back to top]

export-role-mining-potential-role-v1

experimental

Export (download) details for a potential role in a role mining session This endpoint downloads all the information for a potential role in a role mining session. Includes identities and entitlements in the potential role.

API Spec

Parameters

Name	Type	Description	Notes
sessionId	`string`	The role mining session id	[default to undefined]
potentialRoleId	`string`	A potential role id in a role mining session	[default to undefined]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

File

HTTP request headers

Content-Type: Not defined
Accept: application/zip, application/json

Example

import { IAIRoleMiningApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new IAIRoleMiningApi(configuration);
const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id
const potentialRoleId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // A potential role id in a role mining session
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.exportRoleMiningPotentialRoleV1({ sessionId: sessionId, potentialRoleId: potentialRoleId });
console.log(result);

[Back to top]

get-all-potential-role-summaries-v1

experimental

Retrieves all potential role summaries Returns all potential role summaries that match the query parameters

API Spec

Parameters

Name	Type	Description	Notes
sorters	`string`	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: createdDate, identityCount, entitlementCount, freshness, quality	[optional] [default to undefined]
filters	`string`	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: createdById: eq, sw, co createdByName: eq, sw, co description: sw, co endDate: le, lt freshness: eq, ge, gt, le, lt name: eq, sw, co, ge, gt, le, lt quality: eq, ge, gt, le, lt startDate: ge, gt saved: eq type: eq, ge, gt, le, lt scopingMethod: eq sessionState: eq identityAttribute: co	[optional] [default to undefined]
offset	`number`	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.	[optional] [default to 0]
limit	`number`	Max number of results to return. See V3 API Standard Collection Parameters for more information.	[optional] [default to 250]
count	`boolean`	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.	[optional] [default to false]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Array<Roleminingpotentialrolesummary>

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { IAIRoleMiningApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new IAIRoleMiningApi(configuration);
const sorters: string = createdDate; // 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: **createdDate, identityCount, entitlementCount, freshness, quality** (optional)
const filters: string = (createdByName co "int") and (createdById sw "2c9180907") and (type eq "COMMON") and ((name co "entt") or (saved eq true)); // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **createdById**: *eq, sw, co*  **createdByName**: *eq, sw, co*  **description**: *sw, co*  **endDate**: *le, lt*  **freshness**: *eq, ge, gt, le, lt*  **name**: *eq, sw, co, ge, gt, le, lt*  **quality**: *eq, ge, gt, le, lt*  **startDate**: *ge, gt*  **saved**: *eq*  **type**: *eq, ge, gt, le, lt*  **scopingMethod**: *eq*  **sessionState**: *eq*  **identityAttribute**: *co* (optional)
const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getAllPotentialRoleSummariesV1({  });
console.log(result);

[Back to top]

get-entitlement-distribution-potential-role-v1

experimental

Retrieves entitlement popularity distribution for a potential role in a role mining session This method returns entitlement popularity distribution for a potential role in a role mining session.

API Spec

Parameters

Name	Type	Description	Notes
sessionId	`string`	The role mining session id	[default to undefined]
potentialRoleId	`string`	A potential role id in a role mining session	[default to undefined]
includeCommonAccess	`boolean`	Boolean determining whether common access entitlements will be included or not	[optional] [default to undefined]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

{ [key: string]: number; }

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { IAIRoleMiningApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new IAIRoleMiningApi(configuration);
const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id
const potentialRoleId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // A potential role id in a role mining session
const includeCommonAccess: boolean = true; // Boolean determining whether common access entitlements will be included or not (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getEntitlementDistributionPotentialRoleV1({ sessionId: sessionId, potentialRoleId: potentialRoleId });
console.log(result);

[Back to top]

get-entitlements-potential-role-v1

experimental

Retrieves entitlements for a potential role in a role mining session This method returns entitlements for a potential role in a role mining session.

API Spec

Parameters

Name	Type	Description	Notes
sessionId	`string`	The role mining session id	[default to undefined]
potentialRoleId	`string`	A potential role id in a role mining session	[default to undefined]
includeCommonAccess	`boolean`	Boolean determining whether common access entitlements will be included or not	[optional] [default to true]
sorters	`string`	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: popularity, entitlementName, applicationName The default sort is popularity in descending order.	[optional] [default to undefined]
filters	`string`	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: applicationName: sw entitlementRef.name: sw	[optional] [default to undefined]
offset	`number`	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.	[optional] [default to 0]
limit	`number`	Max number of results to return. See V3 API Standard Collection Parameters for more information.	[optional] [default to 250]
count	`boolean`	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.	[optional] [default to false]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Array<Roleminingentitlement>

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { IAIRoleMiningApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new IAIRoleMiningApi(configuration);
const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id
const potentialRoleId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // A potential role id in a role mining session
const includeCommonAccess: boolean = true; // Boolean determining whether common access entitlements will be included or not (optional)
const sorters: string = popularity; // 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: **popularity, entitlementName, applicationName**  The default sort is **popularity** in descending order.  (optional)
const filters: string = applicationName sw "AD"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **applicationName**: *sw*  **entitlementRef.name**: *sw* (optional)
const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getEntitlementsPotentialRoleV1({ sessionId: sessionId, potentialRoleId: potentialRoleId });
console.log(result);

[Back to top]

get-excluded-entitlements-potential-role-v1

experimental

Retrieves excluded entitlements for a potential role in a role mining session This method returns excluded entitlements for a potential role in a role mining session.

API Spec

Parameters

Name	Type	Description	Notes
sessionId	`string`	The role mining session id	[default to undefined]
potentialRoleId	`string`	A potential role id in a role mining session	[default to undefined]
sorters	`string`	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: popularity	[optional] [default to undefined]
filters	`string`	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: applicationName: sw entitlementRef.name: sw	[optional] [default to undefined]
offset	`number`	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.	[optional] [default to 0]
limit	`number`	Max number of results to return. See V3 API Standard Collection Parameters for more information.	[optional] [default to 250]
count	`boolean`	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.	[optional] [default to false]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Array<Roleminingentitlement>

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { IAIRoleMiningApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new IAIRoleMiningApi(configuration);
const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id
const potentialRoleId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // A potential role id in a role mining session
const sorters: string = populariity; // 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: **popularity** (optional)
const filters: string = applicationName sw "AD"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **applicationName**: *sw*  **entitlementRef.name**: *sw* (optional)
const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getExcludedEntitlementsPotentialRoleV1({ sessionId: sessionId, potentialRoleId: potentialRoleId });
console.log(result);

[Back to top]

get-identities-potential-role-v1

experimental

Retrieves identities for a potential role in a role mining session This method returns identities for a potential role in a role mining session.

API Spec

Parameters

Name	Type	Description	Notes
sessionId	`string`	The role mining session id	[default to undefined]
potentialRoleId	`string`	A potential role id in a role mining session	[default to undefined]
sorters	`string`	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: name	[optional] [default to undefined]
filters	`string`	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: name: sw	[optional] [default to undefined]
offset	`number`	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.	[optional] [default to 0]
limit	`number`	Max number of results to return. See V3 API Standard Collection Parameters for more information.	[optional] [default to 250]
count	`boolean`	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.	[optional] [default to false]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Array<Roleminingidentity>

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { IAIRoleMiningApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new IAIRoleMiningApi(configuration);
const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id
const potentialRoleId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // A potential role id in a role mining session
const sorters: string = name; // 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** (optional)
const filters: string = filters_example; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **name**: *sw* (optional)
const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getIdentitiesPotentialRoleV1({ sessionId: sessionId, potentialRoleId: potentialRoleId });
console.log(result);

[Back to top]

get-potential-role-applications-v1

experimental

Retrieves the applications of a potential role for a role mining session This method returns the applications of a potential role for a role mining session.

API Spec

Parameters

Name	Type	Description	Notes
sessionId	`string`	The role mining session id	[default to undefined]
potentialRoleId	`string`	A potential role id in a role mining session	[default to undefined]
filters	`string`	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: applicationName: sw	[optional] [default to undefined]
offset	`number`	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.	[optional] [default to 0]
limit	`number`	Max number of results to return. See V3 API Standard Collection Parameters for more information.	[optional] [default to 250]
count	`boolean`	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.	[optional] [default to false]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Array<Roleminingpotentialroleapplication>

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { IAIRoleMiningApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new IAIRoleMiningApi(configuration);
const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id
const potentialRoleId: string = 62f28d91-7d9f-4d17-be15-666d5b41d77f; // A potential role id in a role mining session
const filters: string = applicationName sw "test"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **applicationName**: *sw* (optional)
const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getPotentialRoleApplicationsV1({ sessionId: sessionId, potentialRoleId: potentialRoleId });
console.log(result);

[Back to top]

get-potential-role-entitlements-v1

experimental

Retrieves the entitlements of a potential role for a role mining session This method returns the entitlements of a potential role for a role mining session.

API Spec

Parameters

Name	Type	Description	Notes
sessionId	`string`	The role mining session id	[default to undefined]
potentialRoleId	`string`	A potential role id in a role mining session	[default to undefined]
filters	`string`	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: entitlementRef.name: sw	[optional] [default to undefined]
offset	`number`	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.	[optional] [default to 0]
limit	`number`	Max number of results to return. See V3 API Standard Collection Parameters for more information.	[optional] [default to 250]
count	`boolean`	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.	[optional] [default to false]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Array<Roleminingpotentialroleentitlements>

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { IAIRoleMiningApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new IAIRoleMiningApi(configuration);
const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id
const potentialRoleId: string = 62f28d91-7d9f-4d17-be15-666d5b41d77f; // A potential role id in a role mining session
const filters: string = entitlementRef.name sw "test"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **entitlementRef.name**: *sw* (optional)
const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getPotentialRoleEntitlementsV1({ sessionId: sessionId, potentialRoleId: potentialRoleId });
console.log(result);

[Back to top]

get-potential-role-source-identity-usage-v1

experimental

Retrieves potential role source usage This method returns source usageCount (as number of days in the last 90 days) for each identity in a potential role.

API Spec

Parameters

Name	Type	Description	Notes
potentialRoleId	`string`	A potential role id	[default to undefined]
sourceId	`string`	A source id	[default to undefined]
sorters	`string`	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: displayName, email, usageCount	[optional] [default to undefined]
offset	`number`	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.	[optional] [default to 0]
limit	`number`	Max number of results to return. See V3 API Standard Collection Parameters for more information.	[optional] [default to 250]
count	`boolean`	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.	[optional] [default to false]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Array<Roleminingpotentialrolesourceusage>

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { IAIRoleMiningApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new IAIRoleMiningApi(configuration);
const potentialRoleId: string = e0cc5d7d-bf7f-4f81-b2af-8885b09d9923; // A potential role id
const sourceId: string = 2c9180877620c1460176267f336a106f; // A source id
const sorters: string = -usageCount; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **displayName, email, usageCount** (optional)
const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getPotentialRoleSourceIdentityUsageV1({ potentialRoleId: potentialRoleId, sourceId: sourceId });
console.log(result);

[Back to top]

get-potential-role-summaries-v1

experimental

Retrieves all potential role summaries This method returns the potential role summaries for a role mining session.

API Spec

Parameters

Name	Type	Description	Notes
sessionId	`string`	The role mining session id	[default to undefined]
sorters	`string`	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: createdDate	[optional] [default to undefined]
filters	`string`	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: createdById: eq, sw, co createdByName: eq, sw, co description: sw, co endDate: le, lt freshness: eq, ge, gt, le, lt name: eq, sw, co quality: eq, ge, gt, le, lt startDate: ge, gt saved: eq type: eq	[optional] [default to undefined]
offset	`number`	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.	[optional] [default to 0]
limit	`number`	Max number of results to return. See V3 API Standard Collection Parameters for more information.	[optional] [default to 250]
count	`boolean`	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.	[optional] [default to false]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Array<Roleminingpotentialrolesummary>

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { IAIRoleMiningApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new IAIRoleMiningApi(configuration);
const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id
const sorters: string = createdDate; // 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: **createdDate** (optional)
const filters: string = (createdByName co "int")and (createdById sw "2c9180907")and (type eq "COMMON")and ((name co "entt")or (saved eq true)); // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **createdById**: *eq, sw, co*  **createdByName**: *eq, sw, co*  **description**: *sw, co*  **endDate**: *le, lt*  **freshness**: *eq, ge, gt, le, lt*  **name**: *eq, sw, co*  **quality**: *eq, ge, gt, le, lt*  **startDate**: *ge, gt*  **saved**: *eq*  **type**: *eq* (optional)
const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getPotentialRoleSummariesV1({ sessionId: sessionId });
console.log(result);

[Back to top]

get-potential-role-v1

experimental

Retrieves a specific potential role This method returns a specific potential role for a role mining session.

API Spec

Parameters

Name	Type	Description	Notes
sessionId	`string`	The role mining session id	[default to undefined]
potentialRoleId	`string`	A potential role id in a role mining session	[default to undefined]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Roleminingpotentialrole

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { IAIRoleMiningApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new IAIRoleMiningApi(configuration);
const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id
const potentialRoleId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // A potential role id in a role mining session
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getPotentialRoleV1({ sessionId: sessionId, potentialRoleId: potentialRoleId });
console.log(result);

[Back to top]

get-role-mining-potential-role-v1

experimental

Retrieves a specific potential role This method returns a specific potential role.

API Spec

Parameters

Name	Type	Description	Notes
potentialRoleId	`string`	A potential role id	[default to undefined]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Roleminingpotentialrole

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { IAIRoleMiningApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new IAIRoleMiningApi(configuration);
const potentialRoleId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // A potential role id
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getRoleMiningPotentialRoleV1({ potentialRoleId: potentialRoleId });
console.log(result);

[Back to top]

get-role-mining-session-status-v1

experimental

Get role mining session status state This method returns a role mining session status for a customer.

API Spec

Parameters

Name	Type	Description	Notes
sessionId	`string`	The role mining session id	[default to undefined]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Roleminingsessionstatus

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { IAIRoleMiningApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new IAIRoleMiningApi(configuration);
const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getRoleMiningSessionStatusV1({ sessionId: sessionId });
console.log(result);

[Back to top]

get-role-mining-session-v1

experimental

Get a role mining session The method retrieves a role mining session.

API Spec

Parameters

Name	Type	Description	Notes
sessionId	`string`	The role mining session id to be retrieved.	[default to undefined]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Roleminingsessionresponse

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { IAIRoleMiningApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new IAIRoleMiningApi(configuration);
const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id to be retrieved.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getRoleMiningSessionV1({ sessionId: sessionId });
console.log(result);

[Back to top]

get-role-mining-sessions-v1

experimental

Retrieves all role mining sessions Returns all role mining sessions that match the query parameters

API Spec

Parameters

Name	Type	Description	Notes
filters	`string`	Filter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: saved: eq name: eq, sw	[optional] [default to undefined]
sorters	`string`	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: createdBy, createdDate	[optional] [default to undefined]
offset	`number`	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.	[optional] [default to 0]
limit	`number`	Max number of results to return. See V3 API Standard Collection Parameters for more information.	[optional] [default to 250]
count	`boolean`	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.	[optional] [default to false]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Array<Roleminingsessiondto>

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { IAIRoleMiningApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new IAIRoleMiningApi(configuration);
const filters: string = saved eq "true" and name sw "RM Session"; // Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results)  Filtering is supported for the following fields and operators:  **saved**: *eq*  **name**: *eq, sw* (optional)
const sorters: string = createdBy,createdDate; // 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: **createdBy, createdDate** (optional)
const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getRoleMiningSessionsV1({  });
console.log(result);

[Back to top]

get-saved-potential-roles-v1

experimental

Retrieves all saved potential roles This method returns all saved potential roles (draft roles).

API Spec

Parameters

Name	Type	Description	Notes
sorters	`string`	Sort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: modified	[optional] [default to undefined]
offset	`number`	Offset into the full result set. Usually specified with limit to paginate through the results. See V3 API Standard Collection Parameters for more information.	[optional] [default to 0]
limit	`number`	Max number of results to return. See V3 API Standard Collection Parameters for more information.	[optional] [default to 250]
count	`boolean`	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.	[optional] [default to false]
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Array<Roleminingsessiondraftroledto>

HTTP request headers

Content-Type: Not defined
Accept: application/json

Example

import { IAIRoleMiningApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';

const configuration = new Configuration();
const apiInstance = new IAIRoleMiningApi(configuration);
const sorters: string = modified; // Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters/) Sorting is supported for the following fields: **modified** (optional)
const offset: number = 0; // Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const limit: number = 250; // Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.getSavedPotentialRolesV1({  });
console.log(result);

[Back to top]

patch-potential-role-session-v1

experimental

Update a potential role session The method updates an existing potential role using.

The following fields can be modified:

description
name
saved

NOTE: All other fields cannot be modified.

API Spec

Parameters

Name	Type	Description	Notes
sessionId	`string`	The role mining session id	[default to undefined]
potentialRoleId	`string`	The potential role summary id	[default to undefined]
jsonpatchoperationrolemining	`Array<Jsonpatchoperationrolemining>`
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

object

HTTP request headers

Content-Type: application/json-patch+json
Accept: application/json

Example

import { IAIRoleMiningApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Jsonpatchoperationrolemining } from 'sailpoint-api-client/dist/iai_role_mining/api';

const configuration = new Configuration();
const apiInstance = new IAIRoleMiningApi(configuration);
const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id
const potentialRoleId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The potential role summary id
const jsonpatchoperationrolemining: Array<Jsonpatchoperationrolemining> = [{"op":"remove","path":"/description"},{"op":"replace","path":"/description","value":"Acct I - Potential Role"},{"op":"remove","path":"/saved"},{"op":"replace","path":"/saved","value":"false"},{"op":"remove","path":"/name"},{"op":"replace","path":"/name","value":"Potential Role Accounting"}]; // 
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.patchPotentialRoleSessionV1({ sessionId: sessionId, potentialRoleId: potentialRoleId, jsonpatchoperationrolemining: jsonpatchoperationrolemining });
console.log(result);

[Back to top]

patch-potential-role-v1

experimental

Update a potential role The method updates an existing potential role using.

The following fields can be modified:

description
name
saved

NOTE: All other fields cannot be modified.

API Spec

Parameters

Name	Type	Description	Notes
sessionId	`string`	The role mining session id	[default to undefined]
potentialRoleId	`string`	The potential role summary id	[default to undefined]
jsonpatchoperationrolemining	`Array<Jsonpatchoperationrolemining>`
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

object

HTTP request headers

Content-Type: application/json-patch+json
Accept: application/json

Example

import { IAIRoleMiningApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Jsonpatchoperationrolemining } from 'sailpoint-api-client/dist/iai_role_mining/api';

const configuration = new Configuration();
const apiInstance = new IAIRoleMiningApi(configuration);
const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id
const potentialRoleId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The potential role summary id
const jsonpatchoperationrolemining: Array<Jsonpatchoperationrolemining> = [{"op":"remove","path":"/description"},{"op":"replace","path":"/description","value":"Acct I - Potential Role"},{"op":"remove","path":"/saved"},{"op":"replace","path":"/saved","value":"false"},{"op":"remove","path":"/name"},{"op":"replace","path":"/name","value":"Potential Role Accounting"}]; // 
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.patchPotentialRoleV1({ sessionId: sessionId, potentialRoleId: potentialRoleId, jsonpatchoperationrolemining: jsonpatchoperationrolemining });
console.log(result);

[Back to top]

patch-role-mining-session-v1

experimental

Patch a role mining session The method updates an existing role mining session using PATCH. Supports op in replace and changes to pruneThreshold and/or minNumIdentitiesInPotentialRole. The potential roles in this role mining session is then re-calculated.

API Spec

Parameters

Name	Type	Description	Notes
sessionId	`string`	The role mining session id to be patched	[default to undefined]
jsonpatchoperation	`Array<Jsonpatchoperation>`	Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session.
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

object

HTTP request headers

Content-Type: application/json-patch+json
Accept: application/json

Example

import { IAIRoleMiningApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Jsonpatchoperation } from 'sailpoint-api-client/dist/iai_role_mining/api';

const configuration = new Configuration();
const apiInstance = new IAIRoleMiningApi(configuration);
const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id to be patched
const jsonpatchoperation: Array<Jsonpatchoperation> = [{"op":"replace","path":"/pruneThreshold","value":"83"},{"op":"replace","path":"/minNumIdentitiesInPotentialRole","value":"10"},{"op":"replace","path":"/saved","value":"false"},{"op":"replace","path":"/name","value":"RM Session - 07/10/22"},{"op":"add","path":"/name","value":"RM Session - 07/10/22"}]; // Replace pruneThreshold and/or minNumIdentitiesInPotentialRole in role mining session. Update saved status or saved name for a role mining session.
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.patchRoleMiningSessionV1({ sessionId: sessionId, jsonpatchoperation: jsonpatchoperation });
console.log(result);

[Back to top]

update-entitlements-potential-role-v1

experimental

Edit entitlements for a potential role to exclude some entitlements This endpoint adds or removes entitlements from an exclusion list for a potential role.

API Spec

Parameters

Name	Type	Description	Notes
sessionId	`string`	The role mining session id	[default to undefined]
potentialRoleId	`string`	A potential role id in a role mining session	[default to undefined]
roleminingpotentialroleeditentitlements	`Roleminingpotentialroleeditentitlements`	Role mining session parameters
xSailPointExperimental	`string`	Use this header to enable this experimental API.	[optional] [default to 'true']

Return type

Roleminingpotentialrole

HTTP request headers

Content-Type: application/json
Accept: application/json

Example

import { IAIRoleMiningApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { Roleminingpotentialroleeditentitlements } from 'sailpoint-api-client/dist/iai_role_mining/api';

const configuration = new Configuration();
const apiInstance = new IAIRoleMiningApi(configuration);
const sessionId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // The role mining session id
const potentialRoleId: string = 8c190e67-87aa-4ed9-a90b-d9d5344523fb; // A potential role id in a role mining session
const roleminingpotentialroleeditentitlements: Roleminingpotentialroleeditentitlements = ; // Role mining session parameters
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.updateEntitlementsPotentialRoleV1({ sessionId: sessionId, potentialRoleId: potentialRoleId, roleminingpotentialroleeditentitlements: roleminingpotentialroleeditentitlements });
console.log(result);

[Back to top]

create-potential-role-provision-request-v1​

Parameters​

Return type​

HTTP request headers​

Example​

create-role-mining-sessions-v1​

Parameters​

Return type​

HTTP request headers​

Example​

download-role-mining-potential-role-zip-v1​

Parameters​

Return type​

HTTP request headers​

Example​

export-role-mining-potential-role-async-v1​

Parameters​

Return type​

HTTP request headers​

Example​

export-role-mining-potential-role-status-v1​

Parameters​

Return type​

HTTP request headers​

Example​

export-role-mining-potential-role-v1​

Parameters​

Return type​

HTTP request headers​

Example​

get-all-potential-role-summaries-v1​

Parameters​

Return type​

HTTP request headers​

Example​

get-entitlement-distribution-potential-role-v1​

Parameters​

Return type​

HTTP request headers​

Example​

get-entitlements-potential-role-v1​

Parameters​

Return type​

HTTP request headers​

Example​

get-excluded-entitlements-potential-role-v1​

Parameters​

Return type​

HTTP request headers​

Example​

get-identities-potential-role-v1​

Parameters​

Return type​

HTTP request headers​

Example​

get-potential-role-applications-v1​

Parameters​

Return type​

HTTP request headers​

Example​

get-potential-role-entitlements-v1​

Parameters​

Return type​

HTTP request headers​

Example​

get-potential-role-source-identity-usage-v1​

Parameters​

Return type​

HTTP request headers​

Example​

get-potential-role-summaries-v1​

Parameters​

Return type​

HTTP request headers​

Example​

get-potential-role-v1​

Parameters​

Return type​

HTTP request headers​

Example​

create-potential-role-provision-request-v1

Parameters

Return type

HTTP request headers

Example

create-role-mining-sessions-v1

Parameters

Return type

HTTP request headers

Example

download-role-mining-potential-role-zip-v1

Parameters

Return type

HTTP request headers

Example

export-role-mining-potential-role-async-v1

Parameters

Return type

HTTP request headers

Example

export-role-mining-potential-role-status-v1

Parameters

Return type

HTTP request headers

Example

export-role-mining-potential-role-v1

Parameters

Return type

HTTP request headers

Example

get-all-potential-role-summaries-v1

Parameters

Return type

HTTP request headers

Example

get-entitlement-distribution-potential-role-v1

Parameters

Return type

HTTP request headers

Example

get-entitlements-potential-role-v1

Parameters

Return type

HTTP request headers

Example

get-excluded-entitlements-potential-role-v1

Parameters

Return type

HTTP request headers

Example

get-identities-potential-role-v1

Parameters

Return type

HTTP request headers

Example

get-potential-role-applications-v1

Parameters

Return type

HTTP request headers

Example

get-potential-role-entitlements-v1

Parameters

Return type

HTTP request headers

Example

get-potential-role-source-identity-usage-v1

Parameters

Return type

HTTP request headers

Example

get-potential-role-summaries-v1

Parameters

Return type

HTTP request headers

Example

get-potential-role-v1

Parameters

Return type

HTTP request headers

Example