auth

Getting Started

The Yellow Dog auth api implements OAuth 2.0 security framework.

• Getting Started - Permissions
• Access Token
  • POST /token
    • Request Body
    • Response
• Refresh Token
  • POST /refreshToken
    • Request Body
    • Response

---

Base URL: https://auth.yellowdogsoftware.com/

• Username
  Managed in Yellow Dog Client

• Password
  Managed in Yellow Dog Client

• Client ID
  Provided by Yellow Dog

Permissions

Are based on employee access options

Access Token

Access tokens provide the ability to interact with Yellow Dog’s Web APIs.

To get a valid access token you’ll need to provide a userName, password, and clientId.

• Valid for 1 hour

POST /token

Request Body

{
  "userName": "string",
  "password": "string",
  "clientId": "string"
}

Response

{
    "success": true,
    "result": {
        "accessToken": "{some access token}",
        "refreshToken": "{some refresh token}",
        "tokenType": "bearer",
        "clientId": "{your client id}",
        "expiresIn": 3600,
        "expires": "2018-07-23T16:04:31Z",
        "isUser": true
    },
    "errors": null
}

Refresh Token

POST /refreshToken

Refresh tokens are used to get a new access token without having to resubmit user credentials.

• Valid for 30 days. After 30 days, you’ll have to resubmit user credentials.
• Can only be used once.

Request Body

{
"refreshToken": "{some refresh token}", // "2ecet06a-bd6a-4f94-a24a-452zt5f2c999"
"clientId" : "{your client id}", // "123456"
}

Response

{
    "success": true,
    "result": {
        "accessToken": "{some access token}",
        "refreshToken": "{some refresh token}",
        "tokenType": "bearer",
        "clientId": "{your client id}",
        "expiresIn": 3600,
        "expires": "2018-07-23T16:06:35Z",
        "isUser": true
    },
    "errors": null
}