Свойства пользователя#

Получение свойств#

Метод

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

Получение свойств любого пользователя по его идентификатору.

Необходимые разрешения: blitz_api_user или blitz_api_sys_users.

Возвращает

HTTP 200 и JSON, содержащий свойства пользователя.

Пример

GET /blitz/api/v3/users/854436f6-af58-4a3f-8cb7-c2c441eb4a76/props HTTP/1.1
Content-Type: application/json
Authorization: Bearer cNw…Nz

{
       "pipes.info.fed.readOn":1706530413,
       "fcOn":1707814866,
       "pipes.info.adv-totp.readOn":1696236815,
       "pipes.addKey.mobile.Android.disagreedOn":1701099042,
       "pipes.act.mobile.skippedOn":1695649488,
       "wak.failedOn":1689864670,
       "pipes.act.mobile.outdatedOn":1695649486,
       "last2fa":"x509",
       "pipes.addKey.pc.Windows.disagreedOn":1706100800,
       "pipes.act.mail.skippedOn":1689764346
}

Добавление, изменение и удаление свойств#

Метод

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

Добавление, изменение и удаление свойств пользователя по его идентификатору.

Необходимые разрешения: blitz_api_user или blitz_api_sys_users.

Тело запроса

JSON с перечнем свойств для добавления и удаления. Для изменения значения нужно отправить новое значение свойства в секции add. Для удаления можно только указать удаляемое свойство.

Возвращает

HTTP 200 и JSON, содержащий актуальные свойства.

Пример

Удаление свойства last2fa и добавление testBool#
POST /blitz/api/v3/users/854436f6-af58-4a3f-8cb7-c2c441eb4a76/props HTTP/1.1
Content-Type: application/json
Authorization: Bearer cNw…Nz

{
  "remove" : ["last2fa"],
  "add" : {
    "testBool" : true
  }
}
Изменение свойства testBool#
POST /blitz/api/v3/users/854436f6-af58-4a3f-8cb7-c2c441eb4a76/props HTTP/1.1
Content-Type: application/json
Authorization: Bearer cNw…Nz

{
  "add" : {
    "testBool" : false
  }
}
Удаление свойства testBool#
POST /blitz/api/v3/users/854436f6-af58-4a3f-8cb7-c2c441eb4a76/props HTTP/1.1
Content-Type: application/json
Authorization: Bearer cNw…Nz

{
  "remove" : ["testBool"]
}
Удаление свойства last2fa и добавление testBool#
{
       "pipes.act.mobile.skippedOn":1695649488,
       "pipes.act.mobile.outdatedOn":1695649486,
       "testBool":true,
       "pipes.addKey.mobile.Android.disagreedOn":1701099042,
       "pipes.info.adv-totp.readOn":1696236815,
       "wak.failedOn":1689864670,
       "pipes.info.fed.readOn":1706530413,
       "pipes.act.mail.skippedOn":1689764346,
       "fcOn":1707814866,
       "pipes.addKey.pc.Windows.disagreedOn":1706100800
}
Изменение свойства testBool#
{
       "pipes.act.mobile.skippedOn":1695649488,
       "pipes.act.mobile.outdatedOn":1695649486,
       "testBool":false,
       "pipes.addKey.mobile.Android.disagreedOn":1701099042,
       "pipes.info.adv-totp.readOn":1696236815,
       "wak.failedOn":1689864670,
       "pipes.info.fed.readOn":1706530413,
       "pipes.act.mail.skippedOn":1689764346,
       "fcOn":1707814866,
       "pipes.addKey.pc.Windows.disagreedOn":1706100800
}
Удаление свойства testBool#
{
       "pipes.act.mobile.skippedOn":1695649488,
       "pipes.act.mobile.outdatedOn":1695649486,
       "pipes.addKey.mobile.Android.disagreedOn":1701099042,
       "pipes.info.adv-totp.readOn":1696236815,
       "wak.failedOn":1689864670,
       "pipes.info.fed.readOn":1706530413,
       "pipes.act.mail.skippedOn":1689764346,
       "fcOn":1707814866,
       "pipes.addKey.pc.Windows.disagreedOn":1706100800
}