Get users

Get a list of users.

Pass a value for the limit parameter in your request if you want retrieve a paginated result. Otherwise API returns a list with all users without pagination.

GET /iam/users

Python

Python

import os
from gcore import Gcore

client = Gcore(
    api_key=os.environ.get("GCORE_API_KEY"),  # This is the default and can be omitted
)
page = client.iam.users.list()
page = page.results[0]
print(page.id)

200

{
  "count": 123,
  "results": [
    {
      "id": 123,
      "email": "[e-mail]",
      "name": "<string>",
      "phone": "<string>",
      "company": "<string>",
      "reseller": 123,
      "client": 123,
      "deleted": true,
      "groups": [
        {
          "id": 1,
          "name": "Administrators"
        }
      ],
      "activated": true,
      "sso_auth": true,
      "two_fa": true,
      "auth_types": [],
      "is_active": true,
      "client_and_roles": [
        {
          "client_id": 123,
          "client_company_name": "<string>",
          "user_roles": [
            "2"
          ],
          "user_id": 123
        }
      ]
    }
  ],
  "next": "/users?offset=20&limit=10",
  "previous": "/users?offset=10&limit=10"
}

Authorizations

Authorization · string · header · required

API key for authentication. Make sure to include the word apikey, followed by a single space and then your token. Example: apikey 1234$abcdef

Query Parameters

limit · integer

The maximum number of items.

offset · integer

Offset relative to the beginning of list.

Response

200

application/json

OK

count · integer · required

Total number of users

results · object[] · required

Show child attributes

next · string

URL to the next users slice

Example:

"/users?offset=20&limit=10"

previous · string

URL to the previous users slice

Example:

"/users?offset=10&limit=10"