Skip to content
API Reference/
/
User Login

Exolink API (1.0.0)

Download OpenAPI description
exolink_api.json
exolink_api.yaml
Overview
Exolink Support
support@exolink.com
Languages
Servers
Mock server
https://guides.exolink.com/_mock/apis/exolink_api
https://api.exolink.cloud

Public

Public endpoints

Operations

Auth

Authentication and authorization endpoints

Operations

User Signup

Request

Register a new user account

Bodyapplication/jsonrequired
usernamestring(email)required

User's email address

Example: "user@example.com"
givenNamestringrequired

User's first name

Example: "John"
familyNamestringrequired

User's last name

Example: "Doe"
curl -i -X POST \
  https://guides.exolink.com/_mock/apis/exolink_api/auth/signup \
  -H 'Content-Type: application/json' \
  -d '{
    "username": "user@example.com",
    "givenName": "John",
    "familyName": "Doe"
  }'

Responses

User registered successfully

Confirm User Signup

Request

Confirm user registration with verification code

Bodyapplication/jsonrequired
usernamestring(email)required

User's email address

codestringrequired

Verification code sent to email

Example: "873858"
passwordstring(password)required

User's password

curl -i -X POST \
  https://guides.exolink.com/_mock/apis/exolink_api/auth/confirm \
  -H 'Content-Type: application/json' \
  -d '{
    "username": "user@example.com",
    "code": "873858",
    "password": "pa$$word"
  }'

Responses

User confirmed successfully

Bodyapplication/json
Tokenobject

Authentication tokens

UserInfoobject(UserInfo)
Settingsobject

User settings including default tenant

Response
application/json
{
  "Token": {
    "AccessToken": "string",
    "RefreshToken": "string",
    "IdToken": "string"
  },
  "UserInfo": {
    "userId": "string",
    "username": "string",
    "email": "string",
    "givenName": "string",
    "familyName": "string",
    "mfa": true,
    "perms": { … }
  },
  "Settings": {
    "default": { … }
  }
}

User Login

Request

Authenticate user and return access tokens

Bodyapplication/jsonrequired
usernamestring(email)required

User's email address

passwordstring(password)required

User's password

invitationstring

Optional invitation token

sessionstring

MFA session token (if continuing MFA flow)

codestring

MFA verification code (if continuing MFA flow)

curl -i -X POST \
  https://guides.exolink.com/_mock/apis/exolink_api/auth/login \
  -H 'Content-Type: application/json' \
  -d '{
    "username": "user@example.com",
    "password": "pa$$word",
    "invitation": "string",
    "session": "string",
    "code": "string"
  }'

Responses

Login successful

Bodyapplication/json
Tokenobject

Authentication tokens

UserInfoobject(UserInfo)
Settingsobject

User settings including default tenant

Response
application/json
{
  "Token": {
    "AccessToken": "string",
    "RefreshToken": "string",
    "IdToken": "string"
  },
  "UserInfo": {
    "userId": "string",
    "username": "string",
    "email": "string",
    "givenName": "string",
    "familyName": "string",
    "mfa": true,
    "perms": { … }
  },
  "Settings": {
    "default": { … }
  }
}

Refresh Access Token

Request

Get new access token using refresh token

Bodyapplication/jsonrequired
refreshTokenstringrequired

Refresh token from previous authentication

curl -i -X POST \
  https://guides.exolink.com/_mock/apis/exolink_api/auth/refresh \
  -H 'Content-Type: application/json' \
  -d '{
    "refreshToken": "string"
  }'

Responses

Token refreshed successfully

Bodyapplication/json
Tokenobject

Authentication tokens

UserInfoobject(UserInfo)
Settingsobject

User settings including default tenant

Response
application/json
{
  "Token": {
    "AccessToken": "string",
    "RefreshToken": "string",
    "IdToken": "string"
  },
  "UserInfo": {
    "userId": "string",
    "username": "string",
    "email": "string",
    "givenName": "string",
    "familyName": "string",
    "mfa": true,
    "perms": { … }
  },
  "Settings": {
    "default": { … }
  }
}

Initiate Password Reset

Request

Send password reset code to user email

Bodyapplication/jsonrequired
usernamestringrequired

User's email address

curl -i -X POST \
  https://guides.exolink.com/_mock/apis/exolink_api/auth/forgot \
  -H 'Content-Type: application/json' \
  -d '{
    "username": "string"
  }'

Responses

Password reset initiated

Validate Access Token

Request

Check if the provided access token is valid

Security
bearerToken
curl -i -X GET \
  https://guides.exolink.com/_mock/apis/exolink_api/auth/valid \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Token is valid

User

User management endpoints

Operations

Product

Product and pricing endpoints

Operations

Static

Static configuration endpoints

Tenant

Tenant management endpoints

Operations

CPMS

CPMS management endpoints

Operations

Charger

Charger management endpoints

Operations

Lab

Lab management endpoints

Operations

Logs

Log endpoints

Operations

Domain

Custom Domain endpoints

Operations