Add Role

Add a new role to the system.

URL: /role

Type: POST

Parameter

Param Type Name Description Field Type
Header sessionId ** Session Id received after login string
Query Gwkey Tenant Key. Needed only in case of multitenant installations string
Query gwsource** Source from which the request is triggered (for example, web, external) String
Payload name** Name of the role. String
Payload description Description of the role String

** - Mandatory value

Possible Response Message and Code

HTTP Code Description Response Message
400 Bad request Role name cannot be null, empty or whitespace alone
201 Created Role added successfully
409 Conflict Role with the given name already exists