Detach a role from a user
Remove a single custom or preset role from a business user without replacing their complete role set, and synchronize the change to the identity provider. Detaching a role the user does not hold has no effect.
Required permissions: user:update.
Authentication
AuthorizationBearer
Bearer authentication of the form Bearer <token>, where token is your auth token.
Path parameters
user_id
The ID of the user.
role_id
The ID of the custom (role_…) or preset (global_role_…) role.
Headers
X-Penny-As-Business
Act on behalf of another business that has granted you access. Requires the business:act_as permission.
Response
The updated user.
BusinessUser
A business user, as shown to clients through the client-facing API.
OR
CardholderUser
A cardholder user, as shown to clients through the client-facing API.
Errors
400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error