Role Management APIs
Overview of the role management APIs.
You can use the following role management APIs to work with roles:
Note: Alternatively, you can use the User Management application to
assign roles to users. For more information, see User Management.
Important:
While naming a role, remember the following rules:
- The length of the role name must not exceed 128 characters.
- The role name can contain letters (both upper and lower case), numbers, and special characters such as $, &, @, and _.
- Prefix the role name with ROLE_, if you are going to use it along with client credentials. For more information, see Obtaining access tokens with client credentials grant type.
- The role name must not be the same as the Reltio System Role names. For example, ROLE_API or ROLE_USER. For more information on system roles, see 2023.2.1.0 weekly release notes | 03-Jul-2023.
Some best practices while naming roles:
- It is a good practice to start the role name with ROLE_.
- Use uppercase while naming roles, with _ as a delimiter. For example, ROLE_PROFILE_VIEWER, ROLE_DATA_STEWARD, and so on.