---
title: AuthenticationRequiredError
framework: CKTool JS
role: symbol
role_heading: Structure
platforms: [cktool js 1.2.15+]
path: cktooljs/authenticationrequirederror
---

# AuthenticationRequiredError

An object that represents an error that occurs when authentication information is missing for the current user.

## Declaration

```data
dictionary AuthenticationRequiredError {
	Int32 code;
	string message;
	string reason;
	string? detailedMessage;
	string? requestUuid;
	Int32? retryAfterSeconds;
	string redirectUrl;
};
```

## Overview

Overview Some database operations require that users sign in with their Apple ID. The server returns AuthenticationRequiredError when the user isn’t signed in or their session has expired. In JavaScript, this is a plain object with properties as described. In TypeScript, this type is imported in the following way: import type { AuthenticationRequiredError } from "@apple/cktool.database";

## Topics

### Instance Properties

- [code](cktooljs/authenticationrequirederror/code.md)
- [detailedMessage](cktooljs/authenticationrequirederror/detailedmessage.md)
- [message](cktooljs/authenticationrequirederror/message.md)
- [reason](cktooljs/authenticationrequirederror/reason.md)
- [redirectUrl](cktooljs/authenticationrequirederror/redirecturl.md)
- [requestUuid](cktooljs/authenticationrequirederror/requestuuid.md)
- [retryAfterSeconds](cktooljs/authenticationrequirederror/retryafterseconds.md)

## See Also

### Database Errors

- [CKDBBatchDeleteError](cktooljs/ckdbbatchdeleteerror.md)
- [RequestError](cktooljs/requesterror.md)