Users

Get User Password Status

Returns the user's password status based on a user ID.

Authorization Required:

Designer Administrator

get/users/{userId}/passwordStatus

Request

Base URL
https://env.unqork.io/api/1.0
Auth
OAuth 2
Client credentials
Password
Token URLhttps://xyzfinancial.unqork.io/api/1.0/oauth2/access_token
TypeScript
https://skmtc.dev/unqork/apis/unqork-customer-api/docs/users/:userId/passwordStatus/get.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

userIdstring required

ID of user to retrieve

Response

User Password Status

userIdstring required

passwordStatus'OK' | 'TEMPORARY' | 'N/A' required

Status of the user's password:

TEMPORARY - User must change password at first login. If temporary password has expired, a new one must be resent using PUT.
OK - User has already changed their temporary password.
FORCED_RESET - User has to reset their password.
N/A - Not applicable

Changes

No recorded changes to this operation across all 6 revisions of this API.