Get Role

Get Role

Retrieve an existing role.

Request
URI
GET
https://{api_host}/https://{{host}}:{{port}}/api/v5/rbac/roles/{roleName}
COPY
Path Parameters
string
roleName
Required

Role name.

Responses
200

Role management.

Returns Role of type(s) */* 
{
    "id": "string",
    "name": "string",
    "permissions": [
        {
            "name": "string"
        }
    ]
}
string
id
Optional

id

string
name
Required

name

array of Permission
permissions
Required

permissions


401

Unauthorized access

Returns Role of type(s) */* 
{
    "id": "string",
    "name": "string",
    "permissions": [
        {
            "name": "string"
        }
    ]
}
string
id
Optional

id

string
name
Required

name

array of Permission
permissions
Required

permissions


404

Such resource was not found.

Returns Role of type(s) */* 
{
    "id": "string",
    "name": "string",
    "permissions": [
        {
            "name": "string"
        }
    ]
}
string
id
Optional

id

string
name
Required

name

array of Permission
permissions
Required

permissions


504

Connection timed out.

Returns Role of type(s) */* 
{
    "id": "string",
    "name": "string",
    "permissions": [
        {
            "name": "string"
        }
    ]
}
string
id
Optional

id

string
name
Required

name

array of Permission
permissions
Required

permissions


On This Page
Rbac Operations
POST
Add Ad Settings
POST
Add Ldap Settings
POST
Add New Group
POST
Add New User
POST
Create Role
DELETE
Delete Group For Instance
DELETE
Delete Ldap Settings
DELETE
Delete Role
DELETE
Delete User
GET
Get All Groups
GET
Get All Ldap Settings
GET
Get All Users
GET
Get All Users Per Instance
GET
Get Group
GET
Get Ldap Setting
GET
Get Ldap Settings
GET
Get Role
GET
Get Roles
GET
Get User
PUT
Modify Group Role
PUT
Modify User Role
POST
Query User
POST
Test Connection
PUT
Update Ldap Settings
PUT
Update Role