List users

get https://{region}.api.clumio.com/users

Returns a list of Clumio users.

time	status	user agent
Retrieving recent requests…

Loading…

Query Params

limit

int64

Limits the size of the response on each page to the specified number of items.

start

string

Sets the page number used to browse the collection. Pages are indexed starting from 1 (i.e., ?start=1).

filter

string

Narrows down the results to only the items that satisfy the filter criteria. The following table lists the supported filter fields for this resource and the filter conditions that can be applied on those fields:

Field	Filter Condition	Description
name	$contains	A case insensitive substring of the name of the user.
role_id	$eq	The Clumio-assigned ID of the role assigned to a user.
organizational_unit_id	$eq	The Clumio-assigned ID of the organizational unit to which a user is assigned.

For more information about filtering, refer to the Filtering section of this guide.

Responses

Response body

object

_embedded

object

Embedded responses related to the resource.

items

array of objects

A collection of requested items.

items

object

_embedded

object

Embedded responses related to the resource.

_etag

string

ETag value

_links

object

URLs to pages related to the resource.

access_control_configuration

array of objects

The list of organizational unit IDs along with role assigned to the user.

access_control_configuration

object

organizational_unit_ids

array of strings

required

The Clumio-assigned IDs of the organizational units assigned to the user. Use the GET /organizational-units endpoint to fetch valid values.

organizational_unit_ids*

role_id

string

The Clumio-assigned ID of the role assigned to the user. Use the GET /roles endpoint to fetch valid values.

string

The email address of the Clumio user.

full_name

string

The first and last name of the Clumio user. The name appears in the User Management screen and is used to identify the user.

string

The Clumio-assigned ID of the Clumio user.

inviter

string

The ID number of the user who sent the email invitation.

is_confirmed

boolean

Determines whether the user has activated their Clumio account. If true, the user has activated the account.

is_enabled

boolean

Determines whether the user is enabled (in "Activated" or "Invited" status) in Clumio.
If true, the user is in "Activated" or "Invited" status in Clumio. Users in "Activated" status can log in to Clumio. Users in "Invited" status have been invited to log in to Clumio via an email invitation and the invitation is pending acceptance from the user. If false, the user has been manually suspended and cannot log in to Clumio until another Clumio user reactivates the account.

last_activity_timestamp

string

The timestamp of when the user was last active in the Clumio system. Represented in RFC-3339 format.

organizational_unit_count

int64

The number of organizational units accessible to the user.

_links

object

URLs to pages related to the resource.

_first

object

The HATEOAS link to the first page of results.

_last

object

The HATEOAS link to the last page of results.

_next

object

The HATEOAS link to the next page of results.

_prev

object

The HATEOAS link to the previous page of results.

_self

object

The HATEOAS link to this resource.

create-user

object

A resource-specific HATEOAS link.

current_count

int64

The number of items listed on the current page.

filter_applied

string

The filter used in the request. The filter includes both manually-specified and system-generated filters.

limit

int64

The maximum number of items displayed per page in the response.

start

string

The page number used to get this response. Pages are indexed starting from 1 (i.e., "start": "1").

total_count

int64

The total number of items, summed across all pages.

total_pages_count

int64

The total number of pages of results.

Language

Credentials

Bearer

JWT

URL


xxxxxxxxxx
1
curl --request GET \
2
     --url https://us-west-2.api.clumio.com/users \
3
     --header 'accept: application/api.clumio.users=v2+json'


xxxxxxxxxx
97
}
1
{
2
  "_embedded": {
3
    "items": [
4
      {
5
        "_embedded": {
6
          "read-role": [
7
            {
8
              "description": "string",
9
              "id": "string",
10
              "name": "string",
11
              "permissions": [
12
                {
13
                  "description": "string",
14
                  "id": "string",
15
                  "name": "string"
16
                }
17
              ],
18
              "user_count": 0
19
            }
20
          ]
21
        },
22
        "_etag": "string",
23
        "_links": {
24
          "_self": {
25
            "href": "string",

200200 HTTP success response

defaultError