GitHub

auth.required

Nobody is signed in, and this needs a signed-in user

Profile

Errors

Raised with

fail()

Status

401

Message

yours
View as Markdown

Auth intents

Example

TS
return fail('auth.required');
The caller gets
Terminal
HTTP 401

{
  "ok": false,
  "error": "Sign in required.",
  "code": "auth.required"
}

Choosing between neighbours

Find the row that describes your case, and use the intent on the right.

  • If it is

    Use

  • Nobody is signed in, and this needs a signed-in user

    auth.required this page

  • A signed-in caller who may not do this

    permission.denied

Connections

Declared in the registry, both directions. Where an intent is used in your own code is something check and the gallery see; this site has no app code.

For registry authors

Starter intents. These are the intents prongs add errors puts in your registry, raised with fail(). Change the messages to suit your app, and the statuses through the status.* intents they are built from.

The entry prongs add errors writes into your registry. Change the message here, or the status through its status.* ref.

TS
'auth.required': {
  kind: 'semantic',
  description: 'Nobody is signed in, and this needs a signed-in user',
  refs: ['status.unauthorized'],
  keywords: ['signed out', 'login', 'unauthenticated'],
  notFor: [
    {
      context: 'a signed-in caller who may not do this',
      instead: 'permission.denied',
    },
  ],
  binding: { publicMessage: 'Sign in required.' },
},