User Login

POST

/auth/login

curl --request POST \
  --url https://api.exolink.cloud/auth/login \
  --header 'Content-Type: application/json' \
  --data '{ "username": "hello@example.com", "password": "example", "invitation": "example", "session": "example", "code": "example" }'

• Exolink Production

Authenticate user, confirm multi-factor authentication and return access tokens

Request Body^required

Media typeapplication/json

object

username

required

User’s email address

string format: email

password

required

User’s password

string format: password

invitation

Optional invitation token

string

session

MFA session token (if continuing MFA flow)

string

code

MFA verification code (if continuing MFA flow)

string

Example^generated

{
  "username": "hello@example.com",
  "password": "example",
  "invitation": "example",
  "session": "example",
  "code": "example"
}

Responses

200

Login successful

Media typeapplication/json

object

Token

Authentication tokens

object

AccessToken

JWT access token for API requests

string

RefreshToken

Token for refreshing access tokens

string

IdToken

ID token containing user identity claims

string

UserInfo

object

userId

Unique identifier for the user (UUID)

string

username

User’s email address

string

email

User’s email address

string

givenName

User’s first name

string

familyName

User’s last name

string

mfa

Whether multi-factor authentication is enabled

boolean

perms

User permissions per tenant (tenant domain prefix -> role mapping)

object

key

additional properties

string

Settings

User settings including default tenant

object

default

object

tenant

Default tenant domain prefix

string

Example^generated

{
  "Token": {
    "AccessToken": "example",
    "RefreshToken": "example",
    "IdToken": "example"
  },
  "UserInfo": {
    "userId": "example",
    "username": "example",
    "email": "example",
    "givenName": "example",
    "familyName": "example",
    "mfa": true,
    "perms": {
      "additionalProperty": "example"
    }
  },
  "Settings": {
    "default": {
      "tenant": "example"
    }
  }
}