--- id: v1-iai-role-mining title: IAIRoleMining pagination_label: IAIRoleMining sidebar_label: IAIRoleMining sidebar_class_name: typescriptsdk keywords: ['typescript', 'TypeScript', 'sdk', 'IAIRoleMining', 'v1IAIRoleMining'] slug: /tools/sdk/typescript/iai_role_mining/methods/iai-role-mining tags: ['SDK', 'Software Development Kit', 'IAIRoleMining', 'v1IAIRoleMining'] --- # IAIRoleMiningApi All URIs are relative to *https://sailpoint.api.identitynow.com* Method | HTTP request | Description ------------- | ------------- | ------------- [**create-potential-role-provision-request-v1**](#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**](#create-role-mining-sessions-v1) | **POST** `/role-mining-sessions/v1` | Create a role mining session [**download-role-mining-potential-role-zip-v1**](#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**](#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**](#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**](#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-all-potential-role-summaries-v1) | **GET** `/role-mining-potential-roles/v1` | Retrieves all potential role summaries [**get-entitlement-distribution-potential-role-v1**](#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-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-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-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-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-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-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-potential-role-summaries-v1) | **GET** `/role-mining-sessions/v1/{sessionId}/potential-role-summaries` | Retrieves all potential role summaries [**get-potential-role-v1**](#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-role-v1) | **GET** `/role-mining-potential-roles/v1/{potentialRoleId}` | Retrieves a specific potential role [**get-role-mining-session-status-v1**](#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-session-v1) | **GET** `/role-mining-sessions/v1/{sessionId}` | Get a role mining session [**get-role-mining-sessions-v1**](#get-role-mining-sessions-v1) | **GET** `/role-mining-sessions/v1` | Retrieves all role mining sessions [**get-saved-potential-roles-v1**](#get-saved-potential-roles-v1) | **GET** `/role-mining-potential-roles/v1/saved` | Retrieves all saved potential roles [**patch-potential-role-session-v1**](#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-potential-role-v1) | **PATCH** `/role-mining-potential-roles/v1/{potentialRoleId}` | Update a potential role [**patch-role-mining-session-v1**](#patch-role-mining-session-v1) | **PATCH** `/role-mining-sessions/v1/{sessionId}` | Patch a role mining session [**update-entitlements-potential-role-v1**](#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 :::warning 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](https://developer.sailpoint.com/docs/api/create-potential-role-provision-request-v-1) ### 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 ```typescript 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 = { "includeIdentities" : true, "roleName" : "Finance - Accounting", "ownerId" : "2b568c65bc3c4c57a43bd97e3a8e41", "roleDescription" : "General access for accounting department", "directlyAssignedEntitlements" : false }; // 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 :::warning 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 a role mining session This submits a create role mining session request to the role mining application. [API Spec](https://developer.sailpoint.com/docs/api/create-role-mining-sessions-v-1) ### 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 ```typescript 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 = { "emailRecipientId" : "2c918090761a5aac0176215c46a62d58", "prescribedPruneThreshold" : 10, "pruneThreshold" : 50, "saved" : true, "potentialRolesReadyCount" : 0, "scope" : { "identityIds" : [ "2c918090761a5aac0176215c46a62d58", "2c918090761a5aac01722015c46a62d42" ], "attributeFilterCriteria" : { "displayName" : { "untranslated" : "Location: Miami" }, "ariaLabel" : { "untranslated" : "Location: Miami" }, "data" : { "displayName" : { "translateKey" : "IDN.IDENTITY_ATTRIBUTES.LOCATION" }, "name" : "location", "operator" : "EQUALS", "values" : [ "Miami" ] } }, "criteria" : "source.name:DataScienceDataset" }, "potentialRoleCount" : 0, "name" : "Saved RM Session - 07/10", "minNumIdentitiesInPotentialRole" : 20, "identityCount" : 0, "type" : "SPECIALIZED" }; // 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 :::warning 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. ::: 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](https://developer.sailpoint.com/docs/api/download-role-mining-potential-role-zip-v-1) ### 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 ```typescript 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 :::warning 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. ::: 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](https://developer.sailpoint.com/docs/api/export-role-mining-potential-role-async-v-1) ### 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 ```typescript 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 = { "minEntitlementPopularity" : 0, "includeCommonAccess" : true }; // (optional) const result = await apiInstance.exportRoleMiningPotentialRoleAsyncV1({ sessionId: sessionId, potentialRoleId: potentialRoleId }); console.log(result); ``` [[Back to top]](#) ## export-role-mining-potential-role-status-v1 :::warning 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. ::: Retrieve status of a potential role export job This endpoint retrieves information about the current status of a potential role export. [API Spec](https://developer.sailpoint.com/docs/api/export-role-mining-potential-role-status-v-1) ### 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 ```typescript 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 :::warning 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. ::: 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](https://developer.sailpoint.com/docs/api/export-role-mining-potential-role-v-1) ### 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 ```typescript 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 :::warning 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. ::: Retrieves all potential role summaries Returns all potential role summaries that match the query parameters [API Spec](https://developer.sailpoint.com/docs/api/get-all-potential-role-summaries-v-1) ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **sorters** | `string` | 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] [default to undefined] **filters** | `string` | 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] [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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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` ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### Example ```typescript 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=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 :::warning 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. ::: 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](https://developer.sailpoint.com/docs/api/get-entitlement-distribution-potential-role-v-1) ### 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 ```typescript 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 :::warning 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. ::: 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](https://developer.sailpoint.com/docs/api/get-entitlements-potential-role-v-1) ### 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](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] [default to undefined] **filters** | `string` | 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] [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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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` ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### Example ```typescript 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=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 :::warning 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. ::: 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](https://developer.sailpoint.com/docs/api/get-excluded-entitlements-potential-role-v-1) ### 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) 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](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] [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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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` ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### Example ```typescript 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=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 :::warning 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. ::: 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](https://developer.sailpoint.com/docs/api/get-identities-potential-role-v-1) ### 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) 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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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` ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### Example ```typescript 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=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 :::warning 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. ::: 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](https://developer.sailpoint.com/docs/api/get-potential-role-applications-v-1) ### 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) 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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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` ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### Example ```typescript 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=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 :::warning 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. ::: 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](https://developer.sailpoint.com/docs/api/get-potential-role-entitlements-v-1) ### 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) 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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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` ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### Example ```typescript 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=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 :::warning 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. ::: 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](https://developer.sailpoint.com/docs/api/get-potential-role-source-identity-usage-v-1) ### 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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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` ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### Example ```typescript 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=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 :::warning 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. ::: Retrieves all potential role summaries This method returns the potential role summaries for a role mining session. [API Spec](https://developer.sailpoint.com/docs/api/get-potential-role-summaries-v-1) ### 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](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) 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](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] [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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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` ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### Example ```typescript 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=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 :::warning 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. ::: Retrieves a specific potential role This method returns a specific potential role for a role mining session. [API Spec](https://developer.sailpoint.com/docs/api/get-potential-role-v-1) ### 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 ```typescript 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 :::warning 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. ::: Retrieves a specific potential role This method returns a specific potential role. [API Spec](https://developer.sailpoint.com/docs/api/get-role-mining-potential-role-v-1) ### 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 ```typescript 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 :::warning 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. ::: Get role mining session status state This method returns a role mining session status for a customer. [API Spec](https://developer.sailpoint.com/docs/api/get-role-mining-session-status-v-1) ### 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 ```typescript 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 :::warning 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. ::: Get a role mining session The method retrieves a role mining session. [API Spec](https://developer.sailpoint.com/docs/api/get-role-mining-session-v-1) ### 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 ```typescript 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 :::warning 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. ::: Retrieves all role mining sessions Returns all role mining sessions that match the query parameters [API Spec](https://developer.sailpoint.com/docs/api/get-role-mining-sessions-v-1) ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **filters** | `string` | 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] [default to undefined] **sorters** | `string` | 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] [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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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` ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### Example ```typescript 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=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 :::warning 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. ::: Retrieves all saved potential roles This method returns all saved potential roles (draft roles). [API Spec](https://developer.sailpoint.com/docs/api/get-saved-potential-roles-v-1) ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **sorters** | `string` | 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] [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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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](https://developer.sailpoint.com/idn/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` ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ### Example ```typescript 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=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 :::warning 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. ::: 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](https://developer.sailpoint.com/docs/api/patch-potential-role-session-v-1) ### 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` | | **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 ```typescript 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 = { "op" : "replace", "path" : "/description", "value" : "New description" }; // 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 :::warning 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. ::: 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](https://developer.sailpoint.com/docs/api/patch-potential-role-v-1) ### 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` | | **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 ```typescript 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 = { "op" : "replace", "path" : "/description", "value" : "New description" }; // 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 :::warning 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. ::: 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](https://developer.sailpoint.com/docs/api/patch-role-mining-session-v-1) ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **sessionId** | `string` | The role mining session id to be patched | [default to undefined] **jsonPatchOperation** | `Array` | 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 ```typescript 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 = { "op" : "replace", "path" : "/description", "value" : "New description" }; // 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 :::warning 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. ::: 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](https://developer.sailpoint.com/docs/api/update-entitlements-potential-role-v-1) ### 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 ```typescript 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 = { "ids" : [ "entId1", "entId2" ], "exclude" : true }; // 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]](#)