Delete multiple User Entities with link_id

Delete multiple User Entities with link_id. If user with provided link_id exists - it will be removed. If entity doesn't exist in system - operation will be ignored

application/json

Request Body

link_ids uuid[]
List of Link IDs

Responses

application/json

Schema
Example (from schema)
Example

Schema

result object[]
List of operation statuses
link_id uuid
Unique entity set by the server to bind some parameters with each other. By default return null value
success boolean
Operation status
extended_info string
Possible values: [created, updated, deleted, entity_not_found, not_found, number_taken_by_another_identifier, bad_base_64_image_file, face_has_not_recognized, bound_time_profile_doesnt_exist, face_id_not_supported, number_of_face_identifiers_exceeded, number_of_identifiers_exceeded, invalid_time_rules_settings, wrong_areas, wrong_rule]
Entity state information result

{
  "result": [
    {
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b5",
      "success": true,
      "extended_info": "created"
    }
  ]
}

{
  "result": [
    {
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b1",
      "extended_info": "deleted",
      "success": true
    },
    {
      "link_id": "91c615e3-1040-4815-8ecb-039a18b756b1",
      "success": false,
      "extended_info": "not_found"
    }
  ]
}

List cannot be empty
Missed json body or wrong param. Response sample:

  "error": "Wrong JSON body"

auth_factors must contain at least one item Response sample:

  "error": "Wrong JSON body: no value for `param`"

where param - is a required field that was not provided

Field was of the wrong type. Response sample:

  "error": "Wrong JSON body: value `param` was of the wrong type"

where param - is a field of the wrong type

application/json

Schema

error string
Error message

{
  "error": true
}

{
  "error": "Wrong JSON body"
}

{
  "error": "Wrong JSON body: no value for `param`"
}

{
  "error": "Wrong JSON body: value `param` was of the wrong type"
}

{
  "error": "List cannot be empty"
}

Unauthorized request. Log In

application/json

Schema
Example (from schema)
Log In

Schema

error string
Error message

{
  "error": "Log In"
}

{
  "error": "Log In"
}

Administrator rights required. You are currently logged in with different user account. Log In with administrator rights

application/json

Schema
Example (from schema)
Admin Rights Required

Schema

error string
Error message

{
  "error": "Administrator rights required"
}

{
  "error": "Administrator rights required"
}

Delete multiple User Entities with link_id​

Delete multiple User Entities with link_id