DocumentationAmertaPayloadAuthTypesInterfaces

Auth Provider

amerta


amerta / amerta/payload/auth/types / AuthProvider

Interface: AuthProvider

Defined in: amerta/payload/auth/types/index.d.ts:27

Properties

authenticate()

authenticate: (args) => Promise<AuthResult>

Defined in: amerta/payload/auth/types/index.d.ts:35

Parameters

| Parameter | Type | | ------ | ------ | | args | { cookies: Map<string, string>; redirectUri: string; req: PayloadRequest; searchParams: URLSearchParams; settings: any; } | | args.cookies | Map<string, string> | | args.redirectUri | string | | args.req | PayloadRequest | | args.searchParams | URLSearchParams | | args.settings | any |

Returns

Promise<AuthResult>


generateAuthUrl()

generateAuthUrl: (args) => Promise<AuthResult>

Defined in: amerta/payload/auth/types/index.d.ts:33

Parameters

| Parameter | Type | | ------ | ------ | | args | { redirectUri: string; req: PayloadRequest; settings: any; } | | args.redirectUri | string | | args.req | PayloadRequest | | args.settings | any |

Returns

Promise<AuthResult>


label

label: string

Defined in: amerta/payload/auth/types/index.d.ts:29


settingsFields

settingsFields: Field[]

Defined in: amerta/payload/auth/types/index.d.ts:31


slug

slug: string

Defined in: amerta/payload/auth/types/index.d.ts:28