auth

Documentation

Overview

Package auth provides the APIs to get information about the authenticated users.

For more information about how authentication works with Encore applications see https://encore.dev/docs/develop/auth.

Index

• func Data() (_ any)
• func WithContext(ctx context.Context, uid UID, data interface{}) (_ context.Context)
• type UID
  • func UserID() (_ UID, _ bool)

Functions

func Data

func Data() (_ any)

Data returns the structured auth data for the request. It returns nil if the request was made without authentication details, and the API endpoint does not require them.

Expected usage is to immediately cast it to the registered auth data type:

usr, ok := auth.Data().(*user.Data)
if !ok { /* ... */ }

func WithContext

func WithContext(ctx context.Context, uid UID, data interface{}) (_ context.Context)

WithContext returns a new context that sets the auth information for outgoing API calls. It does not affect the auth information for the current request.

Passing in an empty string as the uid results in unsetting the auth information, causing future API calls to behave as if there was no authenticated user.

If the application's auth handler returns custom auth data, two additional requirements exist. First, the data parameter passed to WithContext must be of the same type as the auth handler returns. Second, if the uid argument is not the empty string then data may not be nil. If these requirements are not met, API calls made with these options will not be made and will immediately return a client-side error.

Types

type UID

type UID string

UID is a unique identifier representing a user (a user id).

func UserID

func UserID() (_ UID, _ bool)

UserID reports the uid of the user making the request. The second result is true if there is a user and false if the request was made without authentication details.