Preview a user's permissions after assigning/removing permission sets

Compute exactly which assistant (agent) actions the user WOULD be able to
perform after assigning and/or unassigning the given permission sets.
Nothing is written — this is a dry-run for the assignment flow.

Path Parameters:

user_id (int): the user the change is being previewed for.

Request Body (at least one of the two lists must be non-empty; the same
set may not appear in both):

permission_set_ids (list[uuid], optional): permission sets to
hypothetically assign.

remove_permission_set_ids (list[uuid], optional): permission sets to
hypothetically unassign. Only DIRECT assignments are removed — a set
the user also inherits via a team keeps contributing, exactly as a
real unassignment would behave; removing a set the user does not hold
directly is a no-op.

All referenced sets must exist in the organization, otherwise the request
fails with 404 listing the missing IDs (a preview over a partial
selection would be misleading).

Request Headers:

X-Organization-Id (int, optional): Override the org scoping the
computation. Requires manage (admin) access to the specified organization.

Authorization:

Requires org manage + manage_users (same as the assignment endpoint).

Returns:

current_permissions, projected_permissions (scope union per action),
and changes (per-action before/after, only for actions that change)
under data.

Current Version:

2.0.0

curl --location --globoff 'https:///api/v2/users//permissions/preview' \ --header 'X-Organization-Id;' \ --header 'Ocp-Apim-Subscription-Key: ' \ --header 'Authorization: Bearer ' \ --header 'Content-Type: application/json' \ --data '{ "permission_set_ids": [ "3f1c9b2a-0000-0000-0000-000000000001", "3f1c9b2a-0000-0000-0000-000000000002" ] }'

{ "success": true, "message": "string", "data": { "user_id": 0, "organization_id": 0, "current_permissions": { "agents": { "view": [ "all" ], "edit": [ "all" ], "delete": [ "all" ], "publish": [ "all" ], "create": true } }, "projected_permissions": { "agents": { "view": [ "all" ], "edit": [ "all" ], "delete": [ "all" ], "publish": [ "all" ], "create": true } }, "changes": { "property1": "string", "property2": "string" } } }

Preview a user's permissions after assigning/removing permission sets

Request

Responses