Skip to main content

IdentityActions

Agent Runtimes

Agent Runtimes / identity/types / IdentityActions

Interface: IdentityActions

Defined in: identity/types.ts:176

Identity store actions

Properties​

cancelAuthorization​

cancelAuthorization: () => void

Defined in: identity/types.ts:191

Cancel pending authorization

Returns​

void

clearAll​

clearAll: () => void

Defined in: identity/types.ts:213

Clear all identities

Returns​

void

completeAuthorization​

completeAuthorization: (callback) => Promise<Identity>

Defined in: identity/types.ts:189

Complete OAuth flow with callback params

Parameters​

callback​

AuthorizationCallback

Returns​

Promise<Identity>

configureProvider​

configureProvider: (config) => void

Defined in: identity/types.ts:178

Configure an OAuth provider

Parameters​

config​

OAuthProviderConfig

Returns​

void

connectWithToken​

connectWithToken: (provider, token, options?) => Promise<Identity>

Defined in: identity/types.ts:193

Connect with a token directly (for token-based providers like Kaggle)

Parameters​

provider​

string

token​

string

options?​
displayName?​

string

iconUrl?​

string

userInfo?​

ProviderUserInfo

Returns​

Promise<Identity>

disconnect​

disconnect: (provider) => Promise<void>

Defined in: identity/types.ts:203

Disconnect a provider (revoke tokens)

Parameters​

provider​

string

Returns​

Promise<void>

getIdentity​

getIdentity: (provider) => Identity | undefined

Defined in: identity/types.ts:207

Get identity for a provider

Parameters​

provider​

string

Returns​

Identity | undefined

getToken​

getToken: (provider) => Promise<OAuthToken | null>

Defined in: identity/types.ts:211

Get token for a provider (refreshes if needed)

Parameters​

provider​

string

Returns​

Promise<OAuthToken | null>

isConnected​

isConnected: (provider) => boolean

Defined in: identity/types.ts:209

Check if provider is connected

Parameters​

provider​

string

Returns​

boolean

refreshToken​

refreshToken: (provider) => Promise<OAuthToken>

Defined in: identity/types.ts:205

Refresh token for a provider

Parameters​

provider​

string

Returns​

Promise<OAuthToken>

setError​

setError: (error) => void

Defined in: identity/types.ts:215

Set error

Parameters​

error​

Error | null

Returns​

void

startAuthorization​

startAuthorization: (provider, scopes?, options?) => Promise<string>

Defined in: identity/types.ts:180

Start OAuth flow for a provider

Parameters​

provider​

string

scopes?​

string[]

options?​
onComplete?​

(identity) => void

onError?​

(error) => void

Returns​

Promise<string>