skip to main content
Hybrid Data Pipeline API reference : Administrators API : Users API : Create a user account : statusInfo Object
  

Try Now
statusInfo Object

Purpose

Describes the status information for a user account.

Syntax

{
"status": integer,
"accountLocked": boolean,
"accountLockedAt": "YYYY-MM-DD HH:mm:ss",
"accountLockedUntil": "YYYY-MM-DD HH:mm:ss"
}
Property
Description
Valid Values
"status"
Specifies whether the user is active.
An inactive user cannot log in to the Web UI, use APIs, or establish JDBC, ODBC, or OData connections.
0 | 1
If set to 0, the user is inactive.
If set to 1, the user is active.
"accountLocked"
Specifies whether the user account has been locked based on the password failure lockout policy.
true | false
If set to true, the account has been locked.
If set to false, the account is not locked.
"accountLockedAt"
Specifies the time at which the user account has been locked.
Timestamps must be in the UTC format YYYY-MM-DD HH:mm:ss.
"accountLockedUntil"
Specifies the time until which the user account will remain locked.
Timestamps must be in the UTC format YYYY-MM-DD HH:mm:ss.