Deactivate user (as admin)ΒΆ

To deactivate a user, make a request to the admin endpoint : /v1/admin/user/deactivate

POST auth.<cluster-name>.hasura-app.io/v1/admin/user/deactivate HTTP/1.1
Content-Type: application/json

{
   "hasura_id": 3
}

If the request is successful, the API will return response with user details.

Typical response of the /v1/admin/user/deactivate request is :

HTTP/1.1 200 OK
Content-Type: application/json

{
   "hasura_id": 3,
   "hasura_roles": [
     "user", "merchant", "something"
   ],
   "auth_token": null,
   "email": "something@email.com",
   "mobile": "919999999999",
   "username": "something123",
   "created": "2014-11-05T08:15:30-05:00",
   "last_login": "2014-11-05T08:15:30-05:00",
   "is_active": false,
}
  • auth_token is the authentication token of the user for the current session. This is null because admin deactivate user api will not create session for new user created.
  • hasura_roles is a list of all roles assigned to the user.
  • hasura_id is the hasura identifier of the user.
  • is_active gives status of the user. Here, it is false.
« previous | next »
Want to contribute or report missing content? Check out the github repo for docs.
Powered by Sphinx. Copyright © 2019 Hasura.