@umbraco-cms/backoffice
    Preparing search index...

    Interface UmbOpenApiConfiguration

    Configuration for the OpenAPI (Umbraco) server. This is used to communicate with the Management API. This is useful if you want to configure your Fetch, Axios or other HTTP client to communicate with the Management API. If you use the recommended resource generator openapi-typescript-codegen this can be used to configure the OpenAPI object.

    interface UmbOpenApiConfiguration {
        base?: string;
        credentials?: "include" | "omit" | "same-origin";
        token: () => Promise<undefined | string>;
    }
    Index

    Properties

    base? credentials? token

    Properties

    base?: string

    The base URL of the OpenAPI (Umbraco) server.

    credentials?: "include" | "omit" | "same-origin"

    The credentials option for the Fetch API.

    token: () => Promise<undefined | string>

    The token to use for the Authorization header.

    Type declaration

      • (): Promise<undefined | string>

      • Returns Promise<undefined | string>

        A resolver for the token to use for the Authorization header.

    Settings

    Member Visibility

    On This Page

    Properties