Archive Permission
@deprecated in favor of “deletePermission”. Deletes a permission (aka “Role”).
Authentication
✅ Organization User (CustomerEmployee)❌ Delegated User (
EndUser)✅ Service Account
Required Permissions
Permissions:Delete: Always required.Authorizations
Bearer Token: Used to authenticate API requests. More details how to generate the token: Authentication flows
User Action Signature: Used to sign the change-inducing API requests. More details how to generate the token: User Action Signing flows
Path Parameters
ID of the permission (also referred to as "role" in the dashboard).
1 - 64Body
@deprecated - use "deletePermission" method instead
Response
Success
ID of the permission (also referred to as "role" in the dashboard).
1 - 64^pm-[a-z0-9]{5}-[a-z0-9]{5}-[a-z0-9]{14,16}$"pm-37vj4-jkr4l-lc9945spfftkne57"
Human-readable name of the permission (role).
List of API operations this permission grants access to. See Permissions List for available operations.
Current status of the permission.
Active Whether this permission is system-managed and cannot be modified.
Whether this permission has been archived (soft-deleted).