Skip to main content

Two Factor Auth - Admin Disable

Endpoint​

/i/two-factor-auth?method=admin_disable

Overview​

Disables 2FA for a target user (admin operation).

Authentication​

Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.

Permissions​

Requires Global Admin.

Request Parameters​

ParameterTypeRequiredDescription
methodStringYesMust be admin_disable.
api_keyStringYes (or use auth_token)API key for authentication.
auth_tokenStringNoAuth token as query parameter or countly-token header.
uidStringYesTarget user id.

Examples​

Admin disable target user 2FA​

/i/two-factor-auth?api_key=YOUR_API_KEY&method=admin_disable&uid=65f1f7b2ad5b9b001f12ab34

Response​

Success Response​

{
"result": "Disabled 2FA for user"
}

Response Fields​

FieldTypeDescription
resultStringResult message.

Error Responses​

  • 400
{
"result": "User id required"
}
  • 500
{
"result": "Database error while disabling 2FA"
}
  • 404
{
"result": "User does not exist"
}

Behavior​

  • Sets two_factor_auth.enabled=false and removes two_factor_auth.secret_token for target user.
  • Emits system log action: two_factor_auth_disabled with user_id payload.
Implementation details

Database Collections

CollectionUsed forData touched by this endpoint
countly.membersUser account settingsDisables target user 2FA and removes secret.
countly.systemlogsAudit trailReceives two_factor_auth_disabled action.