Home
API reference
Platform API reference
Platform API
Access control
Get environment role assignments

Get environment role assignments

get/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.

Get environment role assignments

Retrieve a list of environment roles and related user assignments within the environment indicated in the request.

You must be an organization owner or admin to view role assignments.

Request parameters

cURL request example

bash
1
curl 'https://api.redoxengine.com/platform/v1/environments/{environmentId}/role-assignment' \
2
--request GET \
3
--header 'Authorization: Bearer $API_TOKEN' \
4
--header 'accept: application/json'

Path Parameters

  • environmentId
    required, string

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

Response fields and example

Example payload generated from schema
1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "memberships": [
7
      {
8
        "environment": {
9
          "id": "string",
10
          "name": "string"
11
        },
12
        "role": {
13
          "id": "string",
14
          "name": "string"
15
        },
16
        "user": {
17
          "id": "string",
18
          "fullname": "string",
19
          "lowercaseEmail": "string"
20
        }
21
      }
22
    ]
23
  }
24
}
  • 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.

    • memberships
      Array of object

      Contains an array of memberships for an environment.

      • environment
        object
        • id
          string

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

        • name
          string

          Displays the human readable name of the environment.

      • role
        object
        • id
          string

          Displays the unique identifier of the role.

        • name
          string

          Displays the name of the role.

      • user
        object
        • id
          string

          Displays the unique identifier of the user.

        • fullname
          string

          Displays the full name of the user.

        • lowercaseEmail
          string

          Displays the email of the user in lowercase format.