Skip to main content

JITActivationConvert

Use this API to convert the assignment type of an entitlement connection between STANDING and JIT (Just-In-Time Privileged).

OAuth scope required: idn:jit-assignment-type-conversion:manage

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

MethodHTTP requestDescription
Start-EntitlementConnectionConversionV1POST /convert-entitlement-connection/v1Convert entitlement connection assignment type

start-entitlement-connection-conversion-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.

Initiates an asynchronous workflow to convert the assignment type of an entitlement connection between STANDING and JIT (Just-In-Time Privileged).

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

API Spec

Parameters​

Param TypeNameData TypeRequiredDescription
XSailPointExperimentalStringTrue (default to "true")Use this header to enable this experimental API.
BodyConvertEntitlementConnectionRequestConvertEntitlementConnectionRequestTrue

Return type​

ConvertEntitlementConnectionResponse

Responses​

CodeDescriptionData Type
202Accepted. The conversion workflow was accepted and is running.ConvertEntitlementConnectionResponse
400Client Error - Returned if the request body is invalid.ErrorResponseDto
401Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.StartEntitlementConnectionConversionV1401Response
403Forbidden - Returned if the user you are running as, doesn't have access to this end-point.ErrorResponseDto
404Not Found - returned if the request URL refers to a resource or object that does not existErrorResponseDto
429Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.StartEntitlementConnectionConversionV1429Response
500Internal Server Error - Returned if there is an unexpected error.ErrorResponseDto

HTTP request headers​

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

Example​

$XSailPointExperimental = "true" # String | Use this header to enable this experimental API. (default to "true")
$ConvertEntitlementConnectionRequest = @"{
"connectionId" : "757fb803-9024-5861-e510-83a56e4c5bd3",
"targetType" : "JIT"
}"@

# Convert entitlement connection assignment type

try {
$Result = ConvertFrom-JsonToConvertEntitlementConnectionRequest -Json $ConvertEntitlementConnectionRequest
Start-EntitlementConnectionConversionV1 -XSailPointExperimental $XSailPointExperimental -ConvertEntitlementConnectionRequest $Result

# Below is a request that includes all optional parameters
# Start-EntitlementConnectionConversionV1 -XSailPointExperimental $XSailPointExperimental -ConvertEntitlementConnectionRequest $Result
} catch {
Write-Host $_.Exception.Response.StatusCode.value__ "Exception occurred when calling Start-EntitlementConnectionConversionV1"
Write-Host $_.ErrorDetails
}

[Back to top]