Documentation | Users › List Client S Users

Users

users

Methods

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

get/v1/users

List client's users

Parameters

client_id: number

Optional

Client ID. Must be used for users without client_id in jwt

limit: number

Optional

Limit the number of returned users. Falls back to default if not specified. Limited by max limit value

offset: number

Optional

Offset value is used to exclude the first set of records from the result

user_id: number

Optional

User ID. Specific user search

Response fields

count: number

(minimum: 0)

Number of objects

results: Array<{ id, email, activated, 2 more... }>

Objects

Request example

curl https://api.gcore.com/cloud/v1/users \
    -H "APIKey: $CLOUD_API_API_KEY"

200Example

{
  "count": 1,
  "results": [
    {
      "id": 123,
      "email": "[email protected]",
      "activated": true,
      "is_admin": true,
      "name": "Jhon"
    }
  ]
}

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

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... }