Admin - Delete a user

DELETE 
/admin/delete-user

Deletes a user by it user_id. It will fail if the user has keys associated with it. If you are sure you want to delete the user, you should first delete all the keys associated with the user (use list-all-user-keys to list them and then delete-key-share for each of them).

Request

Query Parameters

user_id UserIdrequired

Header Parameters

AUTHORIZATION stringrequired

The AUTHORIZATION header must be set to the Admin token. which is set on Vertex setup

Responses

200

400

application/json

Schema

Schema

err_msg stringrequired
err_type stringrequired

Possible values: [already_performed_keygen, api_key_not_found, bad_n_and_t_params, bad_request_params, batch_too_large, executor_result, key_id_not_exists, key_operation_before_keygen, policy_in_use_by_keys, policy_in_use_by_users, policy_not_found, policy_validation_failed, room_creation_problem, rule_in_use, rule_not_found, rule_not_in_policy, server_share_backup_setting_disabled, unique_violation, user_has_associated_keys, user_id_not_exists, user_name_already_exists, you_have_to_be_admin]

Example (from schema)

{
  "err_msg": "string",
  "err_type": "already_performed_keygen"
}

401

application/json

Schema

Schema

err_msg stringrequired
err_type stringrequired

Possible values: [access_denied]

Example (from schema)

{
  "err_msg": "string",
  "err_type": "access_denied"
}

404

application/json

Schema

Schema

err_msg stringrequired
err_type stringrequired

Possible values: [not_found]

Example (from schema)

{
  "err_msg": "string",
  "err_type": "not_found"
}

500

application/json

Schema

Schema

err_msg stringrequired
err_type stringrequired

Possible values: [internal_problem]

Example (from schema)

{
  "err_msg": "string",
  "err_type": "internal_problem"
}

Loading...