Create a Security Role

{ createRole }

Adds a new security role to the system.

Method

/API2/access/createRole
  • API Section: /API2/access
  • API Version: 2.0
  • From Release: 2018.5
  • Can be used by Enterprise Admin users only
  • REST API only via POST actions.
  • Input Parameters

    Name

    roleData

    Object Type

    Description

    An object for defining which user is attached to a 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