Sign in
Authentication

Create anonymous user

Changed on

Create guest user without email/password.

User metadata (like display_name) can be included and will appear in realtime presence events. Requires enable_anonymous_signins to be true.

post/auth/signup-anonymous

Request

  • Base URL: https://api.volcano.dev
  • URL: https://api.volcano.dev/auth/signup-anonymous
  • Auth: HTTP bearer

Request body

user_metadataobject

Custom user metadata (e.g., display_name, avatar_url)

Example request

{
  "user_metadata": {
    "display_name": "Alice",
    "avatar_url": "https://example.com/alice.jpg"
  }
}

Response

Anonymous user created

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