object	auth/
Object representing the authentication server configuration

Retrieving the value is denied if not administrative user

This object contains the following items:

users	Users list
clients	Clients
realm	Realm
cookie_timeout	Cookie timeout
notifications	Notifications

Sample JS request write command:

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

Sample uom library read command:

print(uom.dump(uom.auth))

⇒

<...>

Browse more samples

Users list

array	auth/users/
List of user accounts

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 user account creation command:

uom.insert(uom.auth.users,3,{is_admin=false,is_allowed=false,name="dick",outlet_access={false,true,true,false,false,true,false,true},password="?53_'-;}r~1n!n"})

Browse more samples

User account

object	auth/users/N/
User account configuration

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

This object contains the following items:

name	Username
password	Password
is_allowed	User allowed
is_admin	Administrative user
outlet_access	Outlet access levels

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

uom.auth.users[_user_account_index]={is_admin=false,is_allowed=true,name="admin",outlet_access={true,true,true,true,true,true,true,true},password="nL|l[Y[E_YhZ h*"}

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

uom set "auth/users/${user_account_index}" "{\"password\":\"]eI;^D|X~E\",\"is_admin\":false,\"name\":\"harry\",\"is_allowed\":true,\"outlet_access\":[false,false,false,false,true,false,false,true]}"

Browse more samples

User account: Username

string	auth/users/N/name/
Username

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

the value matches ^[a-zA-Z0-9]*$
name members of all values of users list are distinct

Retrieving the value is denied if not administrative user

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

not administrative user
all of the following is true:
- administrative user
- protect admin login

This string represents a value in persistent storage.

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

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

uom get "auth/users/${user_account_index}/name"

⇒

"dick"

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

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "\"dick\"" "http://192.168.0.100/restapi/auth/users/:user_account_index/name/"

Browse more samples

User account: Password

string	auth/users/N/password/
Password

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

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

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

not administrative user
all of the following is true:
- administrative user
- protect admin login

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 uom library write command (note that _user_account_index is a variable):

uom.auth.users[_user_account_index].password="{];V3n;>'#=z.="

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)});

⇒

"`f.[|kb,hW^L.\"8"

Browse more samples

User account: User allowed

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

Retrieving the value is denied if not administrative user

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

not administrative user
all of the following is true:
- administrative user
- protect admin login

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 true	Allowed	The user is allowed to log in
constant false	Denied	The user is denied login

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

