Find Security Roles

{ getRolesByName }

Returns a role and its metadata using the search criteria.

Method

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

    searchCriteria

    Object Type

    Description

    The search criteria for finding materialized data elements.

    Output Response

    Successful Result Code

    200

    Response List Type

    Description of Response Type

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

    Notes

    Use this function together with 'getRoleById' to select and use roles in the system.

    Examples