Skip to main content
PUT
Set Login PIN
The key’s user must hold both CAN_MANAGE_USERS and CAN_MANAGE_USERS_PASSWORD. Setting a login PIN lets that user sign in via PIN, so this is treated as a privileged, admin-only action (same as resetting a password) — a key without those permissions gets a 403.

Authorizations

x-client-key
string
header
required

Client API key for authentication

x-client-secret
string
header
required

Client secret for authentication

Body

application/json
userId
string<uuid>
required

ID of the user to set the PIN for

pin
string
required

PIN to assign to the user (4-6 digits)

Pattern: ^[0-9]{4,6}$

Response

PIN set successfully

data
object
extra_meta
object