Skip to Content
InvyteDocs

Preview a role change

See what editing a role, or deleting it, would change: the capabilities added and lost, how many people hold it and how many invitations not accepted yet hold it, the Jobs it reaches, and the Human Review steps that name it when it would no longer decide. Admins only.

POST
/operations/access.roleImpact

Authorization

bearer
headerAuthorizationBearer <API key or OAuth token>

An organization API key (ink_live_…, ADR-0124), or the OAuth access token a person's AI client gets from the Recruiter MCP sign-in. Only the Authorization header is accepted.

Header Parameters

Idempotency-Key?string

Makes a write safe to repeat: the same key and input return the first result. Required for agents' writes and for anything a person confirms.

Match^[A-Za-z0-9._:-]+$
Length8 <= length <= 128

Request Body

application/json
  1. body
input*
confirmation?string

The id from a confirm or awaiting_approval Outcome, sent with the same input and key to go ahead.

Response Body

Done. A replay of the same key and input omits output.

application/json
  1. response
status*unknown
output?
actionId*string
Example Request
curl -X POST 'https://www.invyte.ai/api/recruiter/v1/operations/access.roleImpact' \  -H 'Content-Type: application/json' \  -d '{  "input": {    "roleId": "string"  }}'
Example Response
{  "status": "done",  "output": {    "added": [      "job.create"    ],    "removed": [      "job.create"    ],    "people": 0,    "keys": 0,    "invitations": 0,    "jobs": 0,    "reviewSteps": 0  },  "actionId": "string"}