camera.ui Node SDK

Appearance

@camera.ui/sdk / plugin / OAuthClientCredentialsCapable

Interface: OAuthClientCredentialsCapable ​

Defined in: plugin/oauth.ts:119

Implemented by plugins that authenticate with a user-supplied client_id + client_secret (no user redirect). The plugin validates by fetching a token immediately.

Extends ​

Methods ​

configureClientCredentials() ​

configureClientCredentials(clientId, clientSecret): Promise<OAuthState>

Defined in: plugin/oauth.ts:121

Store the supplied credentials and fetch an initial token to validate them.

Parameters ​

clientId ​

string

clientSecret ​

string

Returns ​

Promise<OAuthState>

disconnect() ​

disconnect(): Promise<void>

Defined in: plugin/oauth.ts:85

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

Returns ​

Promise<void>

Inherited from ​

OAuthCapable.disconnect

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>

Inherited from ​

OAuthCapable.getOAuthMetadata

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>

Inherited from ​

OAuthCapable.getOAuthState