Roles
Search Roles
Changed onSearch and filter roles by name, key, or ID with pagination support. Includes options to filter by workflow roles.
get/api/v1/roles/_search
Request
- Base URLhttps://docs.anzworldline-solutions.com.au
- Authnone declared
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
searchNamestring
Value to filter by role name
searchKeystring
Value to filter by role key
roleIdstring
Value for specific role id
startinteger
Offset on pagination
countinteger
Size on pagination
includeUserRolesboolean
Set false if do not want to include user rules
includeWorkflowRolesboolean
Set to true if want to include the workflow roles
Response
Changes
- info
api tag
Rolesadded
- info