Role management API
CompComplete uses ABAC (Attribute Based Access Control) for the process of access authorization. This solution increases security of the application and protects all the sensitive data that it is processing. Professional-role is an entity which plays crucial role in the authorization process. It is an attribute-type with configurable values. We use this attribute to build authorization policies and rules which control the access to resources in the application.
This is an note/information message.
To be able to view, create and delete professional roles, you must be assigned a Configuration professional role. For more information about the various professional roles, refer to CompComplete roles.
API Endpoints
The application offers three REST API endpoints used to manage professional roles:
Returning all existing professional roles
The values are all the professional roles existing in the CompComplete. The syntax of the data transmission endpoint is setup as illustrated in the following figure:
GET endpoint
The following figure illustrates the example of a response:
Values in example response
Creating a professional role
You may create new professional roles that will respond to your organization unique needs. The syntax of the data transmission endpoint is setup as illustrated in the following picture:
POST endpoint
The request body is illustrated in the following figure.
The request body
You can give your new role the name of your choice; however, you need to make sure it is connected to the tasks this role will be performing in the application.
Deleting a professional role
You may also delete any role that you are not using or is not relevant to your organization. The syntax of the data transmission endpoint is setup as illustrated in the following picture:
DELETE endpoint
Going further