Skip to content
HDTPHDTP Docs

Statuses

View as Markdown

The choices an identity’s status may be set to, in the order to offer them, and how recent a use keeps Auto available

Section titled “The choices an identity’s status may be set to, in the order to offer them, and how recent a use keeps Auto available”

GET /v1/statuses · operation listStatusChoices

Requires the batondeck:identities:read permission (action identity:list).

Responses

Status Meaning
200 The choices an identity’s status may be set to, in the order to offer them, and how recent a use keeps Auto available
401 No portal session, and no live API key.
403 The policy refused, or the request was cross-site.
404 No such resource, or none this session may see.
200 response schema 
{
  "type": "object",
  "properties": {
    "statuses": {
      "type": "array",
      "items": {
        "type": "string",
        "enum": [
          "auto",
          "available",
          "not_available",
          "disabled"
        ]
      }
    },
    "auto_window_ms": {
      "type": "number"
    }
  },
  "required": [
    "statuses",
    "auto_window_ms"
  ],
  "additionalProperties": false
}
Terminal window
curl -X GET 'https://api.batondeck.com/v1/statuses' \
  -H "Authorization: Bearer $BATONDECK_API_KEY"