---
title: "admDeactivateUser"
canonical: "https://support.appfire.com/space/PSJ/15481406/admDeactivateUser"
format: markdown
---
> Macro (aura-html)


|  |  |  |  |
| --- | --- | --- | --- |
| **Syntax** | admDeactivateUser(username) | **Package** | adm |
| **Alias** |  | **Pkg Usage** | deactivateUser(username) |

## Description

> Macro (excerpt)
> 
> De-activates a user (sets its active flag to 'false' or removes it from all groups associated to global login permissions).

De-activates a user (sets its active flag to 'false' or removes it from all groups associated to global login permissions).

## Parameters

| Parameter name | Type | Required | Description |
| --- | --- | --- | --- |
| username | String | Yes | Username or key. |

## Return Type

**Boolean (true/false)**

Returns 'true' if operation succeeded and 'false' otherwise.

## Example

```
admDeactivateUser("testuser");
```

## See also

> Macro (contentbylabel)