print(uom.dump(uom.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=true

Browse more samples

User account: Administrative user

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

Retrieving the value is denied if not administrative user

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

not administrative user
all of the following is true:
- administrative user
- protect admin login

This sum does not support direct modification.

This sum represents a value in persistent storage.

This sum can assume the following values:

constant true	Administrator	The user is an administrator
constant false	Regular user	The user is a regular user

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

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

uom get "auth/users/${user_account_index}/is_admin"

⇒

true

Browse more samples

User account: Outlet access levels

array	auth/users/N/outlet_access/
Access levels per outlet

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 any of the following is true:

not administrative user
all of the following is true:
- administrative user
- protect admin login

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 curl write command (note that :user_account_index is a URL template argument):

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "[false,false,true,false,false,false,false,false]" "http://192.168.0.100/restapi/auth/users/:user_account_index/outlet_access/"

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

local composite=uom.copy(uom.auth.users[_user_account_index].outlet_access)
uom.insert(composite,6,false)
uom.auth.users[_user_account_index].outlet_access=composite

Browse more samples

Outlet access

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

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 any of the following is true:

not administrative user
all of the following is true:
- administrative user
- protect admin login

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 true	Full	Outlet state can be manipulated by the user
constant false	None	Outlet state cannot be neither seen nor manipulated by the user

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)

Sample curl read command (note that :user_account_index and :outlet_access_index are URL template arguments):

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

⇒

false

Browse more samples

Clients

map	auth/clients/
Client accounts allowed scope-limited token-based access

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This map represents a value in persistent storage.

This map contains Client elements.

Sample CLI read command:

uom get "auth/clients"

⇒

...

Sample uom library write command:

uom.auth.clients={vx4LM={access_tokens={ce0ecebc8ffc547f14a73dc173adf283={expiry_time=1665087323,remaining_use_count=68}},redirect_urls={["https://%7dVE%Bd8"]=true,["https://%BA"]=true,["https://F"]=true},refresh_tokens={d2bce8c90fc8220587046e14f816f176={expiry_time=null,remaining_use_count=95}},scopes={["dli+object+read:/script/"]=true},secret_hash=null}}

Browse more samples

Client

object	auth/clients/S/
API client properties

This object contains the following items:

name	Name
secret_hash	Secret hash, if any
redirect_urls	Redirect URL set
scopes	Scope set
refresh_tokens	Refresh tokens
access_tokens	Access tokens

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

print(uom.dump(uom.auth.clients[_client]))

⇒

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

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

⇒

Browse more samples

Client: Name

string	auth/clients/S/name/
User-visible name of the client

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 JS request read command (note that _client is a variable):

request.get({url:"auth/clients/"+_client+"/name/"},function(error,response,body) {console.log(body)});

⇒

[]

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

requests.put('http://192.168.0.100/restapi/auth/clients/'+_client+'/name/',auth=auth,headers=headers,json={})

Browse more samples

Client: Secret hash, if any

sum (optional string)	auth/clients/S/secret_hash/
Hash of the client secret in an implementation-defined format, if any

Retrieving 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 null	None	The client does not have a secret to authenticate itself
string	Secret hash	Hash of the client secret in an implementation-defined format

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

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

⇒

null

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

print(uom.dump(uom.auth.clients[_client].secret_hash))

⇒

null

Browse more samples

Client: Redirect URL set

map	auth/clients/S/redirect_urls/
Set of URLs permitted to receive redirection on successful login

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This map represents a value in persistent storage.

This map contains Allowed elements.

Sample curl write command (note that :client is a URL template argument):

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "{\"https://4\":true}" "http://192.168.0.100/restapi/auth/clients/:client/redirect_urls/"

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

print(uom.dump(uom.auth.clients[_client].redirect_urls))

⇒

{["https://]]y"]=true}

Browse more samples

Allowed

constant true	auth/clients/S/redirect_urls/S/
The given URL is allowed to receive redirection on successful login

Sample requests deletion command (note that _client and _allowed are variables):

requests.delete('http://192.168.0.100/restapi/auth/clients/'+_client+'/redirect_urls/'+_allowed+'/',auth=auth,headers=headers)

Sample curl write command (note that :client and :allowed are URL template arguments):

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "true" "http://192.168.0.100/restapi/auth/clients/:client/redirect_urls/:allowed/"

Browse more samples

Client: Scope set

map	auth/clients/S/scopes/
Set of scopes that the authenticated client is authorized to access

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This map represents a value in persistent storage.

This map contains Authorized elements.

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

request.put({url:"auth/clients/"+_client+"/scopes/",body:{"dli+object+read:/":true}});

Sample uom library authorized creation command (note that _client is a variable):

uom.insert(uom.auth.clients[_client].scopes,"dli+object+full:/script/",true)

Browse more samples

Authorized

constant true	auth/clients/S/scopes/S/
The client is authorized to access the given scope

Sample uom library read command (note that _client and _authorized are variables):

print(uom.dump(uom.auth.clients[_client].scopes[_authorized]))

⇒

true

Sample curl read command (note that :client and :authorized are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/auth/clients/:client/scopes/:authorized/"

⇒

true

Browse more samples

Client: Refresh tokens

map	auth/clients/S/refresh_tokens/
Tokens that can be used to create access tokens

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This map represents a value in persistent storage.

This map can change as if by itself or indirectly because of other actions.

Changes to this map cannot be tracked.

This map contains Token properties elements.

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

request.put({url:"auth/clients/"+_client+"/refresh_tokens/",body:{"f50f4a1500e96f2b5af80a9fc95dc827":{"expiry_time":null,"remaining_use_count":10}}});

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

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

⇒

{'48f33666f0f3489096e4f4f4d4fa6630': {'expiry_time': 1680263274, 'remaining_use_count': 46}, '915e6ae796a20eb31d09f39d7d4982f6': {'expiry_time': 1699004100, 'remaining_use_count': 64}}

Browse more samples

Token properties

object	auth/clients/S/refresh_tokens/S/
Properties of the refresh token

Retrieving the value is denied if not administrative user

This object contains the following items:

expiry_time	Expiry time, if any
remaining_use_count	Remaining use count, if any

Sample requests write command (note that _client and _token_properties are variables):

requests.put('http://192.168.0.100/restapi/auth/clients/'+_client+'/refresh_tokens/'+_token_properties+'/',auth=auth,headers=headers,json={'expiry_time': 1691355768, 'remaining_use_count': 23})

Sample CLI deletion command (note that client and token_properties are variables):

uom remove "auth/clients/${client}/refresh_tokens/${token_properties}"

Browse more samples

Expiry time, if any

sum (optional number)	auth/clients/S/refresh_tokens/S/expiry_time/
The time at which the token is invalidated, if any

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Indefinite	The token stays valid for an indefinite time
number	Expiry time	The time at which the token is invalidated

Sample JS request read command (note that _client and _token_properties are variables):

request.get({url:"auth/clients/"+_client+"/refresh_tokens/"+_token_properties+"/expiry_time/"},function(error,response,body) {console.log(body)});

⇒

null

Sample CLI read command (note that client and token_properties are variables):

uom get "auth/clients/${client}/refresh_tokens/${token_properties}/expiry_time"

⇒

1630994574

Browse more samples

Remaining use count, if any

sum (optional number)	auth/clients/S/refresh_tokens/S/remaining_use_count/
The number of times the token can be used before it is is invalidated, if any

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can change as if by itself or indirectly because of other actions.

Changes to this sum cannot be tracked.

This sum can assume the following values:

constant null Indefinite The token may be used any number of times

number

Remaining use count

The number of times the token can be used before it is is invalidated

all of the following is true:

the value is an integer
the value is greater or equal to 0

Sample JS request write command (note that _client and _token_properties are variables):

request.put({url:"auth/clients/"+_client+"/refresh_tokens/"+_token_properties+"/remaining_use_count/",body:48});

Sample uom library read command (note that _client and _token_properties are variables):

print(uom.dump(uom.auth.clients[_client].refresh_tokens[_token_properties].remaining_use_count))

⇒

null

Browse more samples

Client: Access tokens

map	auth/clients/S/access_tokens/
Tokens that can be used to access the scopes

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This map represents a value in persistent storage.

This map can change as if by itself or indirectly because of other actions.

Changes to this map cannot be tracked.

This map contains Token properties elements.

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

request.get({url:"auth/clients/"+_client+"/access_tokens/"},function(error,response,body) {console.log(body)});

⇒

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

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

⇒

Browse more samples

Token properties

object	auth/clients/S/access_tokens/S/
Properties of the access token

Retrieving the value is denied if not administrative user

This object contains the following items:

expiry_time	Expiry time, if any
remaining_use_count	Remaining use count, if any

Sample JS request write command (note that _client and _token_properties are variables):

request.put({url:"auth/clients/"+_client+"/access_tokens/"+_token_properties+"/",body:{"expiry_time":1667847152,"remaining_use_count":null}});

Sample uom library deletion command (note that _client and _token_properties are variables):

uom.remove(uom.auth.clients[_client].access_tokens,_token_properties)

Browse more samples

Expiry time, if any

sum (optional number)	auth/clients/S/access_tokens/S/expiry_time/
The time at which the token is invalidated, if any

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can assume the following values:

constant null	Indefinite	The token stays valid for an indefinite time
number	Expiry time	The time at which the token is invalidated

Sample curl read command (note that :client and :token_properties are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/auth/clients/:client/access_tokens/:token_properties/expiry_time/"

⇒

1644896440

Sample JS request write command (note that _client and _token_properties are variables):

request.put({url:"auth/clients/"+_client+"/access_tokens/"+_token_properties+"/expiry_time/",body:null});

Browse more samples

Remaining use count, if any

sum (optional number)	auth/clients/S/access_tokens/S/remaining_use_count/
The number of times the token can be used before it is is invalidated, if any

Retrieving the value is denied if not administrative user

Changing the value is denied if not administrative user

This sum represents a value in persistent storage.

This sum can change as if by itself or indirectly because of other actions.

Changes to this sum cannot be tracked.

This sum can assume the following values:

constant null Indefinite The token may be used any number of times

number

Remaining use count

The number of times the token can be used before it is is invalidated

all of the following is true:

the value is an integer
the value is greater or equal to 0

Sample uom library write command (note that _client and _token_properties are variables):

uom.auth.clients[_client].access_tokens[_token_properties].remaining_use_count=55

Sample curl read command (note that :client and :token_properties are URL template arguments):

curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/auth/clients/:client/access_tokens/:token_properties/remaining_use_count/"

⇒

Browse more samples

Realm

string	auth/realm/
The realm to be announced in authentication responses

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 write command:

curl --digest -u admin:1234 -H "X-CSRF: x" -X PUT -H "Content-type: application/json" -H "Accept: application/json" --data-binary "[]" "http://192.168.0.100/restapi/auth/realm/"

Sample curl read command:

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

⇒

[]

Browse more samples

Cookie timeout

number	auth/cookie_timeout/
The amount of time for which a cookie is valid

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())

⇒

Sample curl read command:

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

⇒

Browse more samples

Notifications

object	auth/notifications/
Authentication-related notifications

Retrieving the value is denied if not administrative user

This object does not support direct modification.

This object contains the following items:

parameter_kinds	Parameter kinds
events	Events

Sample curl read command:

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

⇒

...

Sample uom library read command:

print(uom.dump(uom.auth.notifications))

⇒

<...>

Browse more samples

Events

map	auth/notifications/events/
Event templates

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 curl read command:

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

⇒

...

Sample CLI read command:

uom get "auth/notifications/events"

⇒

...

Browse more samples

Notifications: Parameter kinds

object	auth/notifications/parameter_kinds/
Kinds of event parameters

This object does not correspond to an actual resource.

This object contains the following items:

auth_login	Username
auth_client_name	Client name
auth_client_id	Client identifier
auth_ip	IP address
auth_method	Method
auth_reason	Reason
auth_allowed	Authentication allowed
user_state	User state

Username

string	auth/notifications/parameter_kinds/auth_login/
The name of the user

Client name

string	auth/notifications/parameter_kinds/auth_client_name/
The name of the client

Client identifier

string	auth/notifications/parameter_kinds/auth_client_id/
The identifier of the client

IP address

string	auth/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

string	auth/notifications/parameter_kinds/auth_method/
The authentication method

Reason

string	auth/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 true	Allowed	The user is allowed to log in
constant false	Denied	The 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 true	Existing	The user exists
constant false	Deleted	The user has been deleted
constant "new"	New	The user has been created

Event parameters: Event parameter

object	auth/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:

id	Identifier
has_fixed_value	Fixed value flag
fixed_value	Fixed value

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

request.put({url:"auth/notifications/events/"+_event+"/parameters/"+_event_parameter_index.toString()+"/",body:{"fixed_value":true,"has_fixed_value":true,"id":"user_state"}});

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()+"/"},function(error,response,body) {console.log(body)});

