Get Role By Name Using GET

Get Role By Name Using GET

Look up a role with the given name

Request
URI
GET
https://{api_host}/api/auth/roles/{roleName}
COPY
Path Parameters
string
roleName
Required

The name of the role.

Authentication
This operation uses the following authentication methods.
Responses
200

The application role object

Returns user-role of type(s) application/json 
{
    "description": "string",
    "displayName": "string",
    "links": [
        {
            "description": "string",
            "href": "string",
            "name": "string",
            "rel": "string"
        }
    ],
    "name": "string",
    "privilege-keys": [
        "string"
    ],
    "system-created": false
}
string
description
Optional

The description for the role.

string
displayName
Optional

A role name suitable for display.

array of link
links
Optional

links

string
name
Required

The name of the role.

array of string
privilege-keys
Optional

The collection of privilege keys

boolean
system-created
Optional

True if this role was created by the system


On This Page
Auth Operations
POST
Add Role Privileges Using POST
PUT
Assign Role Permission To User Group Using PUT
PUT
Assign Role Permission To User Using PUT
POST
Create Scope Using POST
POST
Create User Group Using POST
POST
Create User Role Using POST
DELETE
Delete Scopes Using DELETE
DELETE
Delete User Groups Using DELETE
DELETE
Delete User Group Using DELETE
DELETE
Delete User Role Using DELETE
GET
Get All Object Scopes Using GET
GET
Get Assigned Role Permissions For Current User Using GET
GET
Get Assigned Role Permissions For User Group Using GET
GET
Get Assigned Role Permissions For User Using GET
GET
Get Auth Sources Using GET
GET
Get Auth Source Types Using GET
GET
Get Auth Source Type Using GET
GET
Get Auth Source Using GET
GET
Get Available Privilege Groups Using GET
GET
Get Available Privileges Using GET
GET
Get Current User Role Privileges Using GET
GET
Get Current User Using GET
GET
Get Role By Name Using GET
GET
Get Role Privileges Using GET
GET
Get Roles Using GET
GET
Get Scope Using GET
GET
Get Traversal Specs Using GET
GET
Get User Groups Using GET
GET
Get User Group Using GET
GET
Get Users Using GET
GET
Get User Using GET
PUT
Modify Scope Using PUT
PUT
Modify User Group Using PUT
PUT
Modify User Using PUT
DELETE
Remove Role Privileges Using DELETE
PUT
Set Role Privileges Using PUT
PUT
Synchronize User Groups Using PUT
DELETE
Unassigned Role Permission From User Group Using DELETE
DELETE
Unassigned Role Permission From User Using DELETE
PUT
Update User Role Using PUT