Type Alias OAuth2Client

Type declaration

• createOAuth2Client:function

  • 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

• createOAuth2ClientExportTemplate:function

  • createOAuth2ClientExportTemplate(): OAuth2ClientExportInterface

    Create an empty OAuth2 client export template

    Returns OAuth2ClientExportInterface

    an empty OAuth2 client export template

• deleteOAuth2Client:function

  • deleteOAuth2Client(clientId: string): Promise<OAuth2ClientSkeleton>

    Delete OAuth2 client

    Parameters

    • clientId: string

      client id

    Returns Promise<OAuth2ClientSkeleton>

    a promise that resolves to an oauth2client object

• deleteOAuth2Clients:function

  • deleteOAuth2Clients(): Promise<OAuth2ClientSkeleton[]>

    Delete all OAuth2 clients

    Returns Promise<OAuth2ClientSkeleton[]>

    a promise that resolves to an array of oauth2client objects

• exportOAuth2Client:function

  • 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

• exportOAuth2Clients:function

  • exportOAuth2Clients(
        options?: OAuth2ClientExportOptions,
    ): Promise<OAuth2ClientExportInterface>

    Export all OAuth2 clients

    Parameters

    • Optionaloptions: OAuth2ClientExportOptions

      export options

    Returns Promise<OAuth2ClientExportInterface>

    export data

• getOAuth2Client:function

  • getOAuth2Client(clientId: string): Promise<OAuth2ClientSkeleton>

    Get OAuth2 client

    Parameters

    • clientId: string

      client id

    Returns Promise<OAuth2ClientSkeleton>

    a promise that resolves to an oauth2client object

    Deprecated

    since v2.0.0 use readOAuth2Client instead

    readOAuth2Client(clientId: string): Promise<OAuth2ClientSkeleton>
    Copy

• getOAuth2Clients:function

  • getOAuth2Clients(): Promise<OAuth2ClientSkeleton[]>

    Get all OAuth2 clients

    Returns Promise<OAuth2ClientSkeleton[]>

    a promise that resolves to an array of oauth2client objects

    Deprecated

    since v2.0.0 use readOAuth2Clients instead

    readOAuth2Clients(): Promise<OAuth2ClientSkeleton[]>
    Copy

• importFirstOAuth2Client:function

  • 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

• importOAuth2Client:function

  • 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

• importOAuth2Clients:function

  • 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

• putOAuth2Client:function

  • putOAuth2Client(
        clientId: string,
        clientData: OAuth2ClientSkeleton,
    ): Promise<OAuth2ClientSkeleton>

    Put OAuth2 client

    Parameters

    • clientId: string

      client id
    • clientData: OAuth2ClientSkeleton

      oauth2client object

    Returns Promise<OAuth2ClientSkeleton>

    a promise that resolves to an oauth2client object

    Deprecated

    since v2.0.0 use updateOAuth2Client or createOAuth2Client instead

    updateOAuth2Client(clientId: string, clientData: OAuth2ClientSkeleton): Promise<OAuth2ClientSkeleton>
    createOAuth2Client(clientId: string, clientData: OAuth2ClientSkeleton): Promise<OAuth2ClientSkeleton>
    Copy

• readOAuth2Client:function

  • readOAuth2Client(clientId: string): Promise<OAuth2ClientSkeleton>

    Read OAuth2 client

    Parameters

    • clientId: string

      client id

    Returns Promise<OAuth2ClientSkeleton>

    a promise that resolves to an oauth2client object

• readOAuth2Clients:function

  • readOAuth2Clients(): Promise<OAuth2ClientSkeleton[]>

    Read all OAuth2 clients

    Returns Promise<OAuth2ClientSkeleton[]>

    a promise that resolves to an array of oauth2client objects

• updateOAuth2Client:function

  • 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