Auth
Sign in through the identity provider, and read or end your sessions. Each operation lists its method and path, parameters, request body, responses and an example call.
/api/v1/auth/callbackQuery Parameters
Header Parameters
Cookie Parameters
Response Body
application/problem+json
curl -X GET "https://example.com/api/v1/auth/callback"curl -X GET "https://example.com/api/v1/auth/config"{ "$schema": "https://example.com/AuthConfigOutputBody.json", "issuer": "string", "providerName": "string", "version": "string"}/api/v1/auth/sessionAn API token, sent as Authorization: Bearer <token>. A token belongs to one organization and has the role it was created with, so it needs no X-Nebula-Organization header; if you send one, it must name the token's organization.
In: header
Cookie Parameters
Response Body
application/json
application/problem+json
curl -X GET "https://example.com/api/v1/auth/session"{ "$schema": "https://example.com/SessionOutputBody.json", "organizations": [ { "id": "string", "name": "string", "role": "string", "slug": "string" } ], "sessions": [ { "createdAt": "2019-08-24T14:15:22Z", "current": true, "id": "string", "ip": "string", "userAgent": "string" } ], "user": { "email": "string", "id": "string", "name": "string", "picture": "string" }}/api/v1/auth/sessions/{id}An API token, sent as Authorization: Bearer <token>. A token belongs to one organization and has the role it was created with, so it needs no X-Nebula-Organization header; if you send one, it must name the token's organization.
In: header
Path Parameters
Response Body
application/problem+json
curl -X DELETE "https://example.com/api/v1/auth/sessions/string"/api/v1/auth/sign-outAn API token, sent as Authorization: Bearer <token>. A token belongs to one organization and has the role it was created with, so it needs no X-Nebula-Organization header; if you send one, it must name the token's organization.
In: header
Cookie Parameters
Response Body
application/json
application/problem+json
curl -X POST "https://example.com/api/v1/auth/sign-out"{ "$schema": "https://example.com/SignOutOutputBody.json", "endSessionUrl": "string"}curl -X GET "https://example.com/api/v1/auth/start"HTTP API
Authenticate to the NebulaCtrl HTTP API with an API token or a browser session, name the organization to act in, and read its errors, pages and event streams.
Installation
Describe this installation: its version, address and identity provider. Each operation lists its method and path, parameters, request body, responses and an example call.