> ## Documentation Index
> Fetch the complete documentation index at: https://developer.rocket.chat/llms.txt
> Use this file to discover all available pages before exploring further.

# Set User's Status Active

> Activate or deactivate a user in the workspace.

Any one of the following permissions is required:
* `edit-other-user-active-status`: Change another user's active status.
* `manage-moderation-actions`: Manage moderation actions on reported users.

When a user is deactivated (`activeStatus=false`), Rocket.Chat revokes all of the user's login tokens and OAuth access tokens, refresh tokens, and authorization codes. The user can no longer call the REST API with previously issued OAuth credentials.

### Changelog
| Version      | Description |
| ---------------- | ------------|
|8.5.0            | Added OAuth access token, refresh token, and authorization code revocation on deactivation. |
|3.7.0            | Added `confirmRelinquish` to the payload.       |
|0.75.0            | Added       |

## OpenAPI

````json POST /api/v1/users.setActiveStatus
{
  "openapi": "3.0.0",
  "info": {
    "version": "1.0.0",
    "title": "User Management"
  },
  "servers": [
    {
      "url": "https://apiexplorer.support.rocket.chat"
    }
  ],
  "tags": [
    {
      "name": "LDAP"
    },
    {
      "name": "Permissions"
    },
    {
      "name": "Roles"
    },
    {
      "name": "Users"
    },
    {
      "name": "SAML"
    }
  ],
  "paths": {
    "/api/v1/users.setActiveStatus": {
      "post": {
        "summary": "Set User's Status Active",
        "operationId": "post-api-v1-users.setActiveStatus",
        "responses": {
          "200": {
            "description": "",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "user": {
                      "type": "object",
                      "properties": {
                        "_id": {
                          "type": "string"
                        },
                        "active": {
                          "type": "boolean"
                        }
                      }
                    },
                    "success": {
                      "type": "boolean"
                    }
                  }
                },
                "examples": {
                  "Success Example": {
                    "value": {
                      "user": {
                        "_id": "jJNyu4BQFqdgEcqnR",
                        "active": false
                      },
                      "success": true
                    }
                  }
                }
              }
            }
          },
          "400": {
            "description": "Bad Request",
            "content": {
              "application/json": {
                "schema": {
                  "type": "object",
                  "properties": {
                    "success": {
                      "type": "boolean"
                    },
                    "error": {
                      "type": "string"
                    },
                    "errorType": {
                      "type": "string"
                    },
                    "details": {
                      "type": "object",
                      "properties": {
                        "shouldBeRemoved": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        },
                        "shouldChangeOwner": {
                          "type": "array",
                          "items": {
                            "type": "string"
                          }
                        }
                      }
                    }
                  }
                },
                "examples": {
                  "Example 1": {
                    "value": {
                      "success": false,
                      "error": "must have required property 'activeStatus'\n[invalid-params]",
                      "errorType": "invalid-params"
                    }
                  },
                  "user-last-owner": {
                    "value": {
                      "success": false,
                      "error": "[user-last-owner]",
                      "errorType": "user-last-owner",
                      "details": {
                        "shouldBeRemoved": [
                          "cascade-test-group"
                        ],
                        "shouldChangeOwner": []
                      }
                    }
                  }
                }
              }
            }
          },
          "401": {
            "$ref": "#/components/responses/authorizationError"
          }
        },
        "description": "Activate or deactivate a user in the workspace.\n\nAny one of the following permissions is required:\n* `edit-other-user-active-status`: Change another user's active status.\n* `manage-moderation-actions`: Manage moderation actions on reported users.\n\nWhen a user is deactivated (`activeStatus=false`), Rocket.Chat revokes all of the user's login tokens and OAuth access tokens, refresh tokens, and authorization codes. The user can no longer call the REST API with previously issued OAuth credentials.\n\n### Changelog\n| Version      | Description |\n| ---------------- | ------------|\n|8.5.0            | Added OAuth access token, refresh token, and authorization code revocation on deactivation. |\n|3.7.0            | Added `confirmRelinquish` to the payload.       |\n|0.75.0            | Added       |",
        "parameters": [
          {
            "$ref": "#/components/parameters/UserId"
          },
          {
            "$ref": "#/components/parameters/Auth-Token"
          }
        ],
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "type": "object",
                "x-examples": {
                  "Example 1": {
                    "activeStatus": false,
                    "userId": "5HmCfpoB7jp2uibTC"
                  }
                },
                "properties": {
                  "activeStatus": {
                    "type": "boolean",
                    "description": "The value of the active status.",
                    "default": true
                  },
                  "userId": {
                    "type": "string",
                    "description": "The user ID whose status value is to be changed.",
                    "example": "5HmCfpoB7jp2uibTC"
                  },
                  "confirmRelinquish": {
                    "type": "boolean",
                    "default": false,
                    "description": "Only used when `activeStatus` is `false`. Set to `true` to deactivate the user even if they are the last owner of a room, or the only member of a private room. If omitted or `false` and the user is the last owner of any room, the request fails with `user-last-owner`."
                  }
                },
                "required": [
                  "activeStatus",
                  "userId"
                ]
              }
            }
          },
          "description": "When deactivating a user (`activeStatus=false`) and `confirmRelinquish=true`:\n\n* If the user is the last owner of a room that has other active members, the member who joined earliest becomes the new owner.\n* If the user is the only member of a private room, or no other active member can take ownership, that room is deleted, together with every discussion that belongs to it, regardless of who is a member of those discussions. Public channels are not deleted.\n\nWhen `confirmRelinquish` is omitted or `false` and the user is the last owner of any room, or the only member of a private room, the request fails with `user-last-owner` and no change is made. `details.shouldBeRemoved` names the rooms that would be deleted. `details.shouldChangeOwner` names the rooms that would get a new owner. Child discussions that the user is not subscribed to are not listed; any room in `shouldBeRemoved` also takes its discussions with it."
        },
        "tags": [
          "Users"
        ]
      }
    }
  },
  "components": {
    "responses": {
      "authorizationError": {
        "description": "Unauthorized",
        "content": {
          "application/json": {
            "schema": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string"
                },
                "message": {
                  "type": "string"
                }
              }
            },
            "examples": {
              "Authorization Error": {
                "value": {
                  "status": "error",
                  "message": "You must be logged in to do this."
                }
              }
            }
          }
        }
      }
    },
    "parameters": {
      "UserId": {
        "name": "X-User-Id",
        "in": "header",
        "description": "The authenticated user ID.",
        "required": true,
        "schema": {
          "type": "string"
        },
        "example": "rbAXPnMktTFbNpwtJ"
      },
      "Auth-Token": {
        "name": "X-Auth-Token",
        "in": "header",
        "description": "The authenticated user token.",
        "required": true,
        "schema": {
          "type": "string"
        },
        "example": "RScctEHSmLGZGywfIhWyRpyofhKOiMoUIpimhvheU3f"
      }
    }
  }
}
````