⇒

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

Browse more samples

Identifier

string	auth/notifications/events/S/parameters/N/id/
Parameter identifier

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 CLI read command (note that event and event_parameter_index are variables):

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

⇒

"auth_reason"

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()+"/id/"},function(error,response,body) {console.log(body)});

⇒

"auth_login"

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

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 true	Fixed	The value is fixed
constant false	Variable	The value is variable

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].has_fixed_value))

⇒

false

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()+"/has_fixed_value/"},function(error,response,body) {console.log(body)});

⇒

true

Browse more samples

Fixed value

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

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 null	Null	Null
constant true	True	True
constant false	False	False
string	String	This string
number	Number	This number

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

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

object	auth/notifications/events/S/
Event template

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

This object contains the following items:

message_template	Message template
severity	Severity
parameters	Event parameters

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

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

⇒

{"severity":6,"message_template":["protection violation attempt: ",0],"parameters":[{"fixed_value":null,"has_fixed_value":false,"id":"auth_reason"}]}

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

uom.auth.notifications.events[_event]={message_template={0,"@",1," session closed"},parameters={{fixed_value=null,has_fixed_value=false,id="auth_login"},{fixed_value=null,has_fixed_value=false,id="auth_ip"}},severity=7}

Browse more samples

Message template

array	auth/notifications/events/S/message_template/
Template for human-readable message generation

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 uom library read command (note that _event is a variable):

