Interface CreateAnonymousSessionOptions

Options for creating a new anonymous session.

Metadata is set once at creation time and cannot be changed afterwards.

interface CreateAnonymousSessionOptions {
    audience?: string;
    metadata?: Record<string, string>;
    scope?: string;
}

Properties

audience? metadata? scope?

Properties

Optional audience

audience?: string

The API audience the access token should be scoped to. Must be a resource server that has allow_anonymous_access enabled.

Optional metadata

metadata?: Record<string, string>

Up to 1KB of arbitrary key-value metadata to attach to the anonymous session. Set once at creation time — cannot be changed after the session is created.

Optional scope

scope?: string

Space-separated list of scopes to request.

Settings

Member Visibility

Theme

On This Page

audiencemetadatascope