Skip to main content

Simple Auth

Simple Auth is the existing ZeyOS authentication flow at /auth/v1. It accepts a username or email address and password at POST /login, then returns a persistent bearer token.

Existing integrations only

Simple Auth is deprecated for new integrations. Use OAuth 2.0 for new development. This reference remains available for applications that already use /auth/v1/login.

Base URL​

Text
https://cloud.zeyos.com/{INSTANCE}/auth/v1

Replace {INSTANCE} with the ZeyOS instance name.

Obtain a Token​

Bash
curl -X POST \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'name=john.doe' \
  --data-urlencode 'password=your-password' \
  --data-urlencode 'identifier=your-client-id' \
  https://cloud.zeyos.com/{INSTANCE}/auth/v1/login

The required fields are name, password, and identifier. Existing application integrations can additionally supply appsecret; accounts with two-factor authentication can supply otp; and expdate can set a custom token expiry timestamp.

A successful response contains the user and application identifiers, the bearer token, the client identifier, and the token expiry date.

JSON
{
  "user": 6,
  "application": 6,
  "token": "97c4281ea528ef02ba573fffce2fa80a3a8414b7",
  "identifier": "your-client-id",
  "expdate": 872838840
}

Send the token with subsequent REST API requests:

HTTP
Authorization: Bearer 97c4281ea528ef02ba573fffce2fa80a3a8414b7

Use GET /logout to invalidate the token explicitly.

OpenAPI Specification​

Download the Simple Auth OpenAPI specification for use with API clients and development tools.