user-role

user-role
user-role

Represents a role object in the system.

JSON Example 
{
    "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

Property Of
Parameter To
Returned By