mirror of
https://github.com/LukeHagar/api-specs.git
synced 2025-12-09 12:27:48 +00:00
9b7a3225b5
* IDNARSENAL-18279: a couple tweaks to the /identities/process endpoint docs * IDNARSENAL-18279: fix description * IDNARSENAL-18279: line format' by github action: 6631941173
45 lines
1.6 KiB
YAML
45 lines
1.6 KiB
YAML
post:
|
|
operationId: startIdentityProcessing
|
|
tags:
|
|
- Identities
|
|
summary: Process a list of identityIds
|
|
description: |
|
|
You could use this endpoint to:
|
|
1. Calculate identity attributes, including applying or running any rules or transforms (e.g. calculate Lifecycle State at a point-in-time it's expected to change).
|
|
2. Evaluate role assignments, leading to assignment of new roles and removal of existing roles.
|
|
3. Enforce provisioning for any assigned accesses that haven't been fulfilled (e.g. failure due to source health).
|
|
4. Recalculate manager relationships.
|
|
5. Potentially clean-up identity processing errors, assuming the error has been resolved.
|
|
|
|
To learn more, refer to the [identity processing documentation](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html).
|
|
|
|
A token with ORG_ADMIN or HELPDESK authority is required to call this API.
|
|
security:
|
|
- UserContextAuth:
|
|
- "idn:identity:manage"
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "../schemas/ProcessIdentitiesRequest.yaml"
|
|
responses:
|
|
"202":
|
|
description: Object containing the DTO type TASK_RESULT and the job id for the task
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: "../schemas/TaskResultResponse.yaml"
|
|
"400":
|
|
$ref: "../../v3/responses/400.yaml"
|
|
"401":
|
|
$ref: "../../v3/responses/401.yaml"
|
|
"403":
|
|
$ref: "../../v3/responses/403.yaml"
|
|
"404":
|
|
$ref: "../../v3/responses/404.yaml"
|
|
"429":
|
|
$ref: "../../v3/responses/429.yaml"
|
|
"500":
|
|
$ref: "../../v3/responses/500.yaml"
|