Skip to main content

JITActivationsApi

Use this API to start and manage Just-In-Time (JIT) Privileged activation workflows for entitlement connections, and to search activation history.

OAuth scopes: idn:jit-activation-workflow:* (activate, extend, deactivate, manage) for workflow APIs. idn:jit-activation-history:read (admin history view) and idn:jit-activation-history-self:read (self history view).

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

MethodHTTP requestDescription
list-jit-activation-history-for-current-identity-v1GET /jit-activation-history/v1/current-identityList JIT activation history (self)
list-jit-activation-history-v1GET /jit-activation-history/v1List JIT activation history (admin)
start-activate-workflow-v1POST /jit-activations/v1/activateStart JIT activation workflow
start-deactivate-workflow-v1POST /jit-activations/v1/deactivateDeactivate JIT activation workflow
start-extend-workflow-v1POST /jit-activations/v1/extendExtend JIT activation workflow

list-jit-activation-history-for-current-identity-v1

List JIT activation history (self) Returns JIT activation history records for the authenticated identity only.

This is the self-service view - results are automatically scoped to the calling identity. Requires idn:jit-activation-history-self:read.

Returns HTTP 403 when the PSPM_858_JIT_ACCESS_ACTIVATION_HISTORY_SEARCH feature flag is disabled.

API Spec

Parameters

NameTypeDescriptionNotes
limitnumberMax number of results to return. See V3 API Standard Collection Parameters for more information.[optional] [default to 250]
offsetnumberOffset 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]
countbooleanIf 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]
sortersstringSort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: activationInitiated, provisionCompleted, status Default sort is -activationInitiated (newest first).[optional] [default to undefined]
searchAfterstringUsed 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. Used to paginate beyond the offset limit of 10,000. It is recommended to always include the ID of the object in addition to any other sort fields to ensure no duplicate results while paging. For example, if sorting by activationInitiated you will also want to include ID: searchAfter=2026-07-08T14:33:52.029Z,367fb802-1026-1835-a619-11a56e4c5be3&sorters=activationInitiated,id[optional] [default to undefined]
filtersstringFilter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: entitlementId: eq, in sourceId: eq connectionId: eq status: eq, in activationInitiated: gt, lt, ge, le policyFrictionOutcome: eq, in[optional] [default to undefined]

Return type

Array<Jitactivationhistorydocument>

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

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

const configuration = new Configuration();
const apiInstance = new JITActivationsApi(configuration);
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 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 count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const sorters: string = -activationInitiated; // 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: **activationInitiated, provisionCompleted, status** Default sort is **-activationInitiated** (newest first). (optional)
const searchAfter: string = 2026-07-08T14:33:52.029Z,367fb802-1026-1835-a619-11a56e4c5be3; // 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. Used to paginate beyond the offset limit of 10,000. It is recommended to always include the ID of the object in addition to any other sort fields to ensure no duplicate results while paging. For example, if sorting by activationInitiated you will also want to include ID: searchAfter&#x3D;2026-07-08T14:33:52.029Z,367fb802-1026-1835-a619-11a56e4c5be3&amp;sorters&#x3D;activationInitiated,id (optional)
const filters: string = status eq "PROVISIONED"; // 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: **entitlementId**: *eq, in* **sourceId**: *eq* **connectionId**: *eq* **status**: *eq, in* **activationInitiated**: *gt, lt, ge, le* **policyFrictionOutcome**: *eq, in* (optional)
const result = await apiInstance.listJitActivationHistoryForCurrentIdentityV1({ });
console.log(result);

[Back to top]

list-jit-activation-history-v1

List JIT activation history (admin) Returns JIT activation history records for the tenant.

This is the admin/operator view - it returns activations across all identities in the tenant. Requires idn:jit-activation-history:read.

Returns HTTP 403 when the PSPM_858_JIT_ACCESS_ACTIVATION_HISTORY_SEARCH feature flag is disabled.

API Spec

Parameters

NameTypeDescriptionNotes
limitnumberMax number of results to return. See V3 API Standard Collection Parameters for more information.[optional] [default to 250]
offsetnumberOffset 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]
countbooleanIf 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]
sortersstringSort results using the standard syntax described in V3 API Standard Collection Parameters Sorting is supported for the following fields: activationInitiated, provisionCompleted, status Default sort is -activationInitiated (newest first).[optional] [default to undefined]
searchAfterstringUsed 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. Used to paginate beyond the offset limit of 10,000. It is recommended to always include the ID of the object in addition to any other sort fields to ensure no duplicate results while paging. For example, if sorting by activationInitiated you will also want to include ID: searchAfter=2026-07-08T14:33:52.029Z,367fb802-1026-1835-a619-11a56e4c5be3&sorters=activationInitiated,id[optional] [default to undefined]
filtersstringFilter results using the standard syntax described in V3 API Standard Collection Parameters Filtering is supported for the following fields and operators: identityId: eq, in entitlementId: eq, in sourceId: eq connectionId: eq status: eq, in activationInitiated: gt, lt, ge, le policyFrictionOutcome: eq, in[optional] [default to undefined]

