Type Alias OAuth2Client

type OAuth2Client = {
    createOAuth2Client(
        clientId: string,
        clientData: OAuth2ClientSkeleton,
    ): Promise<OAuth2ClientSkeleton>;
    createOAuth2ClientExportTemplate(): OAuth2ClientExportInterface;
    deleteOAuth2Client(clientId: string): Promise<OAuth2ClientSkeleton>;
    deleteOAuth2Clients(): Promise<OAuth2ClientSkeleton[]>;
    exportOAuth2Client(
        clientId: string,
        options?: OAuth2ClientExportOptions,
    ): Promise<OAuth2ClientExportInterface>;
    exportOAuth2Clients(
        options?: OAuth2ClientExportOptions,
        resultCallback?: ResultCallback<OAuth2ClientSkeleton>,
    ): Promise<OAuth2ClientExportInterface>;
    importFirstOAuth2Client(
        importData: OAuth2ClientExportInterface,
        options?: OAuth2ClientImportOptions,
    ): Promise<OAuth2ClientSkeleton>;
    importOAuth2Client(
        clientId: string,
        importData: OAuth2ClientExportInterface,
        options?: OAuth2ClientImportOptions,
    ): Promise<OAuth2ClientSkeleton>;
    importOAuth2Clients(
        importData: OAuth2ClientExportInterface,
        options?: OAuth2ClientImportOptions,
    ): Promise<OAuth2ClientSkeleton[]>;
    readOAuth2Client(clientId: string): Promise<OAuth2ClientSkeleton>;
    readOAuth2Clients(): Promise<OAuth2ClientSkeleton[]>;
    updateOAuth2Client(
        clientId: string,
        clientData: OAuth2ClientSkeleton,
    ): Promise<OAuth2ClientSkeleton>;
}

Index

Methods

createOAuth2Client createOAuth2ClientExportTemplate deleteOAuth2Client deleteOAuth2Clients exportOAuth2Client exportOAuth2Clients importFirstOAuth2Client importOAuth2Client importOAuth2Clients readOAuth2Client readOAuth2Clients updateOAuth2Client

Methods

createOAuth2Client

createOAuth2Client(
clientId: string,
clientData: OAuth2ClientSkeleton,
): Promise<OAuth2ClientSkeleton>
Create OAuth2 client
Parameters
- clientId: string
  client id
- clientData: OAuth2ClientSkeleton
  oauth2client object
Returns Promise<OAuth2ClientSkeleton>
a promise that resolves to an oauth2client object
- Defined in ops/OAuth2ClientOps.ts:52

createOAuth2ClientExportTemplate

createOAuth2ClientExportTemplate(): OAuth2ClientExportInterface
Create an empty OAuth2 client export template

Returns OAuth2ClientExportInterface
an empty OAuth2 client export template
- Defined in ops/OAuth2ClientOps.ts:34

deleteOAuth2Client

deleteOAuth2Client(clientId: string): Promise<OAuth2ClientSkeleton>
Delete OAuth2 client
Parameters
- clientId: string
  client id
Returns Promise<OAuth2ClientSkeleton>
a promise that resolves to an oauth2client object
- Defined in ops/OAuth2ClientOps.ts:76

deleteOAuth2Clients

deleteOAuth2Clients(): Promise<OAuth2ClientSkeleton[]>
Delete all OAuth2 clients

Returns Promise<OAuth2ClientSkeleton[]>
a promise that resolves to an array of oauth2client objects
- Defined in ops/OAuth2ClientOps.ts:70

exportOAuth2Client

exportOAuth2Client(
clientId: string,
options?: OAuth2ClientExportOptions,
): Promise<OAuth2ClientExportInterface>
Export OAuth2 client by ID
Parameters
- clientId: string
  oauth2 client id
- Optionaloptions: OAuth2ClientExportOptions
  export options
Returns Promise<OAuth2ClientExportInterface>
export data
- Defined in ops/OAuth2ClientOps.ts:93

exportOAuth2Clients

exportOAuth2Clients(
options?: OAuth2ClientExportOptions,
resultCallback?: ResultCallback<OAuth2ClientSkeleton>,
): Promise<OAuth2ClientExportInterface>
Export all OAuth2 clients
Parameters
- Optionaloptions: OAuth2ClientExportOptions
  export options
