Sign in
Authentication

Sign in an auth user

Changed on

Authenticate with email and password. Requires an anon key.

Set session_mode to cookie to request HttpOnly refresh-token storage. Cookie mode is honored only for an exact, credentialed CORS origin on the same schemeful site as this API. Otherwise the response retains the refresh token in its body. A frontend on its default Volcano URL is cross-site with this API and so always gets the body token.

post/auth/signin

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/auth/signin
  • Auth: HTTP bearer

Request body

emailstring required
passwordstring required
session_mode'cookie'

Response

Signin successful

access_tokenstring required

JWT access token (expires after configured lifetime)

token_typestring required
expires_ininteger required

Access token lifetime in seconds

refresh_tokenstring

Long-lived token for getting new access tokens. Omitted when the request uses eligible HttpOnly cookie session storage.

Example response

{
  "token_type": "bearer"
}

Changes

  • 3a6f365f3f35Revision changes
    • ▲

      the response's body type changed from no type to object for status

    • ○

      added the optional property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

    • ○

      added the required property to the response with the status

  • bb44e98aba2eRevision changes
    • ▲

      the response's body type changed from object to no type for status

    • ▲

      removed the required property from the response with the status

    • ▲

      removed the required property from the response with the status

    • ▲

      removed the required property from the response with the status

    • ▲

      removed the required property from the response with the status

    • ▲

      removed the required property from the response with the status

    • ○

      added the new optional request property