GET /roles
This endpoint returns a list of all roles in current user's account.
Request
- Base URLhttps://api.cxxx.eagleeyenetworks.com/api/v3.0
- URLhttps://api.cxxx.eagleeyenetworks.com/api/v3.0/roles
- AuthHTTP bearer
Query parameters
Filter to get the users whose id is on the provided list. The lookup is exact and case insensitive.
Filter to get the user role assignments whose the role name contains the provided substring. The lookup is exact but case insensitive
Token string value that references a page for pagination. This value is received when retrieving the first page in the nextPageToken and prevPageToken fields. When a pageToken is provided, the backend remembers search parameters from the original request, so search parameters that affect the result set or order are optional and will be ignored if provided. Representation parameters like include should still be applied.
The number of entries to return per page. The maximum range of valid page sizes is documented with minimum and maximum values, but the range might be further limited dynamically based on the requested information, account, and system status. Values outside of the (dynamic) allowed range will not result in an error, but will be clamped to the nearest limit. Thus, logic to detect the last page should not be based on comparing the requested size with the received size, but on the existence of a nextPageToken value.
Response
List of roles.
Changes
No recorded changes to this operation across all 1 revision of this API.