Role
The 'Role' resource represents a set of access rights assigned to users within the digital customer platform. It defines the permissions that a user holds for operating on industrial assets or executing certain actions. Each 'Role' is related to 'User' and 'Account' resources to determine the scope of access within the platform. Additionally, a 'Role' is associated with specific permissions which describe the granular actions allowed. Common attributes include 'active' indicating whether the role is currently enabled, and 'name' which is the identifier for the role.Attributes
These are all attributes that can be read and updated through the API
| Name | Description | Permissions |
|---|---|---|
| active | Indicates whether the role is currently in use or deactivated. A value of true means the role is active and can be assigned to users, while false implies it is inactive or retired. | READ ONLY |
| name | The 'name' attribute represents the title or designation of the Role, typically used to specify the role's purpose or position within an organization, such as 'Administrator', 'Moderator', or 'User'. | READ ONLY |
Get Role by ID
GEThttps://home.autonoma.cloud/connect/v1/resources/role/[ID]Returns a specific Role by ID.
Relations
It is possible to get related objects from Roles.
GEThttps://home.autonoma.cloud/connect/v1/resources/role/[ID]/[RELATION]This table shows all available resources that can be queried
| Relation | Objecttype | Relationtype | |
|---|---|---|---|
| users | User | Not available | Show details |
| accounts | Account | many:1 | Show details |
Update Role
POSThttps://home.autonoma.cloud/connect/v1/resources/role/[ID]Update fields of Role by ID. The fields must be sent as x-www-form-urlencoded parameter.
Create Role
PUThttps://home.autonoma.cloud/connect/v1/resources/roleCreate a new Role.
Delete Role
DELETEhttps://home.autonoma.cloud/connect/v1/resources/role/[ID]Delete the resource Role by ID.
This action can not be reverted!