Skip to content
Bottle

How an account is kept safe

GET
/console/users/{id}/security
curl --request GET \
  --url https://example.com/console/users/example/security \
  --cookie bottle.session_token=<bottle.session_token>

Two-step sign-in and its method, whether there is a password and when it was last set, sessions open, and the last sign-in with its browser and system. Never a secret.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required
string
>= 1 characters

Responses

Section titled “Responses”

200

Section titled “200”

Security

Media typeapplication/json
object
twoFactor
required
object
enabled
required
boolean
method
required
string | null
Allowed values: totp otp
since
required
string | null format: date-time
hasPassword
required
boolean
passwordChangedAt
required
string | null format: date-time
activeSessions
required
integer
lastSignInAt
required
string | null format: date-time
lastDevice
required
object
browser
required
string | null
os
required
string | null
app
required
boolean
staffSince
required
string | null format: date-time
staffFromSettings
required
boolean
Example
{
  "twoFactor": {
    "method": "totp"
  }
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not Bottle staff, no two-step sign-in, or a console role too low for this

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

No such person

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}