EntitlementConnectionsApi
Use this API to search and manage entitlement connections. Entitlement connections represent the relationship between an identity account and an entitlement on a source, including its access type and JIT lifecycle state.
All URIs are relative to https://sailpoint.api.identitynow.com
| Method | HTTP request | Description |
|---|---|---|
| list-entitlement-connections-for-current-identity-v1 | GET /entitlement-connections/v1/current-identity | List my entitlement connections |
| list-entitlement-connections-v1 | GET /entitlement-connections/v1 | List entitlement connections |
| patch-entitlement-connection-by-id-v1 | PATCH /entitlement-connections/v1/{connectionId} | Update entitlement connection |
| patch-entitlement-connection-by-query-v1 | PATCH /entitlement-connections/v1 | Update connection by query |
| update-entitlement-connections-bulk-v1 | POST /entitlement-connections/v1 | Update connections in bulk |
list-entitlement-connections-for-current-identity-v1
List my entitlement connections Returns entitlement connections constrained to the authenticated identity. This endpoint proxies to Search and supports standard collection query parameters.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| 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] |
| searchAfter | string | Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is "Account Payable", then using that name and ID will start a new search after this entitlement. | [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: identity.id: eq, in identity.name: eq, in, co source.id: eq, in source.name: eq, in, co account.id: eq, in account.name: eq, in, co entitlement.id: eq, in entitlement.attribute: eq, in, co entitlement.value: eq, in, co entitlement.privilegeLevel.effective: eq, in, co type: eq, in state.value: eq, in, co standalone: eq, in jit.activation: gt, lt, ge, le jit.provision: gt, lt, ge, le jit.deactivation: gt, lt, ge, le jit.deprovision: gt, lt, ge, le jit.expiration: gt, lt, ge, le The authenticated identity scope is always applied by the service. | [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: id, identity.id, identity.name, source.id, source.name, account.id, account.name, entitlement.id, entitlement.displayName, entitlement.attribute, entitlement.privilegeLevel.effective, type, state.value, standalone, jit.activation, jit.provision, jit.deactivation, jit.deprovision, jit.expiration | [optional] [default to undefined] |
Return type
Array<Entitlementconnectionsearchhit>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { EntitlementConnectionsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new EntitlementConnectionsApi(configuration);
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 searchAfter: string = Account Payable,2c91808375d8e80a0175e1f88a575221; // Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. (optional)
const filters: string = state.value co "Available"; // 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: **identity.id**: *eq, in* **identity.name**: *eq, in, co* **source.id**: *eq, in* **source.name**: *eq, in, co* **account.id**: *eq, in* **account.name**: *eq, in, co* **entitlement.id**: *eq, in* **entitlement.attribute**: *eq, in, co* **entitlement.value**: *eq, in, co* **entitlement.privilegeLevel.effective**: *eq, in, co* **type**: *eq, in* **state.value**: *eq, in, co* **standalone**: *eq, in* **jit.activation**: *gt, lt, ge, le* **jit.provision**: *gt, lt, ge, le* **jit.deactivation**: *gt, lt, ge, le* **jit.deprovision**: *gt, lt, ge, le* **jit.expiration**: *gt, lt, ge, le* The authenticated identity scope is always applied by the service. (optional)
const sorters: string = id; // 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: **id, identity.id, identity.name, source.id, source.name, account.id, account.name, entitlement.id, entitlement.displayName, entitlement.attribute, entitlement.privilegeLevel.effective, type, state.value, standalone, jit.activation, jit.provision, jit.deactivation, jit.deprovision, jit.expiration** (optional)
const result = await apiInstance.listEntitlementConnectionsForCurrentIdentityV1({ });
console.log(result);
list-entitlement-connections-v1
List entitlement connections Returns entitlement connections for the tenant.
This endpoint proxies to Search and supports standard collection query parameters.
The filters and sorters values support the Entitlement Connections search fields documented by ECS.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| 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] |
| searchAfter | string | Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don't get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is "Account Payable", then using that name and ID will start a new search after this entitlement. | [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: identity.id: eq, in identity.name: eq, in, co source.id: eq, in source.name: eq, in, co account.id: eq, in account.name: eq, in, co entitlement.id: eq, in entitlement.attribute: eq, in, co entitlement.value: eq, in, co entitlement.privilegeLevel.effective: eq, in, co type: eq, in state.value: eq, in, co standalone: eq, in jit.activation: gt, lt, ge, le jit.provision: gt, lt, ge, le jit.deactivation: gt, lt, ge, le jit.deprovision: gt, lt, ge, le jit.expiration: gt, lt, ge, le | [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: id, identity.id, identity.name, source.id, source.name, account.id, account.name, entitlement.id, entitlement.displayName, entitlement.attribute, entitlement.privilegeLevel.effective, type, state.value, standalone, jit.activation, jit.provision, jit.deactivation, jit.deprovision, jit.expiration Prefix a field with `-` for descending order. | [optional] [default to undefined] |
Return type
Array<Entitlementconnectionsearchhit>
HTTP request headers
- Content-Type: Not defined
- Accept: application/json
Example
import { EntitlementConnectionsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new EntitlementConnectionsApi(configuration);
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 searchAfter: string = Account Payable,2c91808375d8e80a0175e1f88a575221; // Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to expand the Elasticsearch limit of 10K records by shifting the 10K window to begin at this value. It is recommended that you always include the ID of the object in addition to any other fields on this parameter in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=Account Payable,2c91808375d8e80a0175e1f88a575221&sorters=name,id. If the last entitlement ID in the search result is 2c91808375d8e80a0175e1f88a575221 and the last name is \"Account Payable\", then using that name and ID will start a new search after this entitlement. (optional)
const filters: string = type eq "JIT"; // 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: **identity.id**: *eq, in* **identity.name**: *eq, in, co* **source.id**: *eq, in* **source.name**: *eq, in, co* **account.id**: *eq, in* **account.name**: *eq, in, co* **entitlement.id**: *eq, in* **entitlement.attribute**: *eq, in, co* **entitlement.value**: *eq, in, co* **entitlement.privilegeLevel.effective**: *eq, in, co* **type**: *eq, in* **state.value**: *eq, in, co* **standalone**: *eq, in* **jit.activation**: *gt, lt, ge, le* **jit.provision**: *gt, lt, ge, le* **jit.deactivation**: *gt, lt, ge, le* **jit.deprovision**: *gt, lt, ge, le* **jit.expiration**: *gt, lt, ge, le* (optional)
const sorters: string = -type,id; // 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: **id, identity.id, identity.name, source.id, source.name, account.id, account.name, entitlement.id, entitlement.displayName, entitlement.attribute, entitlement.privilegeLevel.effective, type, state.value, standalone, jit.activation, jit.provision, jit.deactivation, jit.deprovision, jit.expiration** Prefix a field with `-` for descending order. (optional)
const result = await apiInstance.listEntitlementConnectionsV1({ });
console.log(result);
patch-entitlement-connection-by-id-v1
Update entitlement connection
Applies JSON Patch operations to an entitlement connection selected by connectionId.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| connectionId | string | Connection ID (UUID with or without hyphens). | [default to undefined] |
| jsonpatchoperation | Array<Jsonpatchoperation> |
Return type
Entitlementconnection
HTTP request headers
- Content-Type: application/json-patch+json
- Accept: application/json
Example
import { EntitlementConnectionsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new EntitlementConnectionsApi(configuration);
const connectionId: string = 6c692d9972f8400ca4560a68f62c4c5f; // Connection ID (UUID with or without hyphens).
const jsonpatchoperation: Array<Jsonpatchoperation> = ; //
const result = await apiInstance.patchEntitlementConnectionByIdV1({ connectionId: connectionId, jsonpatchoperation: jsonpatchoperation });
console.log(result);
patch-entitlement-connection-by-query-v1
Update connection by query
Applies JSON Patch operations to a single entitlement connection selected by
entitlementId, identityId, and accountId.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| entitlementId | string | Entitlement ID (UUID with or without hyphens). | [default to undefined] |
| identityId | string | Identity ID (UUID with or without hyphens). | [default to undefined] |
| accountId | string | Account ID (UUID with or without hyphens). | [default to undefined] |
| jsonpatchoperation | Array<Jsonpatchoperation> |
Return type
Entitlementconnection
HTTP request headers
- Content-Type: application/json-patch+json
- Accept: application/json
Example
import { EntitlementConnectionsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new EntitlementConnectionsApi(configuration);
const entitlementId: string = dcfd09e551644ad5aa162ce977862031; // Entitlement ID (UUID with or without hyphens).
const identityId: string = 5470d8d4817a4207a8020bf533187da9; // Identity ID (UUID with or without hyphens).
const accountId: string = 323bfddfb3dd4197b8f10f7735307d27; // Account ID (UUID with or without hyphens).
const jsonpatchoperation: Array<Jsonpatchoperation> = ; //
const result = await apiInstance.patchEntitlementConnectionByQueryV1({ entitlementId: entitlementId, identityId: identityId, accountId: accountId, jsonpatchoperation: jsonpatchoperation });
console.log(result);
update-entitlement-connections-bulk-v1
Update connections in bulk Updates connection type for up to 100 connections in one request. The API returns per-item results in a 207 Multi-Status response.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| entitlementconnectionbulkupdateitem | Array<Entitlementconnectionbulkupdateitem> |
Return type
Array<Entitlementconnectionbulkupdateresultitem>
HTTP request headers
- Content-Type: application/json
- Accept: application/json
Example
import { EntitlementConnectionsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
const configuration = new Configuration();
const apiInstance = new EntitlementConnectionsApi(configuration);
const entitlementconnectionbulkupdateitem: Array<Entitlementconnectionbulkupdateitem> = [{"connectionId":"d532fa5cb15748e2873c6a01e5923ec4","type":"JIT"},{"connectionId":"57bdbfcab8a34afb91c0a9fb4dba52b8","type":"STANDING"},{"connectionId":"0f571cefc8a2411790e0ee09f77e25a3","type":"STANDING"},{"connectionId":"025542c7e42144258c6f2325b6feeba8","type":"JIT"},{"connectionId":"6bccbc42381f49028dac9bfe68dbad2e","type":"JIT"}]; //
const result = await apiInstance.updateEntitlementConnectionsBulkV1({ entitlementconnectionbulkupdateitem: entitlementconnectionbulkupdateitem });
console.log(result);