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

  • Optional accessTokenOptions?: AccessTokenOptions

    Options for the access token auth.

  • Optional clientApps?: {
        accessToken: string;
        clientId: string;
        clientSecret?: string;
        name: string;
        refreshToken: string;
    }[]
  • Optional isDevHub?: boolean
  • Optional oauth2?: OAuth2
  • Optional oauth2Options?: JwtOAuth2Config

    OAuth options.

  • Optional parentUsername?: 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.

  • Optional username?: string

    Org signup username.

Settings

Member Visibility

Theme