Login API

The login endpoints are implementing an OAuth2 flow.

Acquire token with OAuth2 authorization

Gets a token by authorizing with an external OAuth2 provider. Currently only github is supported.

In the response:

• id is the identifier of the token itself
• accountId is the account's identifier, can be used on the account API
• secret is the secret key to be sent in the Authorization header as a bearer token for all the other endpoints

Query Parameters

Example Response JSON

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "accountId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "expiresAt": "2019-08-24T14:15:22Z"
  },
  "secret": {
    "value": "a860a344-d7b2-406e-828e-8d442f23f344"
  }
}

Get information about a token

Gets information about a token that is selected by the secret key passed in the Authorization header. The JSON is the same as the data object in the oauth2 endpoint's response.

Example Response JSON

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "accountId": "string",
  "createdAt": "2019-08-24T14:15:22Z",
  "expiresAt": "2019-08-24T14:15:22Z"
}

Start GitHub OAuth2 interactive flow

Starts an interactive authorization flow. The user must open the returned url and enter the userCode in a form before the expires deadline. Then the finish GitHub OAuth2 interactive flow endpoint must be called with the encoded session to finish the flow.

Example Response JSON

{
  "url": "string",
  "userCode": "string",
  "expires": "2019-08-24T14:15:22Z",
  "encodedSession": "string"
}

Finish GitHub OAuth2 interactive flow

Finishes an interactive authorization flow. The returned JSON is equivalent to the oauth2 endpoint's response. Returns a JSON string containing the encodedSession from the start endpoint's response.

Example Request JSON

"string"

Example Response JSON

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "accountId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "expiresAt": "2019-08-24T14:15:22Z"
  },
  "secret": {
    "value": "a860a344-d7b2-406e-828e-8d442f23f344"
  }
}

Initiate OAuth2 Web Flow

Starts the OAuth2 web flow authorization process by returning the authorization URL for the given provider.

Query Parameters

Example Response JSON

{
  "url": "string",
  "state": "string"
}

GitHub OAuth2 Web Flow callback

This endpoint handles the callback from GitHub after the user has authorized the application. It exchanges the code for an access token and then uses that to log the user in.

Query Parameters

Example Response JSON

{}

Poll for OAuth2 Web Flow token

This endpoint is used by clients to poll for the token after the user has authorized the application via the web flow.

Query Parameters

Example Response JSON

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "accountId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "expiresAt": "2019-08-24T14:15:22Z"
  },
  "secret": {
    "value": "a860a344-d7b2-406e-828e-8d442f23f344"
  }
}

Login API Errors