Skip to main content

Patch generic request approval config

PATCH 
/generic-request-approval-config/v1/:id
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.

Use this API to update the approval configuration of one scope using a JSON Patch payload. Use the id returned by the get API.

Patchable paths are /approvalConfig, which replaces every action at once, and /approvalConfig/{ACTION} for each action the scope's target type supports. One request can update several actions. id, targetType, and targetId identify the scope and can't be patched; a patch that targets any other path returns 400.

To return an action to the organization-level approval configuration, remove it or replace it with {}.

Each configured action uses one scheme:

APPROVAL: requires approvers and comments. approvers is a comma-separated list of approver tokens: sourceOwner, manager, machineIdentityPrimaryOwner, machineIdentitySecondaryOwners, machineIdentityAllOwners, workgroup:{governanceGroupId}, and identity:{identityId}. For the SUBTYPE DELETE action, accountOwner is also allowed. Tokens without an ID can appear at most once, and IDs must be unique and must exist. comments is one of ALL, APPROVAL, REJECTION, or OFF.

WORKFLOW: requires workflowId, the UUID of a workflow. The same workflow can't be used for more than one action. When workflow approvals are enabled for the tenant, the workflow must exist, be enabled, and use the trigger for its action (idn:machine-identity-activate for ACTIVATE, idn:machine-identity-deactivate for DEACTIVATE).

The GLOBAL scope only accepts the WORKFLOW scheme.

The ID must be a UUID; any other value returns 400. When no approval configuration exists for the ID, this API returns 404.

When agentic identity provisioning is not enabled for the tenant, this API returns 404. When this API is not enabled for the tenant, it returns 403.

Request​

Responses​

Updated approval configuration for the scope.