Ctrl+K

Get permission differences for pending change

get/api/usermanagement/v1/organizations/{orgId}/pendingchanges/{pendingChangeId}/permissions/diff

Calculates the permission differences between the current state of a role and the proposed changes in a pending change with UPDATE_ROLE type. Checks for orphaned resources and breaking changes as a result of the pending change. Returns an object with permission changes, enterprise changes, resource changes, and warnings.

Path Parameters

  • orgIdstringRequired
    External organization ID with checksum validation
  • pendingChangeIdstring<uuid>Required
    Unique identifier of the pending change

200 Response

userId string required
The user ID who initiated the pending change
summary object required
Summary of the permission diff
totalAdded integer <int32>required
Total number of permissions/enterprises/resources added
totalRemoved integer <int32>required
Total number of permissions/enterprises/resources removed
hasBreakingChanges boolean required
True if the change would result in orphaned resources
permissionChanges object required
Permission changes grouped by added and removed
added array[object] required
Details of a permission change
removed array[object] required
Details of a permission change
enterpriseChanges object required
Enterprise scope changes grouped by added and removed
added array[object] required
Details of an enterprise scope change
removed array[object] required
Details of an enterprise scope change
resourceChanges object required
Resource access changes grouped by added and removed
added array[object] required
Details of a resource access change
removed array[object] required
Details of a resource access change
warnings array[object] required
Warning about a potential issue with the change
type string required
Warning type
Example: ORPHANED_WALLETS
message string required
Human-readable warning message
resourceIds array[string] required
Resource IDs affected by this warning

400 Response

403 Response

404 Response