---
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

`Params`

| Parameter | Type | Required | Description |
| --- | --- | --- | --- |
| `params` | `GetInvalidListParams` | No | Input parameters |

### Return Value

Type: `Promise<GetTempInvalidListResult>`

List of expired temporary passwords

##### GetTempInvalidListResult

| Property | Type | Description |
| --- | --- | --- |
| `list` | `InvalidPasswordItem[]` | List of invalidated passwords on the current page |
| `hasMore` | `boolean` | Whether there is a next page |
| `total` | `number` | Total count of invalidated passwords |

### Referenced Types

##### `interface` GetInvalidListParams

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

##### `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 |

##### `interface` EffectiveConfig

| Property | Type | Description |
| --- | --- | --- |
| `effectiveDate` | `number` | Effective date (seconds-level timestamp) |
| `expiredDate` | `number` | Expiration date (seconds-level timestamp) |
| `repeat` | `"none" \| "week"` | Repeat policy: none or weekly |
| `weeks` | `Week` | Weekly repeat bitmap |
| `effectiveTime` | `number` | Daily start time (minutes) |
| `expiredTime` | `number` | Daily end time (minutes) |

##### `type` Week

Weekly repeat bitmap: indices 0–6 correspond to Sun–Sat; 0 inactive, 1 active

```typescript
export type Week = [
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
];
```

##### `type` InvalidPasswordItem.clearInfo

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


### Examples

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