Function ensureAuthenticatedPartners

  • ensureAuthenticatedPartners(scopes?, env?, options?): Promise<{
        token: string;
        userId: string;
    }>

  • Ensure that we have a valid session to access the Partners API. If SHOPIFY_CLI_PARTNERS_TOKEN exists, that token will be used to obtain a valid Partners Token If SHOPIFY_CLI_PARTNERS_TOKEN exists, scopes will be ignored.

    Parameters

    • scopes: "cli"[] = []

      Optional array of extra scopes to authenticate with.

    • env: ProcessEnv = process.env

      Optional environment variables to use.

    • options: EnsureAuthenticatedAdditionalOptions = {}

      Optional extra options to use.

    Returns Promise<{
        token: string;
        userId: string;
    }>

    The access token for the Partners API.

Settings

Member Visibility

Theme