DLI DC3 Object Model Reference
20210819T152642Z
Credentials
objectcred/
Security attributes of agent performing request

This object contains the following items:

nameClient username, if any
is_adminAdministrative user
outlet_accessOutlet access permissions
agentAgent identifier
ip_addressClient IP address, if any

Sample requests read command:

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

{'ip_address': '192.168.0.5', 'is_admin': True, 'name': 'admin', 'agent': 'web ui', 'outlet_access': [True, True, True, True, True, True, True, 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 "{\"ip_address\":\"192.168.0.8\",\"is_admin\":true,\"name\":\"admin\",\"agent\":\"web ui\",\"outlet_access\":[true,true,true,true,true,true,true,true]}" "http://192.168.0.100/restapi/cred/"

Browse more samples

Client username, if any

sum (optional string)cred/name/
Username of the client, as verified by the agent, if any

This sum does not support direct modification.

This sum can assume the following values:

constant nullUsername absent or unknownUsername could not be obtained
stringClient usernameUsername of the client, as verified by the agent

Sample JS request read command:

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

"admin"

Sample uom library read command:

print(uom.dump(uom.cred.name))

"admin"

Browse more samples

Administrative user

sum (boolean)cred/is_admin/
Flag indicating whether the user is an administrator

This sum does not support direct modification.

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:

request.get({url:"cred/is_admin/"},function(error,response,body) {console.log(body)});

true

Sample curl read command:

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

true

Browse more samples

Outlet access permissions

sum (variant)cred/outlet_access/
Access settings for outlets
dot_inline_dotgraph_711.png

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

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

This sum does not support direct modification.

This sum can assume the following values:

constant trueFullState of all outlets can be manipulated by the user
constant falseNoneOutlet states cannot be neither seen nor manipulated by the user
arrayOutlet access levelsAccess levels per outlet

Sample uom library read command:

print(uom.dump(uom.cred.outlet_access))

{true,true,true,true,true,true,true,true}

Sample requests read command:

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

[True, True, True, True, True, True, True, True]

Browse more samples

See also Outlet access permissions: Outlet access levels

Outlet access permissions: Outlet access levels

(possibly) arraycred/outlet_access/
Access levels per outlet

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

This array contains Outlet access elements.

Creating elements in this collection is not supported.

Browse more samples

Outlet access

sum (boolean)cred/outlet_access/N/
Access level for outlet by index
dot_inline_dotgraph_712.png

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

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 trueFullOutlet state can be manipulated by the user
constant falseNoneOutlet state cannot be neither seen nor manipulated by the user

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

print(requests.get('http://192.168.0.100/restapi/cred/outlet_access/'+str(_outlet_access_index)+'/',auth=auth,headers=headers).json())

True

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

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

true

Browse more samples

Agent identifier

stringcred/agent/
Identifier of the agent performing request

This string does not support direct modification.

Sample CLI read command:

uom get "cred/agent"

"web ui"

Sample curl read command:

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

"web ui"

Browse more samples

Client IP address, if any

sum (optional string)cred/ip_address/
IPv4 address of the client performing request, if any

This sum does not support direct modification.

This sum can assume the following values:

constant nullClient IP address absent or unknownThe request is performed locally, or its origin is unknown
stringClient IP addressIPv4 address of the client performing requestthe 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])$

Sample uom library read command:

print(uom.dump(uom.cred.ip_address))

"192.168.0.8"

Sample CLI read command:

uom get "cred/ip_address"

"192.168.0.2"

Browse more samples