Skip to content

SmartlockAuth

Get all smartlock authorizations for the account.

GET /smartlock/auth

Parameters:

Name Type Description Default
account_user_id int

Filter by account user ID.

 None
types str

Comma-separated authorization types, e.g., '0,2,3'.

 None

Returns:

Type Description
List[Dict[str, Any]]

list[dict]: List of SmartlockAuth objects.
Source code in nukiwebapi/smartlock_auth.py 
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
def list_auths(self, account_user_id: Optional[int] = None, types: Optional[str] = None) -> List[Dict[str, Any]]:
    """Get all smartlock authorizations for the account.

    GET /smartlock/auth

    Args:
        account_user_id (int, optional): Filter by account user ID.
        types (str, optional): Comma-separated authorization types, e.g., '0,2,3'.

    Returns:
        list[dict]: List of SmartlockAuth objects.
    """
    params = {}
    if account_user_id is not None:
        params["accountUserId"] = account_user_id
    if types is not None:
        params["types"] = types
    return self.client._request("GET", "/smartlock/auth", params=params).json()

Create asynchronous authorizations for multiple smartlocks.

PUT /smartlock/auth

Returns:

Type Description
None

None
Source code in nukiwebapi/smartlock_auth.py 
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
def create_auth_for_smartlocks(
    self,
    name: str,
    smartlock_ids: List[int],
    remote_allowed: bool,
    allowed_from_date: Optional[str] = None,
    allowed_until_date: Optional[str] = None,
    allowed_week_days: Optional[int] = None,
    allowed_from_time: Optional[int] = None,
    allowed_until_time: Optional[int] = None,
    account_user_id: Optional[int] = None,
    smart_actions_enabled: Optional[bool] = None,
    type: Optional[int] = 0,
    code: Optional[int] = None,
) -> None:
    """Create asynchronous authorizations for multiple smartlocks.

    PUT /smartlock/auth

    Returns:
        None
    """
    payload = {
        "name": name,
        "smartlockIds": smartlock_ids,
        "remoteAllowed": remote_allowed,
        "type": type,
    }
    if allowed_from_date is not None:
        payload["allowedFromDate"] = allowed_from_date
    if allowed_until_date is not None:
        payload["allowedUntilDate"] = allowed_until_date
    if allowed_week_days is not None:
        payload["allowedWeekDays"] = allowed_week_days
    if allowed_from_time is not None:
        payload["allowedFromTime"] = allowed_from_time
    if allowed_until_time is not None:
        payload["allowedUntilTime"] = allowed_until_time
    if account_user_id is not None:
        payload["accountUserId"] = account_user_id
    if smart_actions_enabled is not None:
        payload["smartActionsEnabled"] = smart_actions_enabled
    if code is not None:
        payload["code"] = code

    self.client._request("PUT", "/smartlock/auth", json=payload)

Update multiple authorizations asynchronously (POST /smartlock/auth).

Parameters:

Name Type Description Default
auth_list list[dict]

List of authorization update payloads.

 required

Returns:

Type Description
None

None
Source code in nukiwebapi/smartlock_auth.py 
82
83
84
85
86
87
88
89
90
91
def update_auths_bulk(self, auth_list: List[Dict[str, Any]]) -> None:
    """Update multiple authorizations asynchronously (POST /smartlock/auth).

    Args:
        auth_list (list[dict]): List of authorization update payloads.

    Returns:
        None
    """
    self.client._request("POST", "/smartlock/auth", json=auth_list)

Delete one or multiple authorizations.

DELETE /smartlock/auth

Parameters:

Name Type Description Default
ids list[str]

List of authorization IDs to delete.

 required

Returns:

Type Description
None

None
Source code in nukiwebapi/smartlock_auth.py 
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
def delete_auths(self, ids: List[str]) -> None:
    """Delete one or multiple authorizations.

    DELETE /smartlock/auth

    Args:
        ids (list[str]): List of authorization IDs to delete.

    Returns:
        None
    """
    self.client._request("DELETE", "/smartlock/auth", json=ids)

