DLI EPCDC32 Object Model Reference
|
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 curl
read command:
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/auth/"
⇒
...
Sample uom
library write command:
uom.auth=<...>
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 requests
user account creation command:
requests.post('http://192.168.0.100/restapi/auth/users/',auth=auth,headers=headers,json={'password': 'Ks824{d%#ef3`', 'is_admin': False, 'name': 'dick', 'is_allowed': False, 'outlet_access': [True, True, False, True, True, False, True, True, False, True, True, False, False, True, False, True, False, True, False, False, True, False, False, True, False, False, True, True, False, False, False, True]})
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 "[{\"password\":\"6VJAu AWq7PQkB;\",\"is_admin\":false,\"name\":\"admin\",\"is_allowed\":true,\"outlet_access\":[true,true,true,true,true,true,true,true]},{\"password\":\"/zbyl}-q\",\"is_admin\":false,\"name\":\"tom\",\"is_allowed\":true,\"outlet_access\":[false,true,true,true,false,true,false,false,false,true,true,false,true,true,true,true,false,false,false,false,true,true,false,true,true,true,true,false,true,false,false,false]},{\"password\":\"t'.3#v'J rrL6\",\"name\":\"dick\",\"is_allowed\":false,\"outlet_access\":[true,true,true,false,false,true,true,true,false,true,false,true,false,false,false,false,false,true,false,false,true,false,false,true,false,true,true,false,true,false,false,true]},{\"password\":\"$:]F>v0GM<B>x\\\"%2\",\"is_admin\":false,\"name\":\"harry\",\"is_allowed\":true,\"outlet_access\":[false,false,false,true,false,false,true,true,true,false,true,true,false,false,true,false,false,false,true,true,false,true,false,true,false,false,true,false,false,true,false,false]}]" "http://192.168.0.100/restapi/auth/users/"
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 JS request
deletion command (note that _user_account_index
is a variable):
request.delete({url:"auth/users/"+_user_account_index.toString()+"/"});
Sample CLI deletion command (note that user_account_index
is a variable):
uom remove "auth/users/${user_account_index}"
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
string | auth/users/N/name/ |
Username |
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 CLI read command (note that user_account_index
is a variable):
uom get "auth/users/${user_account_index}/name"
⇒
"admin"
Sample curl
read command (note that :user_account_index
is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/auth/users/:user_account_index/name/"
⇒
"harry"
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:
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 CLI read command (note that user_account_index
is a variable):
uom get "auth/users/${user_account_index}/password"
⇒
"=zF]'x+f_15"
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())
⇒
'IDFDM,%bn'
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 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 true | Allowed | The user is allowed to log in | |
constant false | Denied | The user is denied login |
Sample uom
library write command (note that _user_account_index
is a variable):
uom.auth.users[_user_account_index].is_allowed=true
Sample CLI read command (note that user_account_index
is a variable):
uom get "auth/users/${user_account_index}/is_allowed"
⇒
false
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 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 true | Administrator | The user is an administrator | |
constant false | Regular user | The user is a regular user |
Sample curl
read command (note that :user_account_index
is a URL template argument):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/auth/users/:user_account_index/is_admin/"
⇒
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
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 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 uom
library write command (note that _user_account_index
is a variable):
uom.auth.users[_user_account_index].outlet_access={false,true,false,true,false,true,true,true,false,true,true,true,true,true,true,false,false,false,true,true,true,false,false,false,false,true,true,false,true,false,false,true}
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 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 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
read command (note that _user_account_index
and _outlet_access_index
are variables):
print(requests.get('http://192.168.0.100/restapi/auth/users/'+str(_user_account_index)+'/outlet_access/'+str(_outlet_access_index)+'/',auth=auth,headers=headers).json())
⇒
False
Sample uom
library deletion command (note that _user_account_index
and _outlet_access_index
are variables):
local composite=uom.copy(uom.auth.users[_user_account_index].outlet_access) uom.remove(composite,_outlet_access_index) uom.auth.users[_user_account_index].outlet_access=composite
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 uom
library client creation command:
uom.insert(uom.auth.clients,"BN",{access_tokens={0e0829f3bcb7c75a8dc622ff26062643={expiry_time=1631321064,remaining_use_count=null},eaba7623e7d64ad7dc7f2765eb9304be={expiry_time=null,remaining_use_count=57}},redirect_urls={https://Tn%8d]y=true,https://]]%76%d6]=true},refresh_tokens={d35659482749701d8cfcdd082e558df6={expiry_time=1627842869,remaining_use_count=null},ecb63bb814e382b70c868a230e4b5dc3={expiry_time=null,remaining_use_count=null}},scopes={dli+object+full:/script/start/=true,dli+object+read:/script/=true,dli+object+read:/script/start/=true},secret_hash="d17a31425b81843138357ad7931c9497"})
Sample CLI read command:
uom get "auth/clients"
⇒
...
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 CLI deletion command (note that client
is a variable):
uom remove "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/"
⇒
See also Client: Name
See also Client: Secret hash, if any
See also Client: Redirect URL set
See also Client: Scope set
See also Client: Refresh tokens
See also Client: Access tokens
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 requests
read command (note that _client
is a variable):
print(requests.get('http://192.168.0.100/restapi/auth/clients/'+_client+'/name/',auth=auth,headers=headers).json())
⇒
{}
Sample CLI write command (note that client
is a variable):
uom set "auth/clients/${client}/name" "[]"
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 requests
read command (note that _client
is a variable):
print(requests.get('http://192.168.0.100/restapi/auth/clients/'+_client+'/secret_hash/',auth=auth,headers=headers).json())
⇒
None
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/"
⇒
"90f681b3b8dd0a16612a2fa64f526710"
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 JS request
read command (note that _client
is a variable):
request.get({url:"auth/clients/"+_client+"/redirect_urls/"},function(error,response,body) {console.log(body)});
⇒
{"https://%Eb":true}
Sample uom
library write command (note that _client
is a variable):
uom.auth.clients[_client].redirect_urls={https://%Ac=true,https://%b6]%c12D%ac=true}
constant true | auth/clients/S/redirect_urls/S/ |
The given URL is allowed to receive redirection on successful login |
Sample uom
library deletion command (note that _client
and _allowed
are variables):
uom.remove(uom.auth.clients[_client].redirect_urls,_allowed)
Sample CLI deletion command (note that client
and allowed
are variables):
uom remove "auth/clients/${client}/redirect_urls/${allowed}"
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 CLI authorized creation command (note that client
is a variable):
uom insert "auth/clients/${client}/scopes/dli+object+read:/script/" "true"
Sample CLI write command (note that client
is a variable):
uom set "auth/clients/${client}/scopes" "{\"dli+object+read:/script/start/\":true,\"dli+object+read:/config/\":true}"
constant true | auth/clients/S/scopes/S/ |
The client is authorized to access the given scope |
Sample requests
read command (note that _client
and _authorized
are variables):
print(requests.get('http://192.168.0.100/restapi/auth/clients/'+_client+'/scopes/'+_authorized+'/',auth=auth,headers=headers).json())
⇒
True
Sample uom
library deletion command (note that _client
and _authorized
are variables):
uom.remove(uom.auth.clients[_client].scopes,_authorized)
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 uom
library token properties creation command (note that _client
is a variable):
uom.insert(uom.auth.clients[_client].refresh_tokens,"17d35ecbb79e1a690c20e36da1f81a72",{expiry_time=1631211154,remaining_use_count=46})
Sample JS request
token properties creation command (note that _client
is a variable):
request.put({url:"auth/clients/"+_client+"/refresh_tokens/11cdbddee5de5a5c85fec78da9e594eb/",body:{"expiry_time":1671766899,"remaining_use_count":null}});
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 JS request
write command (note that _client
and _token_properties
are variables):
request.put({url:"auth/clients/"+_client+"/refresh_tokens/"+_token_properties+"/",body:{"expiry_time":1615199841,"remaining_use_count":63}});
Sample CLI read command (note that client
and token_properties
are variables):
uom get "auth/clients/${client}/refresh_tokens/${token_properties}"
⇒
{"expiry_time":null,"remaining_use_count":9}
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 requests
read command (note that _client
and _token_properties
are variables):
print(requests.get('http://192.168.0.100/restapi/auth/clients/'+_client+'/refresh_tokens/'+_token_properties+'/expiry_time/',auth=auth,headers=headers).json())
⇒
1629929389
Sample CLI read command (note that client
and token_properties
are variables):
uom get "auth/clients/${client}/refresh_tokens/${token_properties}/expiry_time"
⇒
null
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: |
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
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/refresh_tokens/:token_properties/remaining_use_count/"
⇒
32
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)});
⇒
{"2a02ed2646328ace27bbe05baa7e68a8":{"expiry_time":1667733055,"remaining_use_count":null}}
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 "{\"c6286cc59fe399d56ab24b864ae7b547\":{\"expiry_time\":null,\"remaining_use_count\":98},\"2b7cb605fda6868c1136b2d672d39d5c\":{\"expiry_time\":null,\"remaining_use_count\":null}}" "http://192.168.0.100/restapi/auth/clients/:client/access_tokens/"
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 CLI read command (note that client
and token_properties
are variables):
uom get "auth/clients/${client}/access_tokens/${token_properties}"
⇒
{"expiry_time":1685113988,"remaining_use_count":null}
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":1605195725,"remaining_use_count":87}});
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 requests
read command (note that _client
and _token_properties
are variables):
print(requests.get('http://192.168.0.100/restapi/auth/clients/'+_client+'/access_tokens/'+_token_properties+'/expiry_time/',auth=auth,headers=headers).json())
⇒
1684394303
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:1660502178});
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: |
Sample curl
write command (note that :client
and :token_properties
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 "null" "http://192.168.0.100/restapi/auth/clients/:client/access_tokens/:token_properties/remaining_use_count/"
Sample CLI write command (note that client
and token_properties
are variables):
uom set "auth/clients/${client}/access_tokens/${token_properties}/remaining_use_count" "null"
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 uom
library read command:
print(uom.dump(uom.auth.realm))
⇒
{}
Sample JS request
write command:
request.put({url:"auth/realm/",body:[]});
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 CLI read command:
uom get "auth/cookie_timeout"
⇒
30000
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 "30000" "http://192.168.0.100/restapi/auth/cookie_timeout/"
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))
⇒
<...>
See also Notifications: Parameter kinds
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 JS request
read command:
request.get({url:"auth/notifications/events/"},function(error,response,body) {console.log(body)});
⇒
<...>
See also Events: Event
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 |
string | auth/notifications/parameter_kinds/auth_login/ |
The name of the user |
string | auth/notifications/parameter_kinds/auth_client_name/ |
The name of the client |
string | auth/notifications/parameter_kinds/auth_client_id/ |
The identifier of the client |
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])$
string | auth/notifications/parameter_kinds/auth_method/ |
The authentication method |
string | auth/notifications/parameter_kinds/auth_reason/ |
The reason for authentication decision |
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 |
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 |
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 CLI write command (note that event
and event_parameter_index
are variables):
uom set "auth/notifications/events/${event}/parameters/${event_parameter_index}" "{\"fixed_value\":null,\"has_fixed_value\":false,\"id\":\"auth_ip\"}"
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":null,"has_fixed_value":false,"id":"auth_login"}});
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 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)+'/id/',auth=auth,headers=headers).json())
⇒
'auth_ip'
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"
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 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)});
⇒
false
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/has_fixed_value/"
⇒
false
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 CLI read command (note that event
and event_parameter_index
are variables):
uom get "auth/notifications/events/${event}/parameters/${event_parameter_index}/fixed_value"
⇒
null
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
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
write command (note that _event
is a variable):
request.put({url:"auth/notifications/events/"+_event+"/",body:{"severity":6,"message_template":["modified user ",0],"parameters":[{"fixed_value":null,"has_fixed_value":false,"id":"auth_login"},{"fixed_value":true,"has_fixed_value":true,"id":"user_state"}]}});
Sample uom
library read command (note that _event
is a variable):
print(uom.dump(uom.auth.notifications.events[_event]))
⇒
{message_template={"created user ",0},parameters={{fixed_value=null,has_fixed_value=false,id="auth_login"},{fixed_value="new",has_fixed_value=true,id="user_state"}},severity=6}
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 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/message_template/"
⇒
["created user ",0]
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())
⇒
['deleted user ', 0]
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 curl
read command (note that :event
and :message_template_element_index
are URL template arguments):
curl --digest -u admin:1234 -H "Accept: application/json" "http://192.168.0.100/restapi/auth/notifications/events/:event/message_template/:message_template_element_index/"
⇒
"modified user "
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)});
⇒
"@"
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 uom
library read command (note that _event
is a variable):
print(uom.dump(uom.auth.notifications.events[_event].severity))
⇒
6
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
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 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': None, '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":null,"has_fixed_value":false,"id":"auth_ip"},{"fixed_value":null,"has_fixed_value":false,"id":"auth_method"},{"fixed_value":true,"has_fixed_value":true,"id":"auth_allowed"}]
See also Event parameters: Event parameter