Documentation | Users › Assignments › Assign Role To Existing User

Users

users

Methods

List Client S Users -> OffsetPage<{ id, email, activated, 2 more... }>

get/v1/users

List client's users

List Available Roles -> { count, results }

get/v1/users/roles

List available roles

Users

Assignments

users.assignments

Methods

Assign Role To Existing User -> { id, role, user_id, 2 more... }

post/v1/users/assignments

Assign role to existing user

Response fields

id: number

Assignment ID

role: string

User role

user_id: number

User ID

client_id: number

Optional

Client ID. Required if project_id is specified

project_id: number

Optional

Project ID

Request example

curl https://api.gcore.com/cloud/v1/users/assignments \
    -H 'Content-Type: application/json' \
    -H "APIKey: $CLOUD_API_API_KEY" \
    -d '{
      "role": "ClientAdministrator",
      "user_id": 777,
      "client_id": 8,
      "project_id": 0
    }'

200Example

{
  "id": 12,
  "role": "ClientAdministrator",
  "user_id": 777,
  "client_id": 8,
  "project_id": 0
}

Delete Role Assignment ->

HTTPResponse

delete/v1/users/assignments/{assignment_id}

Delete role assignment

List Assignments -> OffsetPage<{ id, role, user_id, 2 more... }>

get/v1/users/assignments

List assignments

Modify Role Assignment To Existing User ->

HTTPResponse

patch/v1/users/assignments/{assignment_id}

Modify role assignment to existing user

Domain types

HTTPResponse = { ok, error }

RequestAssignment = { role, user_id, client_id, 1 more... }