End a staff member’s read-only view

POST

/auth/impersonation/end

curl --request POST \
  --url https://api.sloose.com/auth/impersonation/end \
  --header 'Authorization: Bearer <token>'

• Production

Ends the session a staff member opened to see this organisation as one of its members (POST /staff/orgs/{orgId}/impersonate), and writes the end down. The widget’s banner calls this; a view that is not ended runs out on its own after an hour. A session that is not such a view is refused with 409 NOT_IMPERSONATING.

Session only.

Authorizations

• sessionAuth

Responses

200

Ended.

Media typeapplication/json

object

ok

required

boolean

Example

{
  "ok": true
}

401

The session is unknown or expired (code: AUTH_REQUIRED).

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

403

An API token was used (code: SESSION_REQUIRED). Like every route behind a session: a session signed in but in no organisation is refused code: NO_ORG, a banned person code: BANNED, and a closed organisation code: ORG_CLOSED.

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

409

This session is nobody’s view of anything (code: NOT_IMPERSONATING).

Media typeapplication/json

The error envelope every non-2xx answer uses.

object

error

required

Human-readable explanation.

string

code

Machine-readable reason. Absent on a few legacy 400s.

string

key

additional properties

Example^generated

{
  "error": "example",
  "code": "example"
}

503

The restore switch is on (code: MAINTENANCE): every route but /health and /robots.txt is refused before anything is read, except the operator’s own POST /staff/people/{id}/delete with the ADMIN_TOKEN. Sloose is down for maintenance. Please try again in a few minutes.

Media typeapplication/json

object

error

required

string

code

required

string

Allowed value: MAINTENANCE

Example

{
  "code": "MAINTENANCE"
}

Headers

Retry-After

integer

Seconds until asking again is worth it (300 while the switch is on).