Create User Role

Create User Role

Create a user role

Request
URI
POST
https://{api_host}/suite-api/api/auth/roles
COPY
Request Body

The UserRole object

user-role of type(s) application/json
Required

Show optional properties

{
    "name": "string"
}
"{\n  \"name\" : \"API Administrator\",\n  \"description\" : \"Role to allow administrative access to all Suite API methods\",\n  \"privilege-keys\" : [ \"ManageAlerts\", \"ManageAlarms\", \"ManageNotificationPlugins\" ],\n  \"system-created\" : false\n}"
string
name
Required

The name of the role.

string
description
Optional

The description for the role.

string
displayName
Optional

A role name suitable for display.

array of string
privilege-keys
Optional

The collection of privilege keys

boolean
system-created
Optional

True if this role was created by the system

array of object
links
Optional

Represents a HTTP 'link' element.
It is implicit that all the link tags support http 'GET' method.

Authentication
This operation uses the following authentication methods.
Responses
201

The created UserRole

Returns user-role of type(s) application/json 
"{\n  \"name\" : \"API Administrator\",\n  \"description\" : \"Role to allow administrative access to all Suite API methods\",\n  \"privilege-keys\" : [ \"ManageAlerts\", \"ManageAlarms\", \"ManageNotificationPlugins\" ],\n  \"system-created\" : false\n}"
string
name
Required

The name of the role.

string
description
Optional

The description for the role.

string
displayName
Optional

A role name suitable for display.

array of string
privilege-keys
Optional

The collection of privilege keys

boolean
system-created
Optional

True if this role was created by the system

array of object
links
Optional

Represents a HTTP 'link' element.
It is implicit that all the link tags support http 'GET' method.


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"name:"string"}' https://{api_host}/suite-api/api/auth/roles
On This Page
Auth Operations
GET
Get Users
PUT
Modify User
POST
Create User
DELETE
Delete Users
PUT
Assign Traversal Spec To User
Deprecated
GET
Get Assigned Role Permissions For User
PUT
Assign Role Permission To User
PUT
Change Password
GET
Get User Groups
PUT
Modify User Group
POST
Create User Group
DELETE
Delete User Groups
PUT
Assign Traversal Spec To User Group
Deprecated
GET
Get Assigned Role Permissions For User Group
PUT
Assign Role Permission To User Group
GET
Get Auth Sources
PUT
Update Auth Source
POST
Add Auth Source
PATCH
Patch Auth Source With Certificate Details
PUT
Synchronize User Groups
GET
Get All Object Scopes
PUT
Modify Scope
POST
Create Scope
DELETE
Delete Scopes
GET
Get Roles
PUT
Update User Role
POST
Create User Role
GET
Get Role Privileges
PUT
Set Role Privileges
POST
Add Role Privileges
DELETE
Remove Role Privileges
POST
Release Token
POST
Acquire Token
POST
Import Users
POST
Search Users For Auth Source
POST
Search User Groups For Auth Source
POST
Test Auth Source
PATCH
Patch Test Auth Source
GET
Get User
DELETE
Delete User
GET
Get User Group
DELETE
Delete User Group
GET
Get Traversal Specs
GET
Get Auth Source Types
GET
Get Auth Source Type
GET
Get Auth Source
DELETE
Delete Auth Source
GET
Get Scope
GET
Get Role By Name
DELETE
Delete User Role
GET
Get Available Privileges
GET
Get Available Privilege Groups
GET
Get Current User
GET
Get Current User Role Privileges
GET
Get Assigned Role Permissions For Current User
DELETE
Unassigned Role Permission From User
DELETE
Unassigned Role Permission From User Group