Alignak user (user)

The user model is used to represent a user involved in the monitored system.

It may be a “real” user that will be notified about the problems detected by Alignak, or a user that will use the Web User Interface to view information, or, even, a system or program user that will connect to the Alginak backend to provide information.

resources/../_static/config_user.png
Properties
Property Type Required Default Relation
Template
boolean   False  
Realm
objectid True   realm
Sub-realms
boolean   True  
Template fields
list   []  
Templates
objectid list   [] user
_users_delete
objectid list     user
_users_read
objectid list     user
_users_update
objectid list     user
Address 1
string      
Address 2
string      
Address 3
string      
Address 4
string      
Address 5
string      
Address 6
string      
Alias
string      
Super administrator
boolean   False  
Can submit commands
boolean   False  
Can update livestate
boolean   False  
customs
Custom variables
dict   {}  
Definition order
integer   100  
e-mail address
string      
Host notifications commands
objectid list     command
Host notifications options
list   [‘d’, ‘u’, ‘r’, ‘f’, ‘s’]  
Host notifications period
objectid True   timeperiod
Host notifications enabled
boolean   False  
Imported from
string   unknown  
Administrator
boolean   False  
Minimum business impact
integer   0  
User name
string True    
Notes
string      
Notification ways
list   []  
Mobile
string      
Password
string   NOPASSWORDSET  
schema_version
integer   2  
Service notifications commands
objectid list     command
Service notifications options
list   [‘w’, ‘u’, ‘c’, ‘r’, ‘f’, ‘s’]  
Service notifications period
objectid True   timeperiod
Service notifications enabled
boolean   False  
Level
integer   0  
Tags
list   []  
Token
string      
User preferences
dict   {}  
Web UI visible
boolean   True  

_is_template: Indicate if this element is a template or a real element

_realm: Realm this element belongs to.

_sub_realm: Is this element visible in the sub-realms of its realm?

_template_fields: If this element is not a template, this field contains the list of the fields linked to the templates this element is linked to

_templates: List of templates this element is linked to.

address1: User post address.

address2: User post address.

address3: User post address.

address4: User post address.

address5: User post address.

address6: User post address. Note that this field may be used in the configuration files when importing data into the Alignak backend. The alignak-backend-import script will consider this field as the user’s realm.

alias: Element friendly name used by the Web User Interface.

back_role_super_admin: This user is a super-administrator that is allowed to view and do anything in the Alignak backend

can_submit_commands: Used by the Web User Interface to allow the logged-in user to send commands to Alignak. This do not allow the user to edit the Alignak backend data.

can_update_livestate: This user can update the live state information of the Alignak backend. This property is used for the user that will be configured for the Alignak Broker backend module. If this attribute is not set, then the logged-in user will not be allowed to update live state information (standard Web User Interface user).

definition_order: Priority level if several elements have the same name

email: User e-mail address to be used for the notifications.

host_notification_commands: List of the notifications commands used to send the notifications.

host_notification_options: List of the notifications types that can be sent.

Allowed values: [‘d’, ‘u’, ‘r’, ‘f’, ‘s’, ‘n’]

host_notification_period: Time period defining the moments this user will receive the notifications raised or an element he is attached to.

host_notifications_enabled: If unset, this user will never receive any notification when a problem is detected for an host/service he is linked to.

imported_from: Item importation source (alignak-backend-import, …)

is_admin: Used by the Web User Interface to allow the logged-in user to update the Alignak backend data and to send commands to Alignak

min_business_impact: Minimum business impact the user is concerned with. If a notification is raised for an element which BI is lower than the minimum business impact of the user, the notification will be filtered out.

name: Unique user name. Will be used as a login username

notes: Element notes. Free text to store element information.

notificationways: User notification ways.

pager: User mobile phone to be used for the notifications.

password: This field is used on user’s creation as the password and it is then obfuscated by the Alignak backend

service_notification_commands: List of the notifications commands used to send the notifications.

service_notification_options: List of the notifications types that can be sent.

Allowed values: [‘w’, ‘u’, ‘c’, ‘r’, ‘f’, ‘s’, ‘n’]

service_notification_period: Time period defining the moments this user will receive the notifications raised or an element he is attached to.

service_notifications_enabled: If unset, this user will never receive any notification when a problem is detected for an host/service he is linked to.

skill_level: This field is the user’s skill level. It is used by the Web User Interface to display more or less advanced information. Each property in the backend data models may have its own skill level and it will be displayed it the user’s skill level is greater than or equal. As default, the skill level is 0 and the property will be displayed.

tags: List of tags for this element. Intended to set tags by the Web UI

token: This field is the user’s authentication token that can be used in the REST API as a basic authentication credentials

ui_preferences: User preferences that are used by the Web User Interface to manage the user preferences (eg. table filters, …).

webui_visible: If not set, the Web User Interface will ignore this user.