Index

Get all roles {#get-all-roles}

GET /v1/roles

Get all roles' details.

Permissions

Request {#get-all-request}

Example HTTP request

GET /v1/roles

Headers

Response {#get-all-response}

Returns a JSON array of [role objects]({{< relref "/operate/rs/references/rest-api/objects/role" >}}).

Example JSON body

[
    {
        "uid": 1,
        "name": "Admin",
        "management": "admin"
    },
    {
        "uid": 2,
        "name": "Cluster Member",
        "management": "cluster_member"
    },
    {
        "uid": 3,
        "name": "Cluster Viewer",
        "management": "cluster_viewer"
    },
    {
        "uid": 4,
        "name": "DB Member",
        "management": "db_member"
    },
    {
        "uid": 5,
        "name": "DB Viewer",
        "management": "db_viewer"
    },
    {
        "uid": 6,
        "name": "None",
        "management": "none"
    },
    {
        "uid": 17,
        "name": "DBA",
        "management": "admin"
    }
]

Status codes {#get-all-status-codes}

Get role

GET /v1/roles/{int: uid}

Get the details of a single role.

Permissions

Request {#get-request}

Example HTTP request

GET /v1/roles/1

Headers

URL parameters

Response {#get-response}

Returns a [role object]({{< relref "/operate/rs/references/rest-api/objects/role" >}}).

Example JSON body

{
     "uid": 17,
     "name": "DBA",
     "management": "admin"
}

Status codes {#get-status-codes}

Update role {#put-role}

PUT /v1/roles/{int: uid}

Update an existing role's details.

Permissions

Request {#put-request}

Example HTTP request

PUT /v1/roles/17

Example JSON body

{
     "management": "cluster_member"
}

Headers

Query parameters

URL parameters

Body

Include a [role object]({{< relref "/operate/rs/references/rest-api/objects/role" >}}) with updated fields in the request body.

Response {#put-response}

Returns a [role object]({{< relref "/operate/rs/references/rest-api/objects/role" >}}) with the updated fields.

Example JSON body

{
     "uid": 17,
     "name": "DBA",
     "management": "cluster_member"
}

Error codes {#put-error-codes}

Possible error_code values:

Status codes {#put-status-codes}

Create role {#post-role}

POST /v1/roles

Create a new role.

Permissions

Request {#post-request}

Example HTTP request

POST /v1/roles

Example JSON body

{
     "name": "DBA",
     "management": "admin"
}

Headers

Query parameters

Body

Include a [role object]({{< relref "/operate/rs/references/rest-api/objects/role" >}}) in the request body.

Response {#post-response}

Returns the newly created [role object]({{< relref "/operate/rs/references/rest-api/objects/role" >}}).

Example JSON body

{
     "uid": 17,
     "name": "DBA",
     "management": "admin"
}

Error codes {#post-error-codes}

Possible error_codevalues:

Status codes {#post-status-codes}

Examples

cURL

curl -k -u "[username]:[password]" -X POST \
     -H 'Content-Type: application/json' \
     -d '{ "name": "DBA", "management": "admin" }' \
     https://[host][:port]/v1/roles

Python

import requests
import json

url = "https://[host][:port]/v1/roles"

headers = {
  'Content-Type': 'application/json'
}

payload = json.dumps({
    "name": "DBA",
    "management": "admin"
})
auth=("[username]", "[password]")

response = requests.request("POST", url,
           auth=auth, headers=headers, payload=payload, verify=False)

print(response.text)

Delete role {#delete-role}

DELETE /v1/roles/{int: uid}

Delete a role object.

Permissions

Request {#delete-request}

Example HTTP request

DELETE /v1/roles/1

Headers

URL parameters

Response {#delete-response}

Returns a status code to indicate role deletion success or failure.

Status codes {#delete-status-codes}