Restrict a User

post/public/v1/users/{user}/restrict

Signs an active user out everywhere and stops them signing in, while keeping them on the roster with their shifts and coordinator roles. A restricted user still counts towards the subscription, and any API keys they own keep working.

Refuses with a 409 when the user is not active, and with a 400 for the account owner.

post/public/v1/users/{user}/restrict

curl --request POST \
  --url 'https://api.app.astalty.com.au/public/v1/users/{user}/restrict' \
  --header 'Authorization: Bearer YOUR_API_KEY' \
  --header 'Accept: application/json'

Response

{
  "data": {
    "id": "u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e",
    "first_name": "John",
    "last_name": "Doe",
    "email": "john.doe@example.com",
    "status": "active",
    "employment_title": "Service Manager"
  }
}

Authorization

Authorizationstringrequired
Bearer authentication header of the form Bearer <token>, where <token> is your API key. See How to set up an API key.

Path parameters

userstringrequired
The user UUID

Response

200application/json

UserResource

dataobjectrequired
▶Show 6 child attributesHide child attributes
- idstringrequired
  Example:u1s2e3r4-a5b6-47c8-9d0e-1f2a3b4c5d6e
- first_namestringrequired
  Example:John
- last_namestringrequired
  Example:Doe
- emailstringrequired
  Example:john.doe@example.com
- statusenum<string>required
  Available options:activedeactivatedinvitedrestricted
- employment_titlestring | nullrequired
  Example:Service Manager

Errors

401Unauthenticated
403Authorization error
404Not found
409An error