Get all Users in a Role

{ getUsersByRole }

Returns a list of users assigned to a given role.

Method

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

    roleId

    Type

    string

    Description

    The system role ID

    Output Response

    Successful Result Code

    200

    Response List Type

    Description of Response Type

    User response object with details of the users found in the system.. Note that the response is returned as a list of items of this object type.

    Notes

    The user object(s) can be used in other operations where it is required.