Skip to content

Auth API (v3.2.1.1)

REST API logo

Download OpenAPI description
api.json
api.yaml
Overview
API Support Group

api@yellowdogsoftware.com

Languages
Servers
Production server

https://auth.yellowdogsoftware.com/

Get token via credential

Request

Bodyapplication/json
clientIdstring

This is an alphanumeric identifier of a specific Yellow Dog database.

Example: "ABC123"
userNamestring

This name identifies a user registered with the database represented by the clientId. If this user has API access privileges, they will be able to request an access token.

Example: "bi_dashboard_api_key"
passwordstring

This password completes a credential for a given user within a specific database.

Example: "xyz-123-abc-789-pqr"
curl -i -X POST \
  https://auth.yellowdogsoftware.com/token \
  -H 'Content-Type: application/json' \
  -d '{
    "clientId": "ABC123",
    "userName": "bi_dashboard_api_key",
    "password": "xyz-123-abc-789-pqr"
  }'

Responses

OK

Bodyapplication/json
successstring
Example: true
resultobject
errorsstring or null
Example: null
Response
application/json
{
  "success": true,
  "result": {
    "accessToken": "xxxxx.yyyyy.zzzzz",
    "refreshToken": "01234567-0123-abcd-0123-abcdef012345",
    "tokenType": "bearer",
    "clientId": 3210,
    "databaseVersion": 377,
    "expiresIn": 3600,
    "expires": "2025-10-20T14:45:06Z",
    "isUser": true,
    "authType": 1
  },
  "errors": null
}

Get token via refresh token

Request

Bodyapplication/json
clientIdstring

This is an alphanumeric identifier of a specific Yellow Dog database.

Example: "ABC123"
refreshTokenstring

A UUID representing a refresh token.

Example: "01234567-0123-abcd-0123-abcdef012345"
curl -i -X POST \
  https://auth.yellowdogsoftware.com/refreshToken \
  -H 'Content-Type: application/json' \
  -d '{
    "clientId": "ABC123",
    "refreshToken": "01234567-0123-abcd-0123-abcdef012345"
  }'

Responses

OK

Bodyapplication/json
successstring
Example: true
resultobject
errorsstring or null
Example: null
Response
application/json
{
  "success": true,
  "result": {
    "accessToken": "xxxxx.yyyyy.zzzzz",
    "refreshToken": "01234567-0123-abcd-0123-abcdef012345",
    "tokenType": "bearer",
    "clientId": 3210,
    "databaseVersion": 377,
    "expiresIn": 3600,
    "expires": "2025-10-20T14:45:06Z",
    "isUser": true,
    "authType": 1
  },
  "errors": null
}