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 / rest / authenticateShare

Function: authenticateShare() ​

authenticateShare<Schema>(share, password?, mode?): RestCommand<AuthenticationData, Schema>

Defined in: rest/commands/utils/shares.ts:14

Authenticate as a share user.

Type Parameters ​

• Schema

Parameters ​

share ​

string

The ID of the share.

password? ​

string

Password for the share, if one is configured.

mode? ​

AuthenticationMode = 'cookie'

Whether to retrieve the refresh token in the JSON response, or in a httpOnly cookie. One of json, cookie or session. Defaults to cookie.

Returns ​

RestCommand<AuthenticationData, Schema>

Authentication data.