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

Embedded responses related to the resource.

items object[]

A collection of requested items.

_etag string

ETag value

_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.

description string

A description of the role.

id string

The Clumio-assigned ID of the role.

name string

Unique name assigned to the role.

permissions object[]

Permissions contained in the role.

description string

Description of the permission.

id string

The Clumio-assigned ID of the permission.

name string

Name of the permission. The following table lists the supported permissions for a role:

Permission Name	Full/Partial Applicable
Policy Management	Yes
Data Source Management	Yes
Perform Backup (Scheduled or On-demand)	Yes
Regular Restore	No
Redirected Granular Restore (things like GRR & content download)	Yes
Dashboards & Reports	Yes
Some Admin Functions (User mgmt, SSO/MFA, IP Allow, Password expiry, OU, KMS)	No
Other Admin Functions (API Tokens, Tasks, Alerts and Audit Logs)	Yes

user_count int64

Number of users to whom the role has been assigned.

_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.
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[]
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 Roles​

List Roles