Home
API reference
Platform API reference
Platform API
Access control
Assign environment role

Assign environment role

post/v1/environments/{environmentId}/role-assignment
Page View

Access control endpoints allow you to review and manage user role assignments. Organization and environment roles are managed 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.

Assign environment role

Assign a user to the specified environment role.

A user may only have one role per environment, but if they're part of multiple environments, they can have different roles assignments in different environments.

You must be an organization owner or admin to assign user roles.

Request parameters and payload

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/environments/{environmentId}/role-assignment' \
2
--request POST \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json' \
5
--header 'content-type: application/json' \
6
--data '{
7
  "role": {
8
    "id": "string",
9
    "name": "string"
10
  },
11
  "user": {
12
    "id": "string",
13
    "name": "string"
14
  }
15
}'

Path Parameters

  • environmentId
    required, string

    Identifies the specific environment that you're operating in or on behalf of.

Request Body Schema

    Contains the user and the assigned role to add to the specified environment.

  • role
    object
    • id
      string

      Contains the uuid of the role permission.

    • name
      string

      Contains the role's human-readable name.

  • user
    object
    • id
      string

      Contains the unique identifier of the user.

    • name
      string

      Contains the user's human-readable name.

Response fields and example

Example payload generated from schema
1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "success": true
7
  }
8
}
  • meta
    object
    • version
      string

      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.

  • payload
    object

    Contains the payload with details about the requested environment memberships.

    • success
      boolean

      Displays the status of the request.