---
question: How do I invite, rename, deactivate or delete an account of the platform?
kind: task
via_web: available
via_cli: na
via_python: na
via_api: available
via_config: available
ref_web: Platform Settings › Users
ref_api: GET /api/admin/users
ref_config: nexus_config.users
prereq: A policy gives you the `nexus:*User` actions at the platform, as the platform admin holds them. An organization's owner or admin holds none of them.
next:
  - /capabilities/platform/give-someone-access
  - /capabilities/platform/platform-settings
  - /capabilities/platform/invite-an-organization-member
---

# Manage platform users

Platform Settings › Users is the directory of the platform: every account, and every person invited who has not signed in yet. From it you invite someone to the platform, rename an account, set or remove the platform admin flag, deactivate an account, and delete one.

It is a directory: it shows no role or policy and attaches nothing. A row with an IAM id opens that person's page in [Roles & permissions](/capabilities/platform/roles-and-permissions), where their roles, groups and policies are. To put someone in an organization or a workspace, [invite them there](/capabilities/platform/invite-an-organization-member) instead.

Each button shows for its action, as IAM answers for you at the platform:

| Button | Action |
|---|---|
| Invite | `nexus:InviteUser` |
| Edit name, Make superadmin, Remove superadmin | `nexus:UpdateUser` |
| Deactivate, Reactivate | `nexus:SuspendUser`, `nexus:ResumeUser` |
| Delete | `nexus:DeleteUser` |

Nothing is offered on your own row, and the API refuses it too: your profile is on [Accounts](/capabilities/platform/account). The last active platform admin cannot be demoted, deactivated or deleted. Every change is written to the audit log first: [Review the audit log](/capabilities/platform/review-the-audit-log).

## Web UI

### Open Users

Open the account menu, then **Platform Settings**. Select **Users**, under Tenancy.

The table lists each person with their name and email, IAM id, status (**Signed in**, or **Invited, not yet**, with a **Deactivated** mark), **Superadmin**, organizations, and the date the account was made. One search covers every column; each column sorts and filters. **Export** downloads the visible rows as CSV or xlsx.

![Platform Settings on Users](/abi/Screenshot_Platform_Settings_v3.png)

*Platform Settings › Users: every account and every pending invitation.*

### Invite someone to the platform

Choose **Invite**. Enter the **Email**, and a **Name (optional)**. With several identity providers, pick the **Identity provider**. Choose **Send invitation**.

The invitation names no organization, no workspace and no role. The identity provider makes the person's account, and Nexus emails them a sign-in link. Their access is attached once they have signed in, in Roles & permissions. The page then says what was done: the account made at the provider, a provider that did not make one (you may not create accounts there, or it manages its own people: they sign in with the account they have there), and whether the email was sent.

An address that already has an account is refused (409), and so is one that belonged to a deleted account its provider still holds: delete that account at the provider first. With no identity provider configured, the invitation is refused (400).

### Rename an account

Choose **Edit name** on the row, type the new name, then **Save**. Nexus renames the account, and the provider's account when ABI made it there. A later sign-in refreshes the name from the provider.

### Set the platform admin flag

Choose **Make superadmin** on the row to make the person a platform admin, or **Remove superadmin** to stop. This attaches or detaches `builtin.platform_admin`, every action on everything. Only an account has the flag, not a pending invitation.

### Deactivate or reactivate

Choose **Deactivate**. The person can no longer sign in or call the API: their session ends within seconds, their keys are refused, and the identity provider disables the account ABI made there. Their data, memberships and keys stay. **Reactivate** gives everything back.

### Delete an account

Choose **Delete**. The row reads what deleting takes and what stays:

- **Goes:** the account at the identity provider (or a note that the provider keeps it), the IAM user with its attachments and groups, each membership, the signed-in sessions, the API keys and the pending invitations.
- **Stays:** what they wrote in the workspaces it names. The row of the account stays, retired, as the author of that work.

Type the person's email to confirm, then choose **Delete account**. When deleting is blocked, for example because they are an organization's only owner, the row says why and offers nothing to confirm.

## CLI

Not applicable. No `abi` command manages the platform's accounts: `abi user` invites into an organization or a workspace. Use the Web UI or the REST API.

## Python

Not applicable. From Python, call the REST API.

## REST API

The routes take a browser session or a [personal API key](/capabilities/platform/create-a-personal-api-key) (`NEXUS_ACCESS_TOKEN` below), and each asks the action of its button above. A refusal is a 403 with IAM's words, and changes nothing.

### List the accounts

```bash
curl http://localhost:9879/api/admin/users \
  -H "Authorization: Bearer $NEXUS_ACCESS_TOKEN"
```

Each row has `id`, `kind` (`account` or `invitation`; an invitation's id is `invited:<email>`), `email`, `name`, `principal_id`, `status` (`signed_in` or `invited`), `deactivated`, `is_superadmin`, `organizations` and `created_at`.

### Invite

```bash
curl -X POST http://localhost:9879/api/admin/users/invite \
  -H "Authorization: Bearer $NEXUS_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"email": "jane@example.com", "name": "Jane"}'
```

`provider` is optional. The answer has `user`, `user_created`, `sign_in_email_sent`, `provisioning_skipped`, `renewed` and `warning`. It is 409 when an account holds the address, or when the address belonged to a deleted account whose account at the provider still exists (delete it at the provider first), 400 with no provider or an address the provider will not take, and 502 when the provider could not make the person.

### Rename, or set the platform admin flag

```bash
curl -X PATCH http://localhost:9879/api/admin/users/<user-id> \
  -H "Authorization: Bearer $NEXUS_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"is_superadmin": true}'
```

The body takes `name`, `is_superadmin`, or both. Both are checked before either is made.

### Deactivate or reactivate

`POST /api/admin/users/<user-id>/deactivate` and `POST /api/admin/users/<user-id>/reactivate` answer the row as it now is. A `warning` says when the provider could not follow.

### Delete

`GET /api/admin/users/<user-id>/deletion` is the plan: `blocked`, `warning`, `goes` and `stays`. Then:

```bash
curl -X DELETE "http://localhost:9879/api/admin/users/<user-id>?confirm=jane@example.com" \
  -H "Authorization: Bearer $NEXUS_ACCESS_TOKEN"
```

It answers 400 when `confirm` is not their email and 409 when the plan is blocked.

## Config

### Seed the platform's operators

`users:` in the Nexus config seeds accounts when the API starts. Keep it to the platform's operators: everyone else is invited.

```yaml title="config.yaml"
nexus_config:
  users:
    - email: "ops@example.com"
      name: "Platform operator"
      is_superadmin: true
```

`is_superadmin: true` makes the person platform admin at the start. It only promotes: removing it, or the entry, demotes nobody. Demote, deactivate and delete on Platform Settings › Users. An account that already exists keeps its other fields.
