# UseAuthReturn

Defined in: [react/src/hooks/createAuthHooks.ts:8](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/hooks/createAuthHooks.ts#L8)

## Properties

### authenticate

> **authenticate**: () => `Promise`\<`Identity` \| `undefined`\>

Defined in: [react/src/hooks/createAuthHooks.ts:9](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/hooks/createAuthHooks.ts#L9)

#### Returns

`Promise`\<`Identity` \| `undefined`\>

***

### login

> **login**: (`options?`) => `Promise`\<`void`\>

Defined in: [react/src/hooks/createAuthHooks.ts:10](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/hooks/createAuthHooks.ts#L10)

#### Parameters

##### options?

[`AuthenticationSignInOptions`](https://ic-reactor.b3pay.net/v3/libs/interfaces/authenticationsigninoptions/)

#### Returns

`Promise`\<`void`\>

***

### logout

> **logout**: (`options?`) => `Promise`\<`void`\>

Defined in: [react/src/hooks/createAuthHooks.ts:11](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/hooks/createAuthHooks.ts#L11)

#### Parameters

##### options?

###### returnTo?

`string`

#### Returns

`Promise`\<`void`\>

***

### isAuthenticated

> **isAuthenticated**: `boolean`

Defined in: [react/src/hooks/createAuthHooks.ts:12](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/hooks/createAuthHooks.ts#L12)

***

### isAuthenticating

> **isAuthenticating**: `boolean`

Defined in: [react/src/hooks/createAuthHooks.ts:13](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/hooks/createAuthHooks.ts#L13)

***

### principal

> **principal**: `Principal` \| `null`

Defined in: [react/src/hooks/createAuthHooks.ts:19](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/hooks/createAuthHooks.ts#L19)

The signed-in user's principal, or `null` while signed out. A signed-out
session still holds an anonymous `identity`, and its principal is not
returned here.

***

### identity

> **identity**: `Identity` \| `null`

Defined in: [react/src/hooks/createAuthHooks.ts:20](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/hooks/createAuthHooks.ts#L20)

***

### error

> **error**: `Error` \| `undefined`

Defined in: [react/src/hooks/createAuthHooks.ts:21](https://github.com/B3Pay/ic-reactor/blob/70bedf3c8779611a3b35710510442dee7f630b87/packages/react/src/hooks/createAuthHooks.ts#L21)