API Tokens

Requesting authentication tokens for API access.

Warning: It is recommended to use a Service Account when accessing the LogSail API. Sharing email and passwords for a user account is not recommended when requesting API tokens for 3rd party access.

Basic Authentication

API tokens for the service account can be obtained through BasicAuth flow. This flow requires the knowledge of the service account email and password which can be exchanged for a bearer token and access token set. The following API route will return a token set with the access defined in the previous section.

Basic Sign In

Returns the refresh and jwt tokens for the user.

POSThttps://auth.logsail.com/users/basic/sign_in

Body

application/json

email*Email

password*Password

Response

200422

Successful Response

Body

application/json

access_token*Access Token

token_typeToken Type

expires_in*Expires In

refresh_token*Refresh Token

Pattern: ^(agents-|users-)[A-Za-z0-9-_]{128}$

Request

JavaScriptCurlPython

const response = await fetch('https://auth.logsail.com/users/basic/sign_in', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "email": "[e-mail]",
      "password": "text"
    }),
});
const data = await response.json();

Response

200422

{
  "access_token": "text",
  "token_type": "Bearer",
  "refresh_token": "text"
}

Within a successful response the client will have access to a refresh_token and access_token. Access tokens have an expiry time of 5 minutes and are used for all LogSail APIs. A refresh token expires in 24 hours and is rotated upon upon each refresh of an access token. The following API endpoint will rotate the token set expiring the previous token set minted.

Refresh Tokens

Mints a new access and refresh token.

POSThttps://auth.logsail.com/refresh/token

Header parameters

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://auth.logsail.com/refresh/token', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}

Revoking API tokens can be done using the following API endpoint.

Revoke Refresh Token

Expires the refresh token.

POSThttps://auth.logsail.com/refresh/revoke

Header parameters

Response

200422

Successful Response

Body

application/json

any

Request

JavaScriptCurlPython

const response = await fetch('https://auth.logsail.com/refresh/revoke', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

422

{
  "detail": [
    {
      "loc": [
        "text"
      ],
      "msg": "text",
      "type": "text"
    }
  ]
}