Appearance

On this page

Directus Cloud

Everything you need to start building. Provisioned in 90 seconds. Starting at $15/month.

Get Started

This is an auto-generated document to support extension builders understand the internal packages they can utilize. To find our written guides, tutorials, and API/SDK reference, check out our main docs .

Directus / @directus/sdk / auth / authentication

Function: authentication() ​

authentication(mode, config): <Schema>(client) => AuthenticationClient<Schema>

Defined in: auth/composable.ts:34

Creates a client to authenticate with Directus.

Parameters ​

mode ​

AuthenticationMode = 'cookie'

AuthenticationMode

config ​

Partial<AuthenticationConfig> = {}

The optional configuration.

Returns ​

Function

A Directus authentication client.

Type Parameters ​

• Schema

Parameters ​

client ​

DirectusClient<Schema>

Returns ​

AuthenticationClient<Schema>