Appearance
PUT
/admin/auth/users/{userId}/pinRequired scope:
user:updateSets the user's store PIN, replacing any previous one and clearing any lockout. The PIN is never returned.
Parameters ​
Path parameters
userId stringRequest body ​
JSON
{
"pin": "..."
}
Response ​
The PIN was set.
| Error code | Description |
|---|---|
auth.pin.invalid-format | The PIN must be 4 to 6 digits. |
auth.pin.too-trivial | The PIN is too easy to guess (uniform or sequential digits). |
auth.user.credentials-managed-elsewhere | The user also belongs to other tenants or is a system administrator; only a system administrator can manage their credentials. |
auth.user.interactive-sign-in-required | Credentials can only be managed from a signed-in session. |
auth.user.not-found | No such user in this tenant. |