Interface UpdateBasicConfigurationActionCreatorPayload

interface UpdateBasicConfigurationActionCreatorPayload {
    accessToken?: string;
    environment?: "dev" | "stg" | "hipaa" | "prod";
    organizationId?: string;
}

Properties

accessToken?: string

The access token to use to authenticate requests against the Coveo Cloud endpoints. Typically, this will be an API key or search token that grants the privileges to execute queries and push usage analytics data in the target Coveo Cloud organization.

environment?: "dev" | "stg" | "hipaa" | "prod"

The environment in which the organization is hosted.

The dev and stg environments are only available internally for Coveo employees (e.g., Professional Services).

organizationId?: string

The unique identifier of the target Coveo Cloud organization (e.g., mycoveocloudorganizationg8tp8wu3)