Sign in

v4

latestOpenAPI 3.1.02026-08-02261331761.5 KB
Users

Assign Role To User

Assigns a role to the user within the tenant.

The tenant defines the scope of the assignment. In other words, the role is effective only within the tenant.

post/v2/facts/{proj_id}/{env_id}/users/{user_id}/roles

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").

Request body

rolestring required

the role that will be assigned (accepts either the role id or the role key)

tenantstring

the tenant the role is associated with (accepts either the tenant id or the tenant key)

resource_instancestring

the resource instance the role is associated with (accepts either the resource instance id or key using this format resource_type:resource_instance)The resource instance will be implicitly created if the tenant parameter is specified and the resource instance does not exist.

Example request

{
  "role": "admin",
  "tenant": "stripe-inc"
}

Response

Successful Response

idstring uuid required

Unique id of the role assignment

userstring required

the user the role is assigned to

rolestring required

the role that is assigned

tenantstring

the tenant the role is associated with

resource_instancestring

the resource instance the role is associated with

resource_instance_idstring uuid

Unique id of the resource instance

user_idstring uuid required

Unique id of the user

role_idstring uuid required

Unique id of the role

tenant_idstring uuid required

Unique id of the tenant

organization_idstring uuid required

Unique id of the organization that the role assignment belongs to.

project_idstring uuid required

Unique id of the project that the role assignment belongs to.

environment_idstring uuid required

Unique id of the environment that the role assignment belongs to.

created_atstring date-time required

Date and time when the role assignment was created (ISO_8601 format).

Example response

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "user": "jane@coolcompany.com",
  "role": "admin",
  "tenant": "stripe-inc",
  "user_id": "7c60d51f-b44e-4682-87d6-449835ea4d11",
  "role_id": "405d8375-3514-403b-8c43-83ae74cfe022",
  "tenant_id": "40ef0e48-a11f-4963-a229-e396c9f7e733",
  "organization_id": "7c60d51f-b44e-4682-87d6-449835ea4de6",
  "project_id": "405d8375-3514-403b-8c43-83ae74cfe0e9",
  "environment_id": "40ef0e48-a11f-4963-a229-e396c9f7e7c4",
  "created_at": "2019-08-24T14:15:22Z"
}