EkeyV2

Add a user who can access a lock

post/ekey/v2/locks/{serial_number}/users/{idstr}

Request

  • Base URL: https://api.danalock.com
  • URL: https://api.danalock.com/ekey/v2/locks/{serial_number}/users/{idstr}
  • Auth: OAuth 2 (authorization code, authorization URL /oauth2/authorize, token URL /oauth2/token)

Path parameters

serial_numberstring serialnumber required
Example:ab:cd:ef:12:34:56
idstrstring required

Username or e-mail address (URL Encoded).

Headers

X-Assume-Userstring

Assume the identity of the user in another domain

Request body

typestring

Invitation type. It is recommended to always use the default value.

timezonestring

The time zone, where the link is used. Please see <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones" target="_blank">online references</a>.

startnumber

Start time of link validity in UNIX UTC time.

end=0number

End time of link validity in UNIX UTC time (Default: No end).

weeksnumber

How many weeks does this cover? weeks takes precedence over end. (Default: repeat until end (above) or The end of time, which ever comes first).

weekdaysstring

Space separated weekdays from the set [mon tue wed thu fri sat sun]. (Default: all weekdays).

dailystartstring

Start time of the day. format HH:MM (default:00:00).

dailyendstring

End time of the day. format HH:MM (default:23:59).

intervalnumber

Mobile lifetime of the key (in seconds).

mobilelifenumber

Mobile lifetime of the key (in minutes).

watchnumber

Owner wants to watch this link (1 = yes, 0 = no; default = 1).

remotenumber

Owner wants to allow remote access (1 = yes, 0 = no; default = 0).

externalidnumber

Reference identifier to external systems (default: 0 if none).

externaltypenumber

Reference type identifier to external systems in binary format (default: 0 if none).

tokenonlynumber

Return token only (1 = yes, 0 = no; default = 0).

Response

The user was successfully invited.

Empty required

Changes

No recorded changes to this operation across all 1 revision of this API.