List users

deprecated

This endpoint has been deprecated and may be removed in future versions of the API.

Returns a list of Clumio users.

Query Parameters

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.
For more information about filtering, refer to the Filtering section of this guide.

Field	Filter Condition	Description
name	$contains	A case insensitive substring of the name of the user.

Responses

200
default

Success

application/api.clumio.users=v1+json

Schema
Example (from schema)

Schema

_embedded object
Embedded responses related to the resource.
items object[]
A collection of requested items.
_embedded object
Embedded responses related to the resource.
description string
A description of the role.
name string
Unique name assigned to the role.
_links object
URLs to pages related to the resource.
_self object
The HATEOAS link to this resource.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
delete-user object
A resource-specific HATEOAS link.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
update-user object
A resource-specific HATEOAS link.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
assigned_organizational_unit_ids string[]
The list of organizational unit IDs assigned to the user. This attribute will be available when reading a single user and not when listing users.
assigned_role string
Assigned Role for the user.
email 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.
id 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.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
_last object
The HATEOAS link to the last page of results.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
_next object
The HATEOAS link to the next page of results.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
_prev object
The HATEOAS link to the previous page of results.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
_self object
The HATEOAS link to this resource.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
create-user object
A resource-specific HATEOAS link.
href string
The URI for the referenced operation.
templated boolean
Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.
type string
The HTTP method to be used with the "href" link for the referenced operation.
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.

{
  "_embedded": {
    "items": [
      {
        "_embedded": {
          "description": "string",
          "name": "string"
        },
        "_links": {
          "_self": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "delete-user": {
            "href": "string",
            "templated": true,
            "type": "string"
          },
          "update-user": {
            "href": "string",
            "templated": true,
            "type": "string"
          }
        },
        "assigned_organizational_unit_ids": [
          "string"
        ],
        "assigned_role": "string",
        "email": "string",
        "full_name": "string",
        "id": "string",
        "inviter": "string",
        "is_confirmed": true,
        "is_enabled": true,
        "last_activity_timestamp": "string",
        "organizational_unit_count": 0
      }
    ]
  },
  "_links": {
    "_first": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_last": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_next": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_prev": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "_self": {
      "href": "string",
      "templated": true,
      "type": "string"
    },
    "create-user": {
      "href": "string",
      "templated": true,
      "type": "string"
    }
  },
  "current_count": 0,
  "filter_applied": "string",
  "limit": 0,
  "start": "string",
  "total_count": 0,
  "total_pages_count": 0
}

Error

application/json

Schema
Example (from schema)

Schema

errors object[]
A list of errors encountered during runtime.
error_code uint32
error_message string
The reason for the error.

{
  "errors": [
    {
      "error_code": 0,
      "error_message": "string"
    }
  ]
}

List users​

List users