Function ensureAuthenticatedAdmin

  • ensureAuthenticatedAdmin(store, scopes?, forceRefresh?, options?): Promise<AdminSession>

  • Ensure that we have a valid Admin session for the given store.

    Parameters

    • store: string

      Store fqdn to request auth for.

    • scopes: AdminAPIScope[] = []

      Optional array of extra scopes to authenticate with.

    • forceRefresh: boolean = false

      Optional flag to force a refresh of the token.

    • options: EnsureAuthenticatedAdditionalOptions = {}

      Optional extra options to use.

    Returns Promise<AdminSession>

    The access token for the Admin API.

Settings

Member Visibility

Theme