Retrieve a Role

Returns a representation of the specified role.

Path Parameters

• role_id string required

  Retrieves the role with the specified ID.

Responses

• 200
• default

---

Success

application/api.clumio.roles=v1+json

• Schema
• Example (from schema)

---

Schema

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

{
  "_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
}

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"
    }
  ]
}

GET /roles/:role_id    

Authorization

Request

Click Edit to configure Base URL

https://us-west-2.api.clumio.com

Bearer Token

role_id — path required

curl -L -X GET 'https://us-west-2.api.clumio.com/roles/:role_id' \
-H 'Accept: application/api.clumio.roles=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/roles/:role_id' \
-H 'Accept: application/api.clumio.roles=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/roles/:role_id' \
-H 'Accept: application/api.clumio.roles=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/roles/:role_id' \
-H 'Accept: application/api.clumio.roles=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/roles/:role_id' \
-H 'Accept: application/api.clumio.roles=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/roles/:role_id' \
-H 'Accept: application/api.clumio.roles=v1+json' \
-H 'Authorization: Bearer <TOKEN>'

curl -L -X GET 'https://us-west-2.api.clumio.com/roles/:role_id' \
-H 'Accept: application/api.clumio.roles=v1+json' \
-H 'Authorization: Bearer <TOKEN>'