Skip to content

SSOMessageType

@blobs/sdk v0.1.0


@blobs/sdk / sso / SSOMessageType

Defined in: sso/types.ts:182

Discriminator for SSO postMessage frames exchanged between the parent window (running SSOManager) and the SSO popup hosting the auth UI.

Protocol overview:

  1. Parent opens popup with requestId in the URL.
  2. Popup posts READY once its scripts are alive.
  3. On user action, popup posts SUCCESS (with SSOResult), ERROR (with SSOError), or CANCEL.
  4. Either side may send PING; the parent replies with PONG to keep the popup alive across long forms.

Every frame includes the originating requestId so the parent can ignore stale or unrelated messages.

Enumeration Members

READY

READY: "BLOBS_SSO_READY"

Defined in: sso/types.ts:184

Popup signals it has loaded and is ready to receive instructions.


SUCCESS

SUCCESS: "BLOBS_SSO_SUCCESS"

Defined in: sso/types.ts:186

Popup signals successful authentication; payload is an SSOResult.


ERROR

ERROR: "BLOBS_SSO_ERROR"

Defined in: sso/types.ts:188

Popup signals a failure; payload is an SSOError.


CANCEL

CANCEL: "BLOBS_SSO_CANCEL"

Defined in: sso/types.ts:190

Popup signals the user cancelled the flow.


PING

PING: "BLOBS_SSO_PING"

Defined in: sso/types.ts:192

Keepalive request from the popup.


PONG

PONG: "BLOBS_SSO_PONG"

Defined in: sso/types.ts:194

Keepalive response from the parent window.