Type Alias Options

Options: {
    accessTokenOptions?: AccessTokenOptions;
    clientApps?: {
        accessToken: string;
        clientId: string;
        clientSecret?: string;
        name: string;
        refreshToken: string;
    }[];
    isDevHub?: boolean;
    oauth2?: OAuth2;
    oauth2Options?: JwtOAuth2Config;
    parentUsername?: string;
    username?: string;
}

Constructor options for AuthInfo.

Type declaration

  • OptionalaccessTokenOptions?: AccessTokenOptions

    Options for the access token auth.

  • OptionalclientApps?: {
        accessToken: string;
        clientId: string;
        clientSecret?: string;
        name: string;
        refreshToken: string;
    }[]
  • OptionalisDevHub?: boolean
  • Optionaloauth2?: OAuth2
  • Optionaloauth2Options?: JwtOAuth2Config

    OAuth options.

  • OptionalparentUsername?: string

    In certain situations, a new auth info wants to use the connected app information from another parent org. Typically for scratch org or sandbox creation.

  • Optionalusername?: string

    Org signup username.

Settings

Member Visibility