Sign in

v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB
Groups

Assign User To Group

Assign a user to a group - This user will inherit the group's roles.

put/v2/schema/{proj_id}/{env_id}/groups/{group_instance_key}/users/{user_id}

Path parameters

user_idstring required

Either the unique id of the user, or the URL-friendly key of the user (i.e: the "slug").

Either the unique id of the user, or the URL-friendly key of the user (i.e: the "slug").

proj_idstring required

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

Either the unique id of the project, or the URL-friendly key of the project (i.e: the "slug").

env_idstring required

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

Either the unique id of the environment, or the URL-friendly key of the environment (i.e: the "slug").

group_instance_keystring required

Either the unique id of the resource instance, or the URL-friendly key of the resource instance (i.e: the "slug").

Either the unique id of the resource instance, or the URL-friendly key of the resource instance (i.e: the "slug").

Request body

tenantstring required

The tenant key or id that the user belongs to.

Example request

{
  "tenant": "business"
}

Response

Successful Response

assigned_rolesstring[]

List of roles that are assigned to this group

usersstring[]

List of user ids that are assigned to this group

group_resource_type_keystring

The key of the resource type that the group belongs to.

group_instance_keystring required

Either the unique id of the resource instance that that the group belongs to, or the URL-friendly key of the <resource_key:resource_instance_key> (i.e: file:my_file)

group_tenantstring required

The tenant key or id that the group belongs to.

Example response

{
  "group_resource_type_key": "company",
  "group_instance_key": "Acme",
  "group_tenant": "business",
  "assigned_roles": [
    "rnd:backend#admin",
    "marketing:social_media#editor"
  ],
  "users": [
    "user_1",
    "user_2"
  ]
}