Roles
Was this helpful?
Was this helpful?
Retrieves all roles available for a specific tenant. You can filter the results by using query parameters.
Each role contains a permissions list, and each permission is combined with the applicablePermissionResourcesfield. This field allows you to whitelist resources that the permission is applicable to. The field can only contain resources specified in the permission document under applicableResources.
iam.role_read
Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$Page number to be retrieved. The number of the first page is 1.
1Number of items to be retrieved per page.
60List of properties used to sort the results, separated by colons. The order of properties indicates their priority in sorting.
Possible values:
{fieldName}{fieldName}:asc{fieldName}:descNote: If you want to sort the results by localized properties, the possible values are as follows:
{fieldName}.{language}{fieldName}.{language}:asc{fieldName}.{language}:descIf the sorting direction is not specified, the fields are sorted in ascending order.
Search by the name of a given resource. The value will be conformed against all of the specified accepted languages.
Search by the description of the the given resource, it will be conformed against all of the specified accepted-languages.
Search by given resources that contain the metadata.modifiedAt date field with a date later than the specified value. The format is as follows: ''yyyy-MM-dd''.
2022-01-01List of language codes acceptable for the response. You can specify factors that indicate which language should be retrieved if the one with a higher factor was not found in the localized fields. If the value is specified, then it must be present in the tenant configuration.
*, all localized fields are retrieved as maps of translations, where the keys are language codes and values are the fields in their respective languages.Flag indicating whether the total number of retrieved items should be returned.
falseExample: trueUnique identifier of a role, generated when the role is created.
084bcaf6-66b8-4ddd-9489-65c5f6449e94Your Emporix tenant's name.
Note: The tenant name should always be written in lowercase.
^[a-z][a-z0-9]+$List of language codes acceptable for the response. You can specify factors that indicate which language should be retrieved if the one with a higher factor was not found in the localized fields. If the value is specified, then it must be present in the tenant configuration.
*, all localized fields are retrieved as maps of translations, where the keys are language codes and values are the fields in their respective languages.