getTempInvalidList(params?: GetInvalidListParams)

Requires:
@ray-js/lock-sdk≥1.0.0

Description

Get the list of invalid temporary passwords

Parameters

ParameterTypeRequiredDescription
NoInput parameters

Return Value

Type: Promise<GetTempInvalidListResult>
List of expired temporary passwords
GetTempInvalidListResult
PropertyTypeDescription
List of invalidated passwords on the current page
hasMorebooleanWhether there is a next page
totalnumberTotal count of invalidated passwords

Referenced Types

interfaceInvalidPasswordItem
PropertyTypeDescription
status"expired"Status: expired
invalidReason"synchronizationFailed" | "passwordFull" | "deleted"Expiration reason
unlockBindingIdstringPassword ID
Validity configuration
namestringPassword name
type"custom" | "once" | "limit" | "clear" | "clearOne"Password type
snnumberPassword SN
hasClearPwdbooleanWhether the current password is marked for removal
Target information when clearing an individual password
typeWeekWeekly repeat bitmap: indices 0–6 correspond to Sun–Sat; 0 inactive, 1 active
export type Week = [
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
  BitStatus,
];

Valid Values

InvalidPasswordItem.invalidReason
ValueDescriptionSince
synchronizationFailed--
passwordFull--
deleted--
EffectiveConfig.repeat
ValueDescriptionSince
none--
week--
Week
ValueDescriptionSince
0--
1--
InvalidPasswordItem.type
ValueDescriptionSince
custom--
once--
limit--
clear--
clearOne--

Examples

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