Create a Security Role
{ createRole }
Adds a new security role to the system.
Method
/API3/access/createRole
- Enterprise Admin
Input Parameters
Name
roleData
Object Type
Description
The role creation object contains meta-data for the role.
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
Code Snippets
Use the Authentication API methods to generate an access 'key' or 'token' for use in code as shown below.
TypeScript
Curl
Java
C#
Python
PHP