Skip to content

@camera.ui/sdk / plugin / OAuthCapable

Interface: OAuthCapable

Defined in: plugin/oauth.ts:79

Base interface every OAuth-capable plugin implements, alongside at least one flow sub-interface. IdP-agnostic — the plugin brings its own endpoint config and knows nothing about the host's internals.

Extended by

Methods

disconnect()

disconnect(): Promise<void>

Defined in: plugin/oauth.ts:85

Revoke the current grant at the IdP and clear stored tokens.

Returns

Promise<void>


getOAuthMetadata()

getOAuthMetadata(): Promise<OAuthMetadata>

Defined in: plugin/oauth.ts:81

Return IdP display info, scope descriptions and the implemented flow sub-interfaces.

Returns

Promise<OAuthMetadata>


getOAuthState()

getOAuthState(): Promise<OAuthState>

Defined in: plugin/oauth.ts:83

Return a snapshot of the current lifecycle state; the host polls this to mirror progress.

Returns

Promise<OAuthState>