Assign environment to user

Users are only able to perform management actions in environments they have access to, and assigning an environment to a user gives them this access. However, access to an environment is NOT required to access a specific tenant in that environment.

Analytics Events

ADMIN_USER_ENVIRONMENT_ASSIGN_STARTADMIN_USER_ENVIRONMENT_ASSIGN_SUCCESSADMIN_USER_ENVIRONMENT_ASSIGN_FAIL

POST/admin/v1/users/{userId}/environments/assign

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

userIdstring

Identifier of user to assign the environment to.

Formatuuid

Request Body

environmentIdstring

Identifier of the environment to assign the user to.

Response Body

curl -X POST "https://manage.mattr.global/admin/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/environments/assign" \
  -H "Content-Type: application/json" \
  -d '{
    "environmentId": "84ca6f53-5405-4413-a6ad-848b781807e7"
  }'

curl -X POST "https://manage.mattr.global/admin/v1/users/497f6eca-6276-4993-bfeb-53cbbbba6f08/environments/assign" \  -H "Content-Type: application/json" \  -d '{    "environmentId": "84ca6f53-5405-4413-a6ad-848b781807e7"  }'

Empty

{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}