Access control endpoints allow you to review and manage user role assignments. Organization and environment roles are assigned separately. Furthermore, a user’s organizational role doesn't impact their assigned environment role, and vice versa. Learn about roles.
Generally, organization owners or admins can retrieve, assign, update, or remove role assignments. However, only organization owners can assign or remove organization roles specifically.
Remove environment role assignment
Remove a user's role within the indicated environment. This doesn't remove the user from the related organization.
A user isn't required to have an environment role, but without one, the user doesn't have access to the indicated environment. A user can be reassigned to an environment role later, if needed.
You must be an organization owner or admin to remove user roles.
cURL request example
Path Parameters
- environmentIdrequired, string
Identifies the specific environment that you're operating in or on behalf of.
Request Body Schema
- userobject
- idstring
Contains the unique identifier of the user.
- namestring
Contains the user's human-readable name.
Contains the information of the user to remove from the specified environment.
- metaobject
- versionstring
Lists the major and minor version number for the format of the returned payload. The payload format or shape may change between minor versions, like including additional or extended fields in later versions. We include the version data in each response so that you have the option to handle the signaled differences.
- payloadobject
Contains the payload with details about the requested environment memberships.
- successboolean
Displays the status of the request.