Current sign-in state

GET

/api/v1/auth/session

const url = 'https://example.com/api/v1/auth/session';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://example.com/api/v1/auth/session

Reports whether the caller has a valid session. Behind an SSO proxy with a matching trust token and no session cookie, creates a pangolin-sso session and sets the cookies.

Responses

200

Successful Response

application/json

SessionInfo

object

bootstrap

Bootstrap

boolean

bootstrap_variable

Bootstrap Variable

Any of:

string
null

string

csrf_token

Csrf Token

Any of:

string
null

string

scope

Scope

Any of:

string
null

string

Allowed values: read print admin

signed_in

required

Signed In

boolean

source

Source

Any of:

string
null

string

Allowed values: api-key pangolin-sso bootstrap

user

User

Any of:

string
null

string

Example

{
  "bootstrap": false,
  "scope": "read",
  "source": "api-key"
}