print(uom.dump(uom.auth.notifications.events[_event].message_template))

⇒

{"created user ",0}

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

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

⇒

["protection violation attempt: ",0]

Browse more samples

Message template element

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

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:

string	String	Fixed string
number	Parameter	Index of message parameter to insert	event parameters[the value]

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

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

⇒

"created user "

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

print(uom.dump(uom.auth.notifications.events[_event].message_template[_message_template_element_index]))

⇒

"modified user "

Browse more samples

Severity

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

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 1	Emergency	Treat the event as an emergency
constant 2	Alert	Treat the event as an alert
constant 3	Critical	Treat the event as critical
constant 4	Error	Treat the event as an error
constant 5	Warning	Treat the event as a warning
constant 6	Notice	Treat the event as a notice
constant 7	Informational	Treat the event as informational
constant 8	Debug	Treat 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)});

⇒

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

print(uom.dump(uom.auth.notifications.events[_event].severity))

⇒

Browse more samples

Event parameters

array	auth/notifications/events/S/parameters/
Additional data associated with the event

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 uom library read command (note that _event is a variable):

print(uom.dump(uom.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"}}

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

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

⇒

[{'fixed_value': None, 'has_fixed_value': False, 'id': 'auth_login'}, {'fixed_value': False, 'has_fixed_value': True, 'id': 'user_state'}]

Browse more samples