Skip to content
API Catalog/
Vanda Analytics Timeserie...
/
/Authentication

AuthAPI (0.1.0)

A microservice to generate downloadable exports for charts and dashboards.

Download OpenAPI description
vanda-msvc-auth.json
vanda-msvc-auth.yaml
Languages
Servers
Mock server
https://dev-docs.vanda-analytics.com/_mock/apis/vanda-msvc-auth

Utility

Operations

Authentication

Operations

Login For Access Token

Request

Authenticates a user and returns an access token (JWT).

Bodyapplication/jsonrequired
usernamestring(Username)required
Example: "john.doe"
passwordstring(Password)required
Example: "secure_password_123"
curl -i -X POST \
  https://dev-docs.vanda-analytics.com/_mock/apis/vanda-msvc-auth/auth/login \
  -H 'Content-Type: application/json' \
  -d '{
    "username": "john.doe",
    "password": "secure_password_123"
  }'

Responses

Successful Response

Bodyapplication/json
access_tokenstring(Access Token)required
Example: "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9..."
token_typestring(Token Type)
Default "bearer"
Example: "bearer"
Response
application/json
{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "bearer"
}

Read User Profile

Request

Returns the profile and entitlements for the currently authenticated user.

Requires a valid JWT in the Authorization header.

Security
HTTPBearer
curl -i -X GET \
  https://dev-docs.vanda-analytics.com/_mock/apis/vanda-msvc-auth/auth/me \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/json
user_idstring(User Id)required
Example: "u4567"
usernamestring(Username)required
Example: "john.doe"
emailstring(Email)required
Example: "john.doe@company.com"
full_namestring(Full Name)required
Example: "John Doe"
is_activeboolean(Is Active)
Default true
rolesArray of strings(Roles)required
Example: ["admin","editor"]
entitlementsArray of strings(Entitlements)required
Example: ["exports:create","charts:read_all"]
Response
application/json
{
  "user_id": "u4567",
  "username": "john.doe",
  "email": "john.doe@company.com",
  "full_name": "John Doe",
  "is_active": true,
  "roles": [
    "admin",
    "editor"
  ],
  "entitlements": [
    "exports:create",
    "charts:read_all"
  ]
}

Get All Roles

Request

Returns a list of all defined roles and their associated permissions.

Security
HTTPBearer
curl -i -X GET \
  https://dev-docs.vanda-analytics.com/_mock/apis/vanda-msvc-auth/auth/roles \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Successful Response

Bodyapplication/jsonArray [
role_namestring(Role Name)required
Example: "admin"
descriptionstring(Description)required
Example: "Full access to all systems."
permissionsArray of strings(Permissions)required
Example: ["users:manage","reports:view_all","exports:*"]
]
Response
application/json
[
  {
    "role_name": "admin",
    "description": "Full access to all systems.",
    "permissions": [ … ]
  }
]