Update group role assignment

put/v1/organizations/{organizationId}/groups/{groupId}/role-assignment

MCP ToolReplace

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 or add an organization role

We don't currently support assigning an organization role (i.e., adding a user to an organization) in the Redox dashboard. Learn how to add a user.

Update group role assignment

Coming soon

This feature is coming soon, so you won’t see it live in a production environment just yet. Stay tuned for the release!

Set a role the group grants.

Without environment, this sets the group’s organization role.
With environment, it sets the group’s role in that environment.

A group has at most one organization role and one role per environment, so this replaces any existing role there.

You can’t give a group an organization role with permissions you don’t hold. Members immediately gain the new access level.

Request parameters and payload

cURL request example

bash

1
curl 'https://api.redoxengine.com/platform/v1/organizations/{organizationId}/groups/{groupId}/role-assignment' \
2
--request PUT \
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
  },
10
  "environment": {
11
    "id": "string"
12
  }
13
}'

Path Parameters

organizationId
required, string
Identifies the Redox organization that you're operating in or on behalf of.
groupId
required, string
Contains the unique identifier of the group.

Request Body Schema

Contains the role to grant. Omit environment, or set it to null, for an organization role assignment.

role
required, object
- id
  required, string
  Contains the unique identifier of the role.
environment
nullable, object
- id
  required, string
  Identifies the environment the role applies to.

Response fields and example

Example payload generated from schema

1
{
2
  "meta": {
3
    "version": "1.0.0"
4
  },
5
  "payload": {
6
    "assignment": {
7
      "id": "string",
8
      "group": "string",
9
      "role": "string",
10
      "environment": "string"
11
    }
12
  }
13
}

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
- assignment
  object
  Contains the stored organization or environment role assignment.
  id
  string
  Contains the unique identifier of the role assignment itself, not of the role.
  group
  string
  Contains the unique identifier of the group.
  role
  string
  Contains the unique identifier of the assigned role, such as Admin or Engineer.
  environment
  nullable, string
  Contains the unique identifier of the environment, or null if describing an organization role assignment.

FHIR® is a registered trademark of Health Level Seven International (HL7) and is used with the permission of HL7. Use of this trademark does not constitute an endorsement of products/services by HL7®.