List Roles
Returns a list of roles that can be assigned to users, either while inviting users using the POST /users API, or by updating the user using the PATCH /users/{user_id} API.
Responses
- 200
- default
Success
- application/api.clumio.roles=v1+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": [
{
"_etag": "string",
"_links": {
"_self": {
"href": "string",
"templated": true,
"type": "string"
}
},
"description": "string",
"id": "string",
"name": "string",
"permissions": [
{
"description": "string",
"id": "string",
"name": "string"
}
],
"user_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"
}
},
"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 /roles
Authorization
Request
Request
curl -L -X GET 'https://us-west-2.api.clumio.com/roles' \
-H 'Accept: application/api.clumio.roles=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/roles' \
-H 'Accept: application/api.clumio.roles=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/roles' \
-H 'Accept: application/api.clumio.roles=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/roles' \
-H 'Accept: application/api.clumio.roles=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/roles' \
-H 'Accept: application/api.clumio.roles=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/roles' \
-H 'Accept: application/api.clumio.roles=v1+json' \
-H 'Authorization: Bearer <TOKEN>'
curl -L -X GET 'https://us-west-2.api.clumio.com/roles' \
-H 'Accept: application/api.clumio.roles=v1+json' \
-H 'Authorization: Bearer <TOKEN>'