Interface ManifestAuthProvider

Represents an authentication provider that can be used to authenticate users. The provider needs to be registered in the API that the authorization request is sent to in order to be used.

See

for the provider name that this provider is for.

interface ManifestAuthProvider {
    alias: string;
    element?: ElementLoaderProperty<HTMLElement>;
    ELEMENT_TYPE?: HTMLElement;
    elementName?: string;
    forProviderName: string;
    js?: ElementLoaderProperty<HTMLElement>;
    kind?: unknown;
    meta?: MetaAuthProvider;
    name: string;
    type: "authProvider";
    weight?: number;
}

Hierarchy (View Summary, Expand)

Properties

alias element? ELEMENT_TYPE? elementName? forProviderName js? kind? meta? name type weight?

Properties

alias

alias: string

The alias of the extension, ensure it is unique

Optionalelement

element?: ElementLoaderProperty<HTMLElement>

The file location of the element javascript file to load @TJS-type string

Optional ReadonlyELEMENT_TYPE

ELEMENT_TYPE?: HTMLElement

@TJS-ignore

OptionalelementName

elementName?: string

The HTML web component name to use such as 'my-dashboard' Note it is NOT , just the element name.

forProviderName

forProviderName: string

The provider name that this provider is for.

Examples

'Umbraco.Github'

Optionaljs

js?: ElementLoaderProperty<HTMLElement>

The file location of the javascript file to load @TJS-type string

Optionalkind

kind?: unknown

The kind of the extension, used to group extensions together

Examples

["button"]

Optionalmeta

meta?: MetaAuthProvider

This contains properties specific to the type of extension

name

name: string

The friendly name of the extension

type

type: "authProvider"

The type of extension such as dashboard etc...

Optionalweight

weight?: number

Extensions such as dashboards are ordered by weight with lower numbers being first in the list

Settings

Member Visibility

On This Page

Properties
MMNEPVFCICPMFPCPTTAAATR