Suspend or unsuspend a user in your Vultr organization. Temporarily revoke or reinstate a user's access to organizational resources through the IAM API.
Suspending a user in an organization temporarily disables their access to all resources, roles, and policies within that organization without removing them. This is useful when you need to revoke access temporarily, such as during an investigation or when a user is on extended leave. Unsuspending the user restores their previous access.
Suspending a user does not remove them from the organization or delete their account. All their role and policy assignments are preserved and become active again when the user is unsuspended.
This guide explains how to suspend and unsuspend a user in an organization using the Vultr API.
Send a GET request to the List Organizations endpoint to retrieve all organizations associated with your account.
Note the id of the organization in which you want to suspend the user.
Identify the user_id of the user you want to suspend. Follow the steps in How to List All Users in an Organization to retrieve user IDs.
Send a PUT request to the Suspend User endpoint to suspend the user. Replace {organization-id} with the organization id and {user-id} with the id of the user you want to suspend.
A successful suspension returns an HTTP 204 No Content response with no response body.
Send a GET request to the List Suspended Users endpoint to retrieve the suspended users list.
Verify that the suspended user appears in the list.
Send a GET request to the List Suspended Users endpoint to retrieve the list of suspended users in your organization.
Note the uuid of the user you want to unsuspend.
Send a PUT request to the Unsuspend User endpoint to restore the user's access. Replace {organization-id} with the organization id and {user-id} with the uuid of the suspended user.
A successful unsuspension returns an HTTP 204 No Content response with no response body.
Send a GET request to the List Suspended Users endpoint to retrieve the suspended users list.
Verify that the user no longer appears in the suspended users list.
0 Comments
Be the first to comment and share your perspective with the community.