JITActivationsApi
Use this API to start and manage Just-In-Time (JIT) Privileged activation workflows for entitlement connections.
All URIs are relative to https://sailpoint.api.identitynow.com
| Method | HTTP request | Description |
|---|---|---|
| start-activate-workflow-v1 | POST /jit-activations/v1/activate | Start JIT activation workflow |
| start-deactivate-workflow-v1 | POST /jit-activations/v1/deactivate | Deactivate JIT activation workflow |
| start-extend-workflow-v1 | POST /jit-activations/v1/extend | Extend JIT activation workflow |
start-activate-workflow-v1
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.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| jitactivationactivaterequest | Jitactivationactivaterequest |
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';
const configuration = new Configuration();
const apiInstance = new JITActivationsApi(configuration);
const jitactivationactivaterequest: Jitactivationactivaterequest = ; //
const result = await apiInstance.startActivateWorkflowV1({ jitactivationactivaterequest: jitactivationactivaterequest });
console.log(result);
start-deactivate-workflow-v1
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.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| jitactivationdeactivaterequest | Jitactivationdeactivaterequest |
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';
const configuration = new Configuration();
const apiInstance = new JITActivationsApi(configuration);
const jitactivationdeactivaterequest: Jitactivationdeactivaterequest = ; //
const result = await apiInstance.startDeactivateWorkflowV1({ jitactivationdeactivaterequest: jitactivationdeactivaterequest });
console.log(result);
start-extend-workflow-v1
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.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| jitactivationextendrequest | Jitactivationextendrequest |
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';
const configuration = new Configuration();
const apiInstance = new JITActivationsApi(configuration);
const jitactivationextendrequest: Jitactivationextendrequest = ; //
const result = await apiInstance.startExtendWorkflowV1({ jitactivationextendrequest: jitactivationextendrequest });
console.log(result);