User Integration Guide¶
The Argus user service holds the information about the systems users, what functions can be performed in the system, and who as the permission to do what.
Here are the central concepts in the service:
- User
- refers to a specific user of Argus. Users are the entities that log in and perform actions in Argus.
- Group
- refers to a collection of subjects. This allows us to group users that should share permissions. Groups can be members of groups, but it is not allowed to create cycles. Note that if a group is granted a permission, then that permission is inherited by all members of the group.
- Subject
- is a collective term for users and groups. It is used when the type of an entity can be either of those types.
- Function
- describes the capability to perform a specific action in Argus like adding a user, or viewing a sensor.
- Role
- is a logical collection of functions and roles which should consist of the functions and roles required to perform a certain role within Argus.
- Permission
- is a combination of a subject, a role and a customer. When doing a security check this is what is used to verify that the user can permit the required function for the given customer. Permissions can be granted using users and functions, though this is normally not preferred.
Note that this service is for fetching and modifying other users. To update your own user you should look at the Swagger API documentation which is located under the authentication service.
V1 Deprecated
Please note that v1 of this API is deprecated, if you have any code which uses this please upgrade
Tip
The Swagger API documentation is always up-to-date and lets you try out any query with your user session or an API-key.
Tip
Please read the Overview to learn the general concepts and common data structures used throughout the Argus API.