Mailmus

Auth

GET
/apps/{appId}/.well-known/jwks.json

Path Parameters

appId*string

Response Body

curl -X GET "https://example.com/apps/string/.well-known/jwks.json"
Empty
GET
/apps/{appId}/auth-settings

Path Parameters

appId*string

Response Body

curl -X GET "https://example.com/apps/string/auth-settings"
Empty
PATCH
/apps/{appId}/auth-settings

Path Parameters

appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X PATCH "https://example.com/apps/string/auth-settings" \  -H "Content-Type: application/json" \  -d '{}'
Empty
POST
/apps/{appId}/auth-settings/verify-domain

Path Parameters

appId*string

Response Body

curl -X POST "https://example.com/apps/string/auth-settings/verify-domain"
Empty
GET
/hosted-domains/{host}

Path Parameters

host*string

Response Body

curl -X GET "https://example.com/hosted-domains/string"
Empty
GET
/apps/{appId}/auth/hosted-config

Path Parameters

appId*string

Response Body

curl -X GET "https://example.com/apps/string/auth/hosted-config"
Empty
POST
/apps/{appId}/auth/sign-up

Path Parameters

appId*string

Header Parameters

authorization*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/auth/sign-up" \  -H "authorization: string" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "password": "string"  }'
Empty
POST
/apps/{appId}/auth/sign-in

Path Parameters

appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/auth/sign-in" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "password": "string"  }'
Empty
POST
/apps/{appId}/auth/refresh

Path Parameters

appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/auth/refresh" \  -H "Content-Type: application/json" \  -d '{    "refreshToken": "string"  }'
Empty
POST
/apps/{appId}/auth/sign-out

Path Parameters

appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/auth/sign-out" \  -H "Content-Type: application/json" \  -d '{    "refreshToken": "string"  }'
Empty
POST
/apps/{appId}/auth/magic-link

Path Parameters

appId*string

Header Parameters

authorization*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/auth/magic-link" \  -H "authorization: string" \  -H "Content-Type: application/json" \  -d '{    "email": "string"  }'
Empty
POST
/apps/{appId}/auth/magic-link/verify

Path Parameters

appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/auth/magic-link/verify" \  -H "Content-Type: application/json" \  -d '{    "token": "string"  }'
Empty
POST
/apps/{appId}/auth/otp

Path Parameters

appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/auth/otp" \  -H "Content-Type: application/json" \  -d '{    "email": "string"  }'
Empty
POST
/apps/{appId}/auth/otp/verify

Path Parameters

appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/auth/otp/verify" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "code": "string"  }'
Empty
POST
/apps/{appId}/auth/google/callback

Path Parameters

appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/auth/google/callback" \  -H "Content-Type: application/json" \  -d '{    "code": "string",    "redirectUri": "string"  }'
Empty
POST
/apps/{appId}/auth/github/callback

Path Parameters

appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/auth/github/callback" \  -H "Content-Type: application/json" \  -d '{    "code": "string",    "redirectUri": "string"  }'
Empty
POST
/apps/{appId}/auth/apple/callback

Path Parameters

appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/auth/apple/callback" \  -H "Content-Type: application/json" \  -d '{    "code": "string",    "redirectUri": "string"  }'
Empty
POST
/apps/{appId}/auth/forgot-password

Path Parameters

appId*string

Header Parameters

authorization*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/auth/forgot-password" \  -H "authorization: string" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "redirectUri": "string"  }'
Empty
POST
/apps/{appId}/auth/reset-password

Path Parameters

appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/auth/reset-password" \  -H "Content-Type: application/json" \  -d '{    "token": "string",    "newPassword": "string"  }'
Empty
POST
/apps/{appId}/auth/verify-email

Path Parameters

appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/auth/verify-email" \  -H "Content-Type: application/json" \  -d '{    "token": "string"  }'
Empty
POST
/apps/{appId}/auth/mfa/verify

Path Parameters

appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/auth/mfa/verify" \  -H "Content-Type: application/json" \  -d '{    "challengeToken": "string",    "code": "string"  }'
Empty
POST
/apps/{appId}/auth/mfa/enroll

Path Parameters

appId*string

Response Body

curl -X POST "https://example.com/apps/string/auth/mfa/enroll"
Empty
POST
/apps/{appId}/auth/mfa/confirm

Path Parameters

appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/auth/mfa/confirm" \  -H "Content-Type: application/json" \  -d '{    "code": "string"  }'
Empty
POST
/apps/{appId}/auth/mfa/disable

Path Parameters

appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/auth/mfa/disable" \  -H "Content-Type: application/json" \  -d '{    "code": "string"  }'
Empty
GET
/apps/{appId}/auth/sessions

Path Parameters

appId*string

Response Body

curl -X GET "https://example.com/apps/string/auth/sessions"
Empty
DELETE
/apps/{appId}/auth/sessions/{id}

Path Parameters

id*string
appId*string

Response Body

curl -X DELETE "https://example.com/apps/string/auth/sessions/string"
Empty
GET
/apps/{appId}/auth/organizations/mine

Path Parameters

appId*string

Response Body

curl -X GET "https://example.com/apps/string/auth/organizations/mine"
Empty
POST
/apps/{appId}/auth/organizations/active

Path Parameters

appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/auth/organizations/active" \  -H "Content-Type: application/json" \  -d '{    "organizationId": "string"  }'
Empty
DELETE
/apps/{appId}/auth/organizations/active

Path Parameters

appId*string

Response Body

curl -X DELETE "https://example.com/apps/string/auth/organizations/active"
Empty
DELETE
/apps/{appId}/auth/organizations/{organizationId}/members/me

Path Parameters

organizationId*string
appId*string

Response Body

curl -X DELETE "https://example.com/apps/string/auth/organizations/string/members/me"
Empty
POST
/apps/{appId}/auth/organizations/invitations/accept

Path Parameters

appId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/auth/organizations/invitations/accept" \  -H "Content-Type: application/json" \  -d '{    "token": "string"  }'
Empty
GET
/apps/{appId}/auth/organizations/invitations/{token}

Path Parameters

token*string
appId*string

Response Body

curl -X GET "https://example.com/apps/string/auth/organizations/invitations/string"
Empty
POST
/apps/{appId}/auth/sso/start

Path Parameters

appId*string

Header Parameters

authorization*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/auth/sso/start" \  -H "authorization: string" \  -H "Content-Type: application/json" \  -d '{    "email": "string",    "redirectUri": "string"  }'
Empty
POST
/apps/{appId}/auth/sso/{connectionId}/acs

Path Parameters

appId*string
connectionId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

curl -X POST "https://example.com/apps/string/auth/sso/string/acs" \  -H "Content-Type: application/json" \  -d '{    "SAMLResponse": "string",    "RelayState": "string"  }'
Empty