vlocode-project - v1.41.2
    Preparing search index...

    Interface SalesforceClientCredentialsLoginOptions

    Options for the OAuth2 client credentials flow, which can be used to request an access token using only a client ID and client secret without user interaction.

    interface SalesforceClientCredentialsLoginOptions {
        alias?: string;
        clientId: string;
        clientSecret: string;
        instanceUrl?: string;
        scope?: string;
    }

    Hierarchy (View Summary)

    Index

    Properties

    alias? clientId clientSecret instanceUrl? scope?

    Properties

    alias?: string

    When specified the alias is used to store the org details in the SFDX configuration store. Otherwise the new login is only stored under the username in the SFDX configuration store.

    clientId: string

    OAuth2 client ID to use for the login request, defaults to the SFDX default client ID when not specified.

    clientSecret: string
    instanceUrl?: string

    Login URL to use for the login request, defaults to sfdx.defaultLoginUrl when not specified.

    scope?: string

    Settings

    Member Visibility

    On This Page

    Properties