Add a user to a Role

{ addUserToRole }

Add a user to an existing role.

Method

/API2/access/addUserToRole
  • 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

    addUserRoleData

    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

    New roles are empty until users are added to it (see 'createRole'). When using Active Directory as the authentication provider, roles can be comprised of either users or AD groups.

    Examples