---
name: "getTempInvalidList"
mode: "api"
versionRequirements:
  - { name: "@ray-js/lock-sdk", version: "1.0.0" }
title: "getTempInvalidList - Get invalid temporary password list."
summary: "Get invalid temporary password list."
---

## getTempInvalidList

> [VERSION] @ray-js/lock-sdk >= 1.0.0

### Description

Get the list of invalid temporary passwords

### Parameters

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `page` | `number` | No | Page number (starting from 1) |
| `pageSize` | `number` | No | Page size, default 200 |

### Return Value

Type: `Promise<__object>`

List of expired temporary passwords

##### __object

| Property | Type | Description |
| --- | --- | --- |
| `list` | `InvalidPasswordItem[]` |  |
| `hasMore` | `boolean` |  |
| `total` | `number` |  |

### Referenced Types

##### `interface` InvalidPasswordItem

| Property | Type | Description |
| --- | --- | --- |
| `status` | `"expired"` | Status: expired |
| `invalidReason` | `"synchronizationFailed" \| "passwordFull" \| "deleted"` | Expiration reason |
| `unlockBindingId` | `string` | Password ID |
| `effectiveConfig` | `EffectiveConfig` | Validity configuration |
| `name` | `string` | Password name |
| `type` | `"custom" \| "once" \| "limit" \| "clear" \| "clearOne"` | Password type |
| `sn` | `number` | Password SN |
| `hasClearPwd` | `boolean` | Whether the current password is marked for removal |
| `clearInfo` | `Object` | Target information when clearing an individual password |

##### `type` BitStatus

Bit switch: 0 off, 1 on / Single-bit flag

```typescript
export type BitStatus = 0 | 1;
```

##### `type` InvalidPasswordItem.clearInfo

| Property | Type | Description |
| --- | --- | --- |
| `name` | `string` | Individual password name |
| `effectiveConfig` | `EffectiveConfig` | Individual password validity configuration |


### Examples

#### Example

```ts
import { getTempInvalidList } from '@ray-js/lock-sdk';
const list = getTempInvalidList();
```
