Class OAuthAction

Export Actions

Hierarchy

OffChainAction
- OAuthAction

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new OAuthAction(): OAuthAction

Inherited from OffChainAction.constructor
- Defined in src/libs/actions/offchain.action.ts:52
Constructor needs NetworkType passing as parameter.

Returns OAuthAction

Properties

Protected Readonly authProvider

authProvider: AuthProvider

AuthProvider provides all methods to handle authentication actions.

Protected Readonly cookieProvider

cookieProvider: CookieProvider

CookieProvider provides all methods to handle cookie actions.

Protected Readonly oauthProvider

oauthProvider: OAuthProvider

OAuthProvider provides all methods to handle fetching/patching oauth data.

Protected Readonly storageProvider

storageProvider: StorageProvider

Storage provides all methods to handle storage actions.

Protected Readonly userProvider

userProvider: UserProvider

UserProvider provides all methods to handle fetching/patching user data.

Methods

getAuthorizerUsers

getAuthorizerUsers(filters: { limit?: number; searchQuery: string; skip?: number; sort?: string }): Promise<PaginatedResponse<User>>

- Defined in src/libs/actions/oauth.action.ts:51
getAuthorizerUsers will retrieve users that authorized current auth client.

Parameters
- filters: { limit?: number; searchQuery: string; skip?: number; sort?: string }
  - Optional limit?: number
  - searchQuery: string
  - Optional skip?: number
  - Optional sort?: string
Returns Promise<PaginatedResponse<User>>

getPublicClientInfo

getPublicClientInfo(authClientKey: string): Promise<PublicAuthClientEntity>

- Defined in src/libs/actions/oauth.action.ts:35
getPublicClientInfo returns the public client info.

Parameters
- authClientKey: string
Returns Promise<PublicAuthClientEntity>

getUserInfo

getUserInfo(userId: string): Promise<User>

- Defined in src/libs/actions/oauth.action.ts:43
getUserInfo returns the user info via oauth credential.

Parameters
- userId: string
Returns Promise<User>

removeOAuthCredential

removeOAuthCredential(): void

- Defined in src/libs/actions/oauth.action.ts:27
The function to remove credential

Returns void

setOAuthCredential

setOAuthCredential(oauthCredential: OAuthCredential): void

- Defined in src/libs/actions/oauth.action.ts:16
The function to modify/delete credential

Parameters
- oauthCredential: OAuthCredential
Returns void

Generated using TypeDoc