Get authorizations for a specific smartlock.

GET /smartlock/{smartlockId}/auth

Returns:

Type Description
List[Dict[str, Any]]

list[dict]: List of SmartlockAuth objects for the smartlock.
Source code in nukiwebapi/smartlock_auth.py 
107
108
109
110
111
112
113
114
115
116
def list_auths_for_smartlock(self, smartlock_id: int, types: Optional[str] = None) -> List[Dict[str, Any]]:
    """Get authorizations for a specific smartlock.

    GET /smartlock/{smartlockId}/auth

    Returns:
        list[dict]: List of SmartlockAuth objects for the smartlock.
    """
    params = {"types": types} if types else None
    return self.client._request("GET", f"/smartlock/{smartlock_id}/auth", params=params).json()

Create authorization for a single smartlock.

PUT /smartlock/{smartlockId}/auth

Returns:

Type Description
None

None
Source code in nukiwebapi/smartlock_auth.py 
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
def create_auth_for_smartlock(
    self,
    smartlock_id: int,
    name: str,
    remote_allowed: bool,
    allowed_from_date: Optional[str] = None,
    allowed_until_date: Optional[str] = None,
    allowed_week_days: Optional[int] = None,
    allowed_from_time: Optional[int] = None,
    allowed_until_time: Optional[int] = None,
    account_user_id: Optional[int] = None,
    smart_actions_enabled: Optional[bool] = None,
    type: Optional[int] = 0,
    code: Optional[int] = None,
) -> None:
    """Create authorization for a single smartlock.

    PUT /smartlock/{smartlockId}/auth

    Returns:
        None
    """
    payload = {
        "name": name,
        "remoteAllowed": remote_allowed,
        "type": type,
    }
    if allowed_from_date is not None:
        payload["allowedFromDate"] = allowed_from_date
    if allowed_until_date is not None:
        payload["allowedUntilDate"] = allowed_until_date
    if allowed_week_days is not None:
        payload["allowedWeekDays"] = allowed_week_days
    if allowed_from_time is not None:
        payload["allowedFromTime"] = allowed_from_time
    if allowed_until_time is not None:
        payload["allowedUntilTime"] = allowed_until_time
    if account_user_id is not None:
        payload["accountUserId"] = account_user_id
    if smart_actions_enabled is not None:
        payload["smartActionsEnabled"] = smart_actions_enabled
    if code is not None:
        payload["code"] = code

    self.client._request("PUT", f"/smartlock/{smartlock_id}/auth", json=payload)

Get a single authorization.

GET /smartlock/{smartlockId}/auth/{id}

Returns:

Name Type Description
dict Dict[str, Any]

SmartlockAuth object.
Source code in nukiwebapi/smartlock_auth.py 
164
165
166
167
168
169
170
171
172
def get_auth(self, smartlock_id: int, auth_id: str) -> Dict[str, Any]:
    """Get a single authorization.

    GET /smartlock/{smartlockId}/auth/{id}

    Returns:
        dict: SmartlockAuth object.
    """
    return self.client._request("GET", f"/smartlock/{smartlock_id}/auth/{auth_id}")

Update a single authorization asynchronously.

POST /smartlock/{smartlockId}/auth/{id}

Returns:

Type Description
None