- OptionalresultCallback: ResultCallback<OAuth2ClientSkeleton>
  Optional callback to process individual results. When given, the outcome of every client is passed to it as it happens (a failed client as an error that names it) and a failed client does not throw: the clients that could be exported are returned. Without it, the failures are collected and thrown as one error after every client was tried. Failing to read the provider or the clients always throws.
Returns Promise<OAuth2ClientExportInterface>
export data
- Defined in ops/OAuth2ClientOps.ts:83

importFirstOAuth2Client

importFirstOAuth2Client(
importData: OAuth2ClientExportInterface,
options?: OAuth2ClientImportOptions,
): Promise<OAuth2ClientSkeleton>
Import first OAuth2 Client
Parameters
- importData: OAuth2ClientExportInterface
  import data
- Optionaloptions: OAuth2ClientImportOptions
  import options
Returns Promise<OAuth2ClientSkeleton>
a promise resolving to an oauth2 client
- Defined in ops/OAuth2ClientOps.ts:115

importOAuth2Client

importOAuth2Client(
    clientId: string,
    importData: OAuth2ClientExportInterface,
    options?: OAuth2ClientImportOptions,
): Promise<OAuth2ClientSkeleton>
Import OAuth2 Client by ID
Parameters
- clientId: string
  client id
- importData: OAuth2ClientExportInterface
  import data
- Optionaloptions: OAuth2ClientImportOptions
  import options
Returns Promise<OAuth2ClientSkeleton>
a promise resolving to an oauth2 client
- Defined in ops/OAuth2ClientOps.ts:104

importOAuth2Clients

importOAuth2Clients(
importData: OAuth2ClientExportInterface,
options?: OAuth2ClientImportOptions,
): Promise<OAuth2ClientSkeleton[]>
Import OAuth2 Clients
Parameters
- importData: OAuth2ClientExportInterface
  import data
- Optionaloptions: OAuth2ClientImportOptions
  import options
Returns Promise<OAuth2ClientSkeleton[]>
a promise resolving to an array of oauth2 clients
- Defined in ops/OAuth2ClientOps.ts:125

readOAuth2Client

readOAuth2Client(clientId: string): Promise<OAuth2ClientSkeleton>
Read OAuth2 client
Parameters
- clientId: string
  client id
Returns Promise<OAuth2ClientSkeleton>
a promise that resolves to an oauth2client object
- Defined in ops/OAuth2ClientOps.ts:45

readOAuth2Clients

readOAuth2Clients(): Promise<OAuth2ClientSkeleton[]>
Read all OAuth2 clients

Returns Promise<OAuth2ClientSkeleton[]>
a promise that resolves to an array of oauth2client objects
- Defined in ops/OAuth2ClientOps.ts:39

updateOAuth2Client

updateOAuth2Client(
clientId: string,
clientData: OAuth2ClientSkeleton,
): Promise<OAuth2ClientSkeleton>
Update or create OAuth2 client
Parameters
- clientId: string
  client id
- clientData: OAuth2ClientSkeleton
  oauth2client object
Returns Promise<OAuth2ClientSkeleton>
a promise that resolves to an oauth2client object
- Defined in ops/OAuth2ClientOps.ts:62

Type Alias OAuth2Client

Index

Methods

Methods

createOAuth2Client

Parameters

Returns Promise<OAuth2ClientSkeleton>

createOAuth2ClientExportTemplate

Returns OAuth2ClientExportInterface

deleteOAuth2Client

Parameters

Returns Promise<OAuth2ClientSkeleton>

deleteOAuth2Clients

Returns Promise<OAuth2ClientSkeleton[]>

exportOAuth2Client

Parameters

Returns Promise<OAuth2ClientExportInterface>

exportOAuth2Clients

Parameters

Returns Promise<OAuth2ClientExportInterface>

importFirstOAuth2Client

Parameters

Returns Promise<OAuth2ClientSkeleton>

importOAuth2Client

Parameters

Returns Promise<OAuth2ClientSkeleton>

importOAuth2Clients

Parameters

Returns Promise<OAuth2ClientSkeleton[]>

readOAuth2Client

Parameters

Returns Promise<OAuth2ClientSkeleton>

readOAuth2Clients

Returns Promise<OAuth2ClientSkeleton[]>

updateOAuth2Client

Parameters

Returns Promise<OAuth2ClientSkeleton>

Settings

On This Page