Auth

Change password

Authorization

ApiKey

Authorization<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

old_password?Old password

new_password1?New password

new_password2?New password confirmation

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/auth/change-password" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Reset password

Authorization

ApiKey

Authorization<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

email?User username

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/auth/reset-password" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Reset password confirm

Authorization

ApiKey

Authorization<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

old_password?Old password

new_password1?New password

new_password2?New password confirmation

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/auth/reset-password-confirm" \  -H "Content-Type: application/json" \  -d '{}'

{  "token": "string"}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Authorization

ApiKey

Authorization<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

username?User username

email?User email

organization?User organization

password?User password

invitation_key?Invitation key

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/auth/signup" \  -H "Content-Type: application/json" \  -d '{}'

{  "token": "string"}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Authorization

ApiKey

Authorization<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

username?User username or email

password?User password

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/auth/token" \  -H "Content-Type: application/json" \  -d '{}'

{  "token": "string"}

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Trial Start

Authorization

ApiKey

Authorization<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name?name

email?Email

organization?Organization

plan?Plan

seats?Sets

details?

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/auth/trial" \  -H "Content-Type: application/json" \  -d '{}'

Empty

{}

{}

{}

{  "error": "string",  "code": 0,  "message": "string",  "details": [    {      "type_url": "string",      "value": "string"    }  ]}

Auth

200

204application/json

403application/json

404application/json

defaultapplication/json

200

204application/json

403application/json

404application/json

defaultapplication/json

200application/json

204application/json

403application/json

404application/json

defaultapplication/json

200application/json

204application/json

403application/json

404application/json

defaultapplication/json

200application/json

204application/json

403application/json

404application/json

defaultapplication/json

200

204application/json

403application/json

404application/json

defaultapplication/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`