None
Source code in nukiwebapi/smartlock_auth.py 
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
def update_auth(
    self,
    smartlock_id: int,
    auth_id: str,
    name: Optional[str] = None,
    allowed_from_date: Optional[str] = None,
    allowed_until_date: Optional[str] = None,
    allowed_week_days: Optional[int] = None,
    allowed_from_time: Optional[int] = None,
    allowed_until_time: Optional[int] = None,
    account_user_id: Optional[int] = None,
    enabled: Optional[bool] = None,
    remote_allowed: Optional[bool] = None,
    code: Optional[int] = None,
) -> None:
    """Update a single authorization asynchronously.

    POST /smartlock/{smartlockId}/auth/{id}

    Returns:
        None
    """
    payload = {}
    if name is not None:
        payload["name"] = name
    if allowed_from_date is not None:
        payload["allowedFromDate"] = allowed_from_date
    if allowed_until_date is not None:
        payload["allowedUntilDate"] = allowed_until_date
    if allowed_week_days is not None:
        payload["allowedWeekDays"] = allowed_week_days
    if allowed_from_time is not None:
        payload["allowedFromTime"] = allowed_from_time
    if allowed_until_time is not None:
        payload["allowedUntilTime"] = allowed_until_time
    if account_user_id is not None:
        payload["accountUserId"] = account_user_id
    if enabled is not None:
        payload["enabled"] = enabled
    if remote_allowed is not None:
        payload["remoteAllowed"] = remote_allowed
    if code is not None:
        payload["code"] = code

    self.client._request("POST", f"/smartlock/{smartlock_id}/auth/{auth_id}", json=payload)

Delete a single authorization.

DELETE /smartlock/{smartlockId}/auth/{id}

Returns:

Type Description
None

None
Source code in nukiwebapi/smartlock_auth.py 
220
221
222
223
224
225
226
227
228
def delete_auth(self, smartlock_id: int, auth_id: str) -> None:
    """Delete a single authorization.

    DELETE /smartlock/{smartlockId}/auth/{id}

    Returns:
        None
    """
    self.client._request("DELETE", f"/smartlock/{smartlock_id}/auth/{auth_id}")

Generate a shared key authorization.

POST /smartlock/{smartlockId}/auth/advanced/sharedkey

Returns:

Type Description
None

None
Source code in nukiwebapi/smartlock_auth.py 
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
def generate_shared_key_auth(
    self,
    smartlock_id: int,
    name: str,
    allowed_from_date: Optional[str] = None,
    allowed_until_date: Optional[str] = None,
    allowed_week_days: Optional[int] = None,
    allowed_from_time: Optional[int] = None,
    allowed_until_time: Optional[int] = None,
    account_user_id: Optional[int] = None,
) -> None:
    """Generate a shared key authorization.

    POST /smartlock/{smartlockId}/auth/advanced/sharedkey

    Returns:
        None
    """
    payload = {"name": name}
    if allowed_from_date is not None:
        payload["allowedFromDate"] = allowed_from_date
    if allowed_until_date is not None:
        payload["allowedUntilDate"] = allowed_until_date
    if allowed_week_days is not None:
        payload["allowedWeekDays"] = allowed_week_days
    if allowed_from_time is not None:
        payload["allowedFromTime"] = allowed_from_time
    if allowed_until_time is not None:
        payload["allowedUntilTime"] = allowed_until_time
    if account_user_id is not None:
        payload["accountUserId"] = account_user_id

    self.client._request(
        "POST",
        f"/smartlock/{smartlock_id}/auth/advanced/sharedkey",
        json=payload,
    )

Get a paginated list of authorizations.

GET /smartlock/auth/paged

Returns:

Name Type Description
dict Dict[str, Any]

Pagination response with results.
Source code in nukiwebapi/smartlock_auth.py 
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
def list_auths_paged(
    self,
    page: int = 0,
    size: int = 100,
    account_user_id: Optional[int] = None,
    types: Optional[str] = None,
) -> Dict[str, Any]:
    """Get a paginated list of authorizations.

    GET /smartlock/auth/paged

    Returns:
        dict: Pagination response with results.
    """
    params = {"page": page, "size": size}
    if account_user_id is not None:
        params["accountUserId"] = account_user_id
    if types is not None:
        params["types"] = types

    return self.client._request("GET", "/smartlock/auth/paged", params=params)