Authentication & SSO API
Complete endpoints for local account registration, login, profile retrieval, and VynTech ID SSO Synchronization.
Base Path: /api/v1/auth
Register Local Account
Register a new local account and create an initial personal workspace.
Payload Example
{
"name": "Jane Doe",
"email": "jane@vyntech.com.au",
"password": "Password123!",
"org_name": "Acme Engineering"
}Status Codes
- Name
201- Type
- HTTP
- Description
- Account created and authenticated.
- Name
400- Type
- HTTP
- Description
- Validation error or email already taken.
- Name
name- Type
- string
- Required
- Description
- Full user display name.
- Name
email- Type
- string
- Required
- Description
- Valid email address for login.
- Name
password- Type
- string
- Required
- Description
- Password with minimum 8 characters.
- Name
org_name- Type
- string
- Description
- Optional name for initial organization workspace.
Request
POST/api/v1/auth/register
Response 201
Account Login
Authenticate existing credentials to receive a signed JWT access token.
Payload Example
{
"email": "engineer@vyntech.com.au",
"password": "Password123!"
}Status Codes
- Name
200- Type
- HTTP
- Description
- Successfully authenticated.
- Name
401- Type
- HTTP
- Description
- Invalid email or password.
- Name
email- Type
- string
- Required
- Description
- User account email.
- Name
password- Type
- string
- Required
- Description
- Account password.
Request
POST/api/v1/auth/login
Response 200
VynTech ID SSO Account SynchronizationAuth
Synchronize a user profile from VynTech ID single sign-on into the Zurvan workspace.
Payload Example
{
"vyntech_user_id": "vyn_usr_99812",
"email": "developer@vyntech.com.au",
"name": "Alex Smith",
"avatar_url": "https://cdn.vyntech.com.au/avatars/alex.png"
}Status Codes
- Name
200- Type
- HTTP
- Description
- User synchronized successfully.
- Name
401- Type
- HTTP
- Description
- Invalid SSO bearer token.
- Name
vyntech_user_id- Type
- string
- Required
- Description
- Unique user identifier from VynTech ID.
- Name
email- Type
- string
- Required
- Description
- Identity email address.
- Name
name- Type
- string
- Required
- Description
- Full name.
Request
POST/api/v1/auth/vyntech-sync
Response 200
Current User ProfileAuth
Retrieve the authenticated user's profile and active organization context.
Status Codes
- Name
200- Type
- HTTP
- Description
- Profile retrieved successfully.
- Name
401- Type
- HTTP
- Description
- Unauthorized.
Request
GET/api/v1/auth/me
Response 200