Roles Service: Overview
The operations in the Roles service allow you to manage security roles on the platform, including adding and deleting roles, modifying user/role assignments, and retrieving information about roles. In the prior versions of the Akana Platform, users can be assigned to a role, but from the 2022.1.3 version onwards, you can assign or modify groups and users for a role using the PUT /api/resources/{ResourceID}/roles/{RoleName}/members API.
URL: https://{hostname}/api/resources/{ResourceID}/roles
Valid in Version: 2022.1.3 and later
URL: https://{hostname}/api/roles
Note: The api/roles operations take the ResourceID as a parameter. In the context of platform roles, this value is the same as the BusinessID for the default tenant business organization. To find out this value, you can run the GET /api/properties operation (TenantBusinessID parameter in the response). To get the RoleName, used in some operations, use the GET /api/roles/{ResourceID} operation.
| Action | Endpoint | Description |
|---|---|---|
| update groups and users assigned to a role | PUT /api/resources/{ResourceID}/roles/{RoleName}/members | Updates information about the groups and users assigned to the specified platform role. |
| get role members | GET /api/resources/{ResourceID}/roles/{RoleName}/members | Returns information about the users and groups assigned to a role. |
| get role | GET /api/roles/{ResourceID}/{RoleName} | Returns information about the specified security role on the API platform and the users who are assigned to it. |
| get roles | GET /api/roles/{ResourceID} | Returns information about the security roles defined on the API platform. |
| update users assigned to role | PUT /api/roles/{ResourceID}/{RoleName} | Updates information about the users assigned to the specified platform role. |