Return type

Array<Jitactivationhistorydocument>

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

Example

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

const configuration = new Configuration();
const apiInstance = new JITActivationsApi(configuration);
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 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 count: boolean = true; // If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count&#x3D;true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional)
const sorters: string = -activationInitiated; // 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: **activationInitiated, provisionCompleted, status** Default sort is **-activationInitiated** (newest first). (optional)
const searchAfter: string = 2026-07-08T14:33:52.029Z,367fb802-1026-1835-a619-11a56e4c5be3; // 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. Used to paginate beyond the offset limit of 10,000. It is recommended to always include the ID of the object in addition to any other sort fields to ensure no duplicate results while paging. For example, if sorting by activationInitiated you will also want to include ID: searchAfter&#x3D;2026-07-08T14:33:52.029Z,367fb802-1026-1835-a619-11a56e4c5be3&amp;sorters&#x3D;activationInitiated,id (optional)
const filters: string = status eq "PROVISIONED"; // 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: **identityId**: *eq, in* **entitlementId**: *eq, in* **sourceId**: *eq* **connectionId**: *eq* **status**: *eq, in* **activationInitiated**: *gt, lt, ge, le* **policyFrictionOutcome**: *eq, in* (optional)
const result = await apiInstance.listJitActivationHistoryV1({ });
console.log(result);

[Back to top]

start-activate-workflow-v1

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

Start JIT activation workflow Starts a JIT Privileged (JIT P) activation workflow for the given entitlement connection and duration. The service performs quick validation; the workflow performs additional validation.

The response is returned with HTTP 202 Accepted while the workflow initializes.

API Spec

Parameters

NameTypeDescriptionNotes
jitActivationActivateRequestJitActivationActivateRequest
xSailPointExperimentalstringUse this header to enable this experimental API.[optional] [default to 'true']

Return type

JitActivationActivateResponse

HTTP request headers

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

Example

import { JITActivationsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { JitActivationActivateRequest } from 'sailpoint-api-client/dist/jit_activations/api';

const configuration = new Configuration();
const apiInstance = new JITActivationsApi(configuration);
const jitActivationActivateRequest: JitActivationActivateRequest = {
"activationPeriodMins" : 120,
"connectionId" : "757fb803-9024-5861-e510-83a56e4c5bd3"
}; //
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.startActivateWorkflowV1({ jitActivationActivateRequest: jitActivationActivateRequest });
console.log(result);

[Back to top]

start-deactivate-workflow-v1

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

Deactivate JIT activation workflow Sends a signal to a running JIT Privileged (JIT P) activation workflow to deactivate.

This request cannot be applied to a workflow that does not exist or whose execution has already completed. The client receives an error response in those cases.

The response is returned with HTTP 202 Accepted after the signal is sent.

API Spec

Parameters

NameTypeDescriptionNotes
jitActivationDeactivateRequestJitActivationDeactivateRequest
xSailPointExperimentalstringUse this header to enable this experimental API.[optional] [default to 'true']

Return type

JitActivationDeactivateResponse

HTTP request headers

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

Example

import { JITActivationsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { JitActivationDeactivateRequest } from 'sailpoint-api-client/dist/jit_activations/api';

const configuration = new Configuration();
const apiInstance = new JITActivationsApi(configuration);
const jitActivationDeactivateRequest: JitActivationDeactivateRequest = {
"connectionId" : "757fb803-9024-5861-e510-83a56e4c5bd3"
}; //
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.startDeactivateWorkflowV1({ jitActivationDeactivateRequest: jitActivationDeactivateRequest });
console.log(result);

[Back to top]

start-extend-workflow-v1

experimental

This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint.

Extend JIT activation workflow Sends a signal to a running JIT Privileged (JIT P) activation workflow to extend the activation period by the requested number of minutes.

This request cannot be applied to a workflow that does not exist or whose execution has already completed. The client receives an error response in those cases.

The response is returned with HTTP 202 Accepted after the signal is sent.

API Spec

Parameters

NameTypeDescriptionNotes
jitActivationExtendRequestJitActivationExtendRequest
xSailPointExperimentalstringUse this header to enable this experimental API.[optional] [default to 'true']

Return type

JitActivationExtendResponse

HTTP request headers

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

Example

import { JITActivationsApi } from 'sailpoint-api-client';
import { Configuration } from 'sailpoint-api-client';
import { JitActivationExtendRequest } from 'sailpoint-api-client/dist/jit_activations/api';

const configuration = new Configuration();
const apiInstance = new JITActivationsApi(configuration);
const jitActivationExtendRequest: JitActivationExtendRequest = {
"activationPeriodExtensionMins" : 120,
"connectionId" : "757fb803-9024-5861-e510-83a56e4c5bd3"
}; //
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
const result = await apiInstance.startExtendWorkflowV1({ jitActivationExtendRequest: jitActivationExtendRequest });
console.log(result);

[Back to top]