Session and sign-out
Who you are signed in as, the sign-in methods this server offers, and signing out. 2 routes, from the API’s own OpenAPI document.
2 routes. Every path starts at https://cloud-api.qaldy.com. Sign-in, tokens, errors and limits are on the overview.
Routes#
| Method | Path | What it does |
|---|---|---|
| POST | /v1/auth/logout | Sign out |
| GET | /v1/session | Who is signed in |
Reference#
POST /v1/auth/logout#
Sign out.
- Authentication: the console’s session cookie.
- Token: not available. This route is for a signed-in person in the console (
403 console_onlyfor a token). - Who: signed in
Request body (application/json)
An empty object: {}.
Response 200
| Field | Type | Required | Notes |
|---|---|---|---|
ok | true | yes |
Errors: 400, 401, 403, 404, 409, 429 (the error format is on the overview).
GET /v1/session#
Who is signed in.
- Authentication: the console’s session cookie.
- Token: not available. This route is for a signed-in person in the console (
403 console_onlyfor a token). - Who: signed in
Response 200
| Field | Type | Required | Notes |
|---|---|---|---|
user | object | yes | |
user.kind | "user" | yes | |
user.id | string | yes | at least 1 characters |
user.name | string | yes | at least 1 characters |
user.email | string | yes | at least 3 characters |
user.initials | string | yes | 1 to 3 characters |
user.color | "sky" · "pool" · "bubblegum" · "leaf" · "lilac" · "sun" · "tangerine" · "tomato" | yes | |
workspaceId | string | yes | at least 1 characters |
workspaceRole | "owner" · "admin" · "builder" · "member" · "viewer" | yes | |
devLogin | boolean | yes |
Errors: 400, 401, 403, 404, 409, 429 (the error format is on the overview).