v1.0.0

Authentication API v1

Download OpenAPI Document

JSON

Download OpenAPI Document

YAML

Authentication endpoints for sessions and personal access tokens

Contact

API Support

Servers

https://b10cks.testCurrent environment

---

Csrf Cookie

Operations

GET/auth/v1/csrf-cookie

---

Return an empty response simply to trigger the storage of the CSRF cookie in the browser

GET

/auth/v1/csrf-cookie

Return an empty response simply to trigger the storage of the CSRF cookie in the browser.

Responses

Successful response

GET

/auth/v1/csrf-cookie

Playground

Samples

---

Register

Operations

POST/auth/v1/register

---

Create register

POST

/auth/v1/register

Request Body

application/json

{

  

"firstname": "string",

  

"lastname": "string",

  

"email": "string",

  

"password": "string",

  

"invite_id": "string",

  

"invite_token": "string"

}

Responses

Successful response

POST

/auth/v1/register

Playground

Body

Samples

---

Token

Operations

POST/auth/v1/tokenDELETE/auth/v1/token

---

Create token

POST

/auth/v1/token

Responses

Successful response

POST

/auth/v1/token

Playground

Samples

---

Delete token

DELETE

/auth/v1/token

Responses

Successful response

DELETE

/auth/v1/token

Playground

Samples

---

Social

Operations

POST/auth/v1/social/2faGET/auth/v1/social/{provider}/redirectGET/auth/v1/social/{provider}/callbackGET/auth/v1/social/{provider}/linkGET/auth/v1/social/{provider}/link/callback

---

Create 2fa

POST

/auth/v1/social/2fa

Responses

Successful response

POST

/auth/v1/social/2fa

Playground

Samples

---

List redirect

GET

/auth/v1/social/{provider}/redirect

Parameters

Path Parameters

provider*

The provider identifier

Type

string

Required

Responses

Successful response

GET

/auth/v1/social/{provider}/redirect

Playground

Variables

Key

Value

provider*

Samples

---

List callback

GET

/auth/v1/social/{provider}/callback

Parameters

Path Parameters

provider*

The provider identifier

Type

string

Required

Responses

Successful response

GET

/auth/v1/social/{provider}/callback

Playground

Variables

Key

Value

provider*

Samples

---

List link

GET

/auth/v1/social/{provider}/link

Parameters

Path Parameters

provider*

The provider identifier

Type

string

Required

Responses

Successful response

GET

/auth/v1/social/{provider}/link

Playground

Variables

Key

Value

provider*

Samples

---

List callback

GET

/auth/v1/social/{provider}/link/callback

Parameters

Path Parameters

provider*

The provider identifier

Type

string

Required

Responses

Successful response

GET

/auth/v1/social/{provider}/link/callback

Playground

Variables

Key

Value

provider*

Samples

---

Logout

Operations

POST/auth/v1/logout

---

Create logout

POST

/auth/v1/logout

Responses

Successful response

POST

/auth/v1/logout

Playground

Samples

---

Impersonate

Operations

POST/auth/v1/impersonateDELETE/auth/v1/impersonate

---

Create impersonate

POST

/auth/v1/impersonate

Responses

Successful response

POST

/auth/v1/impersonate

Playground

Samples

---

Delete impersonate

DELETE

/auth/v1/impersonate

Responses

Successful response

DELETE

/auth/v1/impersonate

Playground

Samples

---

Broadcast

Operations

GET/auth/v1/broadcast

---

List broadcast

GET

/auth/v1/broadcast

Responses

Successful response

GET

/auth/v1/broadcast

Playground

Samples

---

Password

Operations

POST/auth/v1/password/emailPOST/auth/v1/password/reset

---

Create email

POST

/auth/v1/password/email

Responses

Successful response

POST

/auth/v1/password/email

Playground

Samples

---

Create reset

POST

/auth/v1/password/reset

Responses

Successful response

POST

/auth/v1/password/reset

Playground

Samples

---

One Time Token

Operations

POST/auth/v1/one-time-token/createPOST/auth/v1/one-time-token/login

---

Create create

POST

/auth/v1/one-time-token/create

Responses

Successful response

POST

/auth/v1/one-time-token/create

Playground

Samples

---

Create login

POST

/auth/v1/one-time-token/login

Responses

Successful response

POST

/auth/v1/one-time-token/login

Playground

Samples

---

Email

Operations

POST/auth/v1/email/verify/sendPOST/auth/v1/email/verifyGET/auth/v1/email/verify/{id}/{hash}

---

Create send

POST

/auth/v1/email/verify/send

Responses

Successful response

POST

/auth/v1/email/verify/send

Playground

Samples

---

Create verify

POST

/auth/v1/email/verify

Responses

Successful response

POST

/auth/v1/email/verify

Playground

Samples

---

Get a single verify

GET

/auth/v1/email/verify/{id}/{hash}

Responses

Successful response

GET

/auth/v1/email/verify/{id}/{hash}

Playground

Samples

---

2fa

Operations

GET/auth/v1/2fa/statusPOST/auth/v1/2fa/setupPOST/auth/v1/2fa/setup/confirmPOST/auth/v1/2fa/verifyPOST/auth/v1/2fa/disablePOST/auth/v1/2fa/backup-codes/regenerate

---

List status

GET

/auth/v1/2fa/status

Responses

Successful response

GET

/auth/v1/2fa/status

Playground

Samples

---

Create setup

POST

/auth/v1/2fa/setup

Responses

Successful response

POST

/auth/v1/2fa/setup

Playground

Samples

---

Create confirm

POST

/auth/v1/2fa/setup/confirm

Responses

Successful response

POST

/auth/v1/2fa/setup/confirm

Playground

Samples

---

Create verify

POST

/auth/v1/2fa/verify

Responses

Successful response

POST

/auth/v1/2fa/verify

Playground

Samples

---

Create disable

POST

/auth/v1/2fa/disable

Responses

Successful response

POST

/auth/v1/2fa/disable

Playground

Samples

---

Create regenerate

POST

/auth/v1/2fa/backup-codes/regenerate

Responses

Successful response

POST

/auth/v1/2fa/backup-codes/regenerate

Playground

Samples

---

Saml

Operations

GET/auth/v1/saml/{team}/redirectPOST/auth/v1/saml/{team}/acsGET/auth/v1/saml/{team}/slsGET/auth/v1/saml/{team}/metadata

---

List redirect

GET

/auth/v1/saml/{team}/redirect

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

GET

/auth/v1/saml/{team}/redirect

Playground

Variables

Key

Value

team*

Samples

---

Create acs

POST

/auth/v1/saml/{team}/acs

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

POST

/auth/v1/saml/{team}/acs

Playground

Variables

Key

Value

team*

Samples

---

List sls

GET

/auth/v1/saml/{team}/sls

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

GET

/auth/v1/saml/{team}/sls

Playground

Variables

Key

Value

team*

Samples

---

List metadata

GET

/auth/v1/saml/{team}/metadata

Parameters

Path Parameters

team*

The team identifier

Type

string

Required

Format

"uuid"

Responses

Successful response

GET

/auth/v1/saml/{team}/metadata

Playground

Variables

Key

Value

team*

Samples

---

Powered by VitePress OpenAPI