# Users

```{eval-rst}
.. autoclass:: ab.api.endpoints.users.UsersEndpoint
   :members:
   :undoc-members:
```

## Per-endpoint reference

Each route-backed method has its own page rendering the HTTP route, the
Python and CLI call signatures, and the request/response model field tables.
This is the page `help(api.users.<method>)` links to via its `Docs:` footer.
These pages are generated by `scripts/generate_endpoint_docs.py` and kept
current by a CI freshness gate.

```{toctree}
:maxdepth: 1
:glob:

users/*
```


## Methods

### list

`POST /users/list` — List users (paginated).

**Returns:** `list[`{class}`~ab.api.models.users.User`]`

```python
from ab import ABConnectAPI

api = ABConnectAPI(env="staging")
users = api.users.list({"page": 1, "pageSize": 10})
```

### get_roles

`GET /users/roles` — List all user roles.

**Returns:** `list[str]`

```python
roles = api.users.get_roles()
for role in roles:
    print(role)
```

### create

`POST /users/user` — Create a new user.

```python
api.users.create({"username": "newuser", "email": "new@example.com", "roles": ["role-id"]})
```

### update

`PUT /users/user` — Update a user.

```python
api.users.update({"id": "user-id", "email": "updated@example.com"})
```