Account status#

Checking account status#

Method

GET https://login.company.com/blitz/api/v3/users/{subjectId}/state

Checking account status:

  • presence of blocking due to inactivity;

  • presence of a ban on blocking due to inactivity.

Required permissions: blitz_api_usec or blitz_api_sys_usec.

Examples

GET /blitz/api/v3/users/d2580c98-e584-4aad-a591-97a8cf45cd2a/state HTTP/1.1
Authorization: Bearer cNwIXatB0wk5ZHO0xG5kxuuLubesWcb_yPPqLOFWDuwzMDc0Nz
Cache-Control: no-cache
The account status has not been initialized yet (the account has just been created or has not been used before logging in since the function appeared)#
{
  "name": "initial"
}
The account is active#
{
  "name": "active",
  "checkedOn": 1688106755
}

Note

The checkedOn parameter stores the timestamp of the last status check.

The account has been blocked due to prolonged inactivity#
{
  "name": "inactivityLock",
  "on": 1688106646
}

Note

The on parameter stores the blocking time.

The account is in the list of exclusions and cannot be blocked due to inactivity before the date of the till parameter#
{
  "name": "untouchable",
  "till": 1689106755
}

Note

If the till parameter is missing, then the account cannot be blocked at all due to inactivity.

Changing the account status#

Method

POST https://login.company.com/blitz/api/v3/users/{subjectId}/state

Changing the status of the user account.

Required permissions: blitz_api_sys_usec_chg.

Request body

Possible parameters:

  • name is the assigned state. You can only assign the untouchable state;

  • till is an optional parameter in which you can specify the time until which the account is assigned the untouchable status. To cancel the untouchable status, you can assign the current time to the till parameter.

Returns

In case of a successful call, HTTP 204 No Content.

Example

Request#
POST /blitz/api/v3/users/d2580c98-e584-4aad-a591-97a8cf45cd2a/state HTTP/1.1
Authorization: Bearer cNwIXatB0wk5ZHO0xG5kxuuLubesWcb_yPPqLOFWDuwzMDc0Nz
Content-Type: application/json

{
    "name": "untouchable",
    "till": 1689106755
}