Get role

GET 
/account/:accountId/role

Gets information about the given role.

Request

Path Parameters

accountId stringrequired
The ID of the cloud account.
Example: account-100001

Header Parameters

x-maxone-role-id string

Responses

200

OK

application/json

Schema

Schema

code int32

The response code.

data

object

The role information.

createTimestamp int64

The creation timestamp of the role.

description string

The description of the role.

id stringrequired

The ID of the role.

isSystem boolean

Whether the role is a system role.

name string

The name of the role.

privilegeList

object[]

The privileges of the role.

Array [

description string

The description of the privilege.

id string

The ID of the privilege.

name string

The name of the privilege.

sortValue int32

The sort order.

]

msg string

The response message.

Example (from schema)

{
  "code": 0,
  "data": {
    "createTimestamp": 1685510869834,
    "description": "granted full privileges to use, manage, and control data warehouse units",
    "id": "role-100001",
    "isSystem": true,
    "name": "SYSTEMADMIN",
    "privilegeList": [
      {
        "description": "create account",
        "id": "100001",
        "name": "CREATE_ACCOUNT",
        "sortValue": 1
      }
    ]
  },
  "msg": "string"
}

Loading...