Create a Security Role
{ createRole }
Adds a new security role to the system.
Method
/API2/access/createRole
Input Parameters
Name
roleData
Object Type
Description
Output Response
Successful Result Code
200
Response Type
Description of Response Type
Generic API response object with success or failure flag and related messages.
Notes
The added role is simply a shell. Use 'AddUserToRole' method to attach users to the role to make it effective.
Examples
Create new database user (JavaScript):
This example demonstrates how to create a new tenant, user and roles in Pyramid, when using database authentication.
The example uses API authentication driven from JavaScript. See Authentication APIs for alternatives.