User properties

Obtaining properties

Method

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

Obtaining properties of a user by user’s ID.

Required permissions: blitz_api_user or blitz_api_sys_users.

Returns

HTTP 200 and JSON containing the user’s properties.

Example

Request

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

Response

{
       "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
}

Adding, modifying, and deleting properties

Method

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

Adding, modifying, and deleting user properties by user’s ID.

Required permissions: blitz_api_user or blitz_api_sys_users.

Request body

JSON with a list of properties to add and delete. To change a value, you need to send the new property value in the add section. To delete a property, specify the property to be deleted.

Returns

HTTP 200 and JSON containing the actual properties.

Example

Request

Deleting the last2fa property and adding 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
  }
}

Changing the testBool property

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
  }
}

Deleting the testBool property

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

{
  "remove" : ["testBool"]
}

Response

Deleting the last2fa property and adding 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
}

Changing the testBool property

{
       "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
}

Deleting the testBool property

{
       "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
}