DLI ISO32 Object Model Reference
20210317T210828Z
Authentication server object
objectauth/
Object representing the authentication server configuration
dot_inline_dotgraph_100.png

Retrieving the value is denied if not administrative user

This object contains the following items:

usersUsers list
realmRealm
cookie_timeoutCookie timeout
notificationsNotifications

Sample requests read command:

print(requests.get('http://192.168.0.100/restapi/auth/',auth=auth,headers=headers).json())

<...>

Sample JS request write command:

request.put({url:"auth/",body:<...>});

Browse more samples

Users list

arrayauth/users/
List of user accounts
dot_inline_dotgraph_101.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This array represents a value in persistent storage.

This array represents an unordered set (order of its elements doesn't matter, and each value should not be supplied more than once).

This array contains User account elements.

Sample curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/auth/users/"

Sample uom library write command:

uom.auth.users={{is_allowed=true,name="admin",outlet_access={true,true,true,true,true,true,true,true},password="/n5Sy)-\\W0i"},{is_admin=false,is_allowed=true,name="tom",outlet_access={true,false,false,false,false,true,true,false,true,true,true,false,true,false,false,true,true,true,false,true,false,false,false,false,false,false,false,true,false,true,true,false},password="$F6Nt[\"`!Z!nkXT]"},{is_allowed=false,name="dick",outlet_access={false,true,true,false,true,false,true,true,true,false,false,true,false,false,true,false,true,true,false,false,true,true,true,false,false,false,false,false,true,false,true,false},password="~OW4W/RmEH4D;_jC"},{is_admin=false,is_allowed=true,name="harry",outlet_access={false,false,false,false,true,true,true,false,true,true,false,true,false,true,true,false,false,false,false,true,false,false,false,false,true,false,false,true,true,false,false,true},password="JTs:bw_3T/e,W85"}}

Browse more samples

User account

objectauth/users/N/
User account configuration
dot_inline_dotgraph_102.png

Removing the object from its parent collection is denied if administrative user

This object contains the following items:

nameUsername
passwordPassword
is_allowedUser allowed
is_adminAdministrative user
outlet_accessOutlet access levels

Sample curl deletion command (note that :user_account_index is a URL template argument):

curl --digest -u admin:1234 -H "X-CSRF: x" -X DELETE -H "Accept: application/json" "http://192.168.0.100/restapi/auth/users/:user_account_index/"

Sample uom library read command (note that _user_account_index is a variable):

print(uom.dump(uom.auth.users[_user_account_index]))

Browse more samples

See also User account: Username

See also User account: Password

See also User account: User allowed

See also User account: Administrative user

See also User account: Outlet access levels

User account: Username

stringauth/users/N/name/
Username
dot_inline_dotgraph_103.png

The value is subject to the following constraints: all of the following is true:

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

Write operations must supply the current value of password if administrative user

Sample uom library read command (note that _user_account_index is a variable):

print(uom.dump(uom.auth.users[_user_account_index].name))

"dick"

Sample requests write command (note that _user_account_index is a variable):

requests.put('http://192.168.0.100/restapi/auth/users/'+str(_user_account_index)+'/name/',auth=auth,headers=headers,json='harry')

Browse more samples

User account: Password

stringauth/users/N/password/
Password
dot_inline_dotgraph_104.png

The value is subject to the following constraints: the value matches ^[ -~]*$

Retrieving the value is denied if any of the following is true:

Using the string as a field for indexing into the grandparent collection is denied

This string represents a value in persistent storage.

This string should be displayed in a secure manner.

Write operations must supply the current value of the value if administrative user

Sample requests read command (note that _user_account_index is a variable):

print(requests.get('http://192.168.0.100/restapi/auth/users/'+str(_user_account_index)+'/password/',auth=auth,headers=headers).json())

'b?T)8K|=%<d|?O'

Sample JS request read command (note that _user_account_index is a variable):

request.get({url:"auth/users/"+_user_account_index.toString()+"/password/"},function(error,response,body) {console.log(body)});

"7Z19,aAg)WB%'"

Browse more samples

User account: User allowed

sum (boolean)auth/users/N/is_allowed/
Flag indicating whether user is allowed or denied
dot_inline_dotgraph_105.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum does not support direct modification if administrative user.

This sum represents a value in persistent storage.

This sum can assume the following values:

constant trueAllowedThe user is allowed to log in
constant falseDeniedThe user is denied login

Sample CLI write command (note that user_account_index is a variable):

uom set "auth/users/${user_account_index}/is_allowed" "true"

Sample uom library write command (note that _user_account_index is a variable):

uom.auth.users[_user_account_index].is_allowed=false

Browse more samples

User account: Administrative user

sum (boolean)auth/users/N/is_admin/
Flag indicating whether the user is an administrator
dot_inline_dotgraph_106.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum does not support direct modification.

This sum represents a value in persistent storage.

This sum can assume the following values:

constant trueAdministratorThe user is an administrator
constant falseRegular userThe user is a regular user

Sample JS request read command (note that _user_account_index is a variable):

request.get({url:"auth/users/"+_user_account_index.toString()+"/is_admin/"},function(error,response,body) {console.log(body)});

false

Sample uom library read command (note that _user_account_index is a variable):

print(uom.dump(uom.auth.users[_user_account_index].is_admin))

true

Browse more samples

User account: Outlet access levels

arrayauth/users/N/outlet_access/
Access levels per outlet
dot_inline_dotgraph_107.png

The value is subject to the following constraints: length of the value is equal to length of outlets

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This array is composite, i.e. is modified as a whole.

This array does not support direct modification if administrative user.

This array represents a value in persistent storage.

This array contains Outlet access elements.

Sample requests outlet access creation command (note that _user_account_index is a variable):

requests.post('http://192.168.0.100/restapi/auth/users/'+str(_user_account_index)+'/outlet_access/',auth=auth,headers=headers,json=True)

Sample JS request write command (note that _user_account_index is a variable):

request.put({url:"auth/users/"+_user_account_index.toString()+"/outlet_access/",body:[true,true,true,true,false,true,false,false,false,false,true,true,true,true,true,false,false,true,false,false,false,false,true,true,true,true,false,true,false,true,false,false]});

Browse more samples

Outlet access

sum (boolean)auth/users/N/outlet_access/N/
Access level for outlet by index
dot_inline_dotgraph_108.png

The value is subject to the following constraints: outlets[index of the value]

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum is a part of a composite value which is modified as a whole.

This sum does not support direct modification if administrative user.

This sum represents a value in persistent storage.

This sum can assume the following values:

constant trueFullOutlet state can be manipulated by the user
constant falseNoneOutlet state cannot be neither seen nor manipulated by the user

Sample uom library write command (note that _user_account_index and _outlet_access_index are variables):

uom.auth.users[_user_account_index].outlet_access[_outlet_access_index]=false

Sample requests deletion command (note that _user_account_index and _outlet_access_index are variables):

requests.delete('http://192.168.0.100/restapi/auth/users/'+str(_user_account_index)+'/outlet_access/'+str(_outlet_access_index)+'/',auth=auth,headers=headers)

Browse more samples

Realm

stringauth/realm/
The realm to be announced in authentication responses
dot_inline_dotgraph_109.png

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This string represents a value in persistent storage.

Sample curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/auth/realm/"

[]

Sample CLI read command:

uom get "auth/realm"

[]

Browse more samples

Cookie timeout

numberauth/cookie_timeout/
The amount of time for which a cookie is valid
dot_inline_dotgraph_110.png

The value represents time, the standard unit of which is the second (s).

The value is subject to the following constraints: the value is greater than 0

Changing the value is denied if not administrative user

This number represents a value in persistent storage.

Sample requests read command:

print(requests.get('http://192.168.0.100/restapi/auth/cookie_timeout/',auth=auth,headers=headers).json())

30000

Sample CLI write command:

uom set "auth/cookie_timeout" "30000"

Browse more samples

Notifications

objectauth/notifications/
Authentication-related notifications
dot_inline_dotgraph_111.png

Retrieving the value is denied if not administrative user

This object does not support direct modification.

This object contains the following items:

parameter_kindsParameter kinds
eventsEvents

Sample curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/auth/notifications/"

...

Sample requests read command:

print(requests.get('http://192.168.0.100/restapi/auth/notifications/',auth=auth,headers=headers).json())

<...>

Browse more samples

See also Notifications: Parameter kinds

Events

mapauth/notifications/events/
Event templates
dot_inline_dotgraph_112.png

Retrieving the value is denied if not administrative user

This map is composite, i.e. is modified as a whole.

This map does not support direct modification.

This map contains Event elements.

Creating elements in this collection is not supported.

Sample JS request read command:

request.get({url:"auth/notifications/events/"},function(error,response,body) {console.log(body)});

<...>

Sample curl read command:

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/auth/notifications/events/"

...

Browse more samples

See also Events: Event

Notifications: Parameter kinds

objectauth/notifications/parameter_kinds/
Kinds of event parameters

This object does not correspond to an actual resource.

This object contains the following items:

auth_loginUsername
auth_ipIP address
auth_methodMethod
auth_reasonReason
auth_allowedAuthentication allowed
user_stateUser state

Username

stringauth/notifications/parameter_kinds/auth_login/
The name of the user

IP address

stringauth/notifications/parameter_kinds/auth_ip/
The IP address of the user

The value is subject to the following constraints: the value matches ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5]).){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$

Method

stringauth/notifications/parameter_kinds/auth_method/
The authentication method

Reason

stringauth/notifications/parameter_kinds/auth_reason/
The reason for authentication decision

Authentication allowed

sum (boolean)auth/notifications/parameter_kinds/auth_allowed/
Authentication decision result

This sum can assume the following values:

constant trueAllowedThe user is allowed to log in
constant falseDeniedThe user is denied to log in

User state

sum (variant)auth/notifications/parameter_kinds/user_state/
The state of the user

This sum can assume the following values:

constant trueExistingThe user exists
constant falseDeletedThe user has been deleted
constant "new"NewThe user has been created

Event parameters: Event parameter

objectauth/notifications/events/S/parameters/N/
Properties of a parameter associated with the event

This object is a part of a composite value which is modified as a whole.

This object contains the following items:

idIdentifier
has_fixed_valueFixed value flag
fixed_valueFixed value

Sample curl read command (note that :event and :event_parameter_index are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/auth/notifications/events/:event/parameters/:event_parameter_index/"

{"fixed_value":null,"has_fixed_value":false,"id":"auth_reason"}

Sample requests read command (note that _event and _event_parameter_index are variables):

print(requests.get('http://192.168.0.100/restapi/auth/notifications/events/'+_event+'/parameters/'+str(_event_parameter_index)+'/',auth=auth,headers=headers).json())

{'fixed_value': None, 'has_fixed_value': False, 'id': 'auth_method'}

Browse more samples

Identifier

stringauth/notifications/events/S/parameters/N/id/
Parameter identifier
dot_inline_dotgraph_113.png

The value is subject to the following constraints: parameter kinds[the value]

Retrieving the value is denied if not administrative user

This string is a part of a composite value which is modified as a whole.

This string does not support direct modification.

Sample curl read command (note that :event and :event_parameter_index are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/auth/notifications/events/:event/parameters/:event_parameter_index/id/"

"auth_ip"

Sample uom library read command (note that _event and _event_parameter_index are variables):

print(uom.dump(uom.auth.notifications.events[_event].parameters[_event_parameter_index].id))

"auth_reason"

Browse more samples

Fixed value flag

sum (boolean)auth/notifications/events/S/parameters/N/has_fixed_value/
Flag indicating that the parameter's value for this event is fixed
dot_inline_dotgraph_114.png

Retrieving the value is denied if not administrative user

This sum is a part of a composite value which is modified as a whole.

This sum does not support direct modification.

This sum can assume the following values:

constant trueFixedThe value is fixed
constant falseVariableThe value is variable

Sample CLI read command (note that event and event_parameter_index are variables):

uom get "auth/notifications/events/${event}/parameters/${event_parameter_index}/has_fixed_value"

false

Sample requests read command (note that _event and _event_parameter_index are variables):

print(requests.get('http://192.168.0.100/restapi/auth/notifications/events/'+_event+'/parameters/'+str(_event_parameter_index)+'/has_fixed_value/',auth=auth,headers=headers).json())

False

Browse more samples

Fixed value

sum (variant)auth/notifications/events/S/parameters/N/fixed_value/
Fixed parameter value for this particular event
dot_inline_dotgraph_115.png

Retrieving the value is denied if not administrative user

This sum is a part of a composite value which is modified as a whole.

This sum does not support direct modification.

This sum can assume the following values:

constant nullNullNull
constant trueTrueTrue
constant falseFalseFalse
stringStringThis string
numberNumberThis number

Sample JS request read command (note that _event and _event_parameter_index are variables):

request.get({url:"auth/notifications/events/"+_event+"/parameters/"+_event_parameter_index.toString()+"/fixed_value/"},function(error,response,body) {console.log(body)});

null

Sample uom library read command (note that _event and _event_parameter_index are variables):

print(uom.dump(uom.auth.notifications.events[_event].parameters[_event_parameter_index].fixed_value))

null

Browse more samples

Events: Event

objectauth/notifications/events/S/
Event template
dot_inline_dotgraph_116.png

This object is a part of a composite value which is modified as a whole.

This object contains the following items:

message_templateMessage template
severitySeverity
parametersEvent parameters

Sample uom library write command (note that _event is a variable):

uom.auth.notifications.events[_event]={message_template={"deleted user ",0},parameters={{fixed_value=null,has_fixed_value=false,id="auth_login"},{fixed_value=false,has_fixed_value=true,id="user_state"}},severity=6}

Sample CLI read command (note that event is a variable):

uom get "auth/notifications/events/${event}"

{"severity":6,"message_template":["deleted user ",0],"parameters":[{"fixed_value":null,"has_fixed_value":false,"id":"auth_login"},{"fixed_value":false,"has_fixed_value":true,"id":"user_state"}]}

Browse more samples

Message template

arrayauth/notifications/events/S/message_template/
Template for human-readable message generation
dot_inline_dotgraph_117.png

Retrieving the value is denied if not administrative user

This array is a part of a composite value which is modified as a whole.

This array does not support direct modification.

This array contains Message template element elements.

Creating elements in this collection is not supported.

Sample CLI read command (note that event is a variable):

uom get "auth/notifications/events/${event}/message_template"

[0,"@",1," session closed"]

Sample requests read command (note that _event is a variable):

print(requests.get('http://192.168.0.100/restapi/auth/notifications/events/'+_event+'/message_template/',auth=auth,headers=headers).json())

['login denied for ', 0, '@', 1, ' (', 2, '): ', 3]

Browse more samples

Message template element

sum (variant)auth/notifications/events/S/message_template/N/
Element of human-readable message template
dot_inline_dotgraph_118.png

Retrieving the value is denied if not administrative user

This sum is a part of a composite value which is modified as a whole.

This sum does not support direct modification.

This sum can assume the following values:

stringStringFixed string
numberParameterIndex of message parameter to insertevent parameters[the value]

Sample JS request read command (note that _event and _message_template_element_index are variables):

request.get({url:"auth/notifications/events/"+_event+"/message_template/"+_message_template_element_index.toString()+"/"},function(error,response,body) {console.log(body)});

2

Sample requests read command (note that _event and _message_template_element_index are variables):

print(requests.get('http://192.168.0.100/restapi/auth/notifications/events/'+_event+'/message_template/'+str(_message_template_element_index)+'/',auth=auth,headers=headers).json())

' ('

Browse more samples

Severity

sum (enumerated number)auth/notifications/events/S/severity/
Severity rating assigned to the event
dot_inline_dotgraph_119.png

Retrieving the value is denied if not administrative user

This sum is a part of a composite value which is modified as a whole.

This sum does not support direct modification.

This sum can assume the following values:

constant 1EmergencyTreat the event as an emergency
constant 2AlertTreat the event as an alert
constant 3CriticalTreat the event as critical
constant 4ErrorTreat the event as an error
constant 5WarningTreat the event as a warning
constant 6NoticeTreat the event as a notice
constant 7InformationalTreat the event as informational
constant 8DebugTreat the event as debugging-related

Sample JS request read command (note that _event is a variable):

request.get({url:"auth/notifications/events/"+_event+"/severity/"},function(error,response,body) {console.log(body)});

6

Sample CLI read command (note that event is a variable):

uom get "auth/notifications/events/${event}/severity"

7

Browse more samples

Event parameters

arrayauth/notifications/events/S/parameters/
Additional data associated with the event
dot_inline_dotgraph_120.png

Retrieving the value is denied if not administrative user

This array is a part of a composite value which is modified as a whole.

This array does not support direct modification.

This array contains Event parameter elements.

Creating elements in this collection is not supported.

Sample curl read command (note that :event is a URL template argument):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/auth/notifications/events/:event/parameters/"

[{"fixed_value":null,"has_fixed_value":false,"id":"auth_login"},{"fixed_value":null,"has_fixed_value":false,"id":"auth_ip"}]

Sample CLI read command (note that event is a variable):

uom get "auth/notifications/events/${event}/parameters"

[{"fixed_value":null,"has_fixed_value":false,"id":"auth_login"},{"fixed_value":"new","has_fixed_value":true,"id":"user_state"}]

Browse more samples

See also Event parameters: Event parameter