List users
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:
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. 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.
- 200
- default
Success
- application/api.clumio.users=v2+json
- Schema
- Example (from schema)
Schema
_embedded object
_links object
- 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": {
"read-role": [
{
"description": "string",
"id": "string",
"name": "string",
"permissions": [
{
"description": "string",
"id": "string",
"name": "string"
}
],
"user_count": 0
}
]
},
"_etag": "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"
}
},
"access_control_configuration": [
{
"organizational_unit_ids": [
"string"
],
"role_id": "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[]
{
"errors": [
{
"error_code": 0,
"error_message": "string"
}
]
}
GET /users
Authorization
Request
Request
curl -L -X GET 'https://us-west-2.api.clumio.com/users' \
-H 'Accept: application/api.clumio.users=v2+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/users' \
-H 'Accept: application/api.clumio.users=v2+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/users' \
-H 'Accept: application/api.clumio.users=v2+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/users' \
-H 'Accept: application/api.clumio.users=v2+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/users' \
-H 'Accept: application/api.clumio.users=v2+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/users' \
-H 'Accept: application/api.clumio.users=v2+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/users' \
-H 'Accept: application/api.clumio.users=v2+json' \
-H 'Authorization: Bearer <TOKEN>'