Skip to content

Commit f3e21cd

Browse files
jorwoodsclaude
andcommitted
docs: add users.filter to api-ref.md
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent e86461d commit f3e21cd

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

docs/api-ref.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5437,6 +5437,40 @@ for user, error in failed:
54375437
<br>
54385438
<br>
54395439

5440+
#### users.filter
5441+
5442+
```py
5443+
users.filter(**kwargs)
5444+
```
5445+
5446+
Returns a list of users that match the specified filters. Fields and operators are passed as keyword arguments in the form `field_name=value` or `field_name__operator=value`.
5447+
5448+
**Supported fields and operators**
5449+
5450+
Field | Operators
5451+
:--- | :---
5452+
`domain_name` | `eq`, `in`
5453+
`friendly_name` | `eq`, `in`
5454+
`is_local` | `eq`
5455+
`last_login` | `eq`, `gt`, `gte`, `lt`, `lte`
5456+
`luid` | `eq`, `in`
5457+
`name` | `eq`, `cieq`, `in`
5458+
`site_role` | `eq`, `in`
5459+
5460+
**Returns**
5461+
5462+
Returns a `QuerySet` of `UserItem` objects.
5463+
5464+
**Example**
5465+
5466+
```py
5467+
viewers = server.users.filter(site_role='Viewer')
5468+
for user in viewers:
5469+
print(user.name)
5470+
```
5471+
5472+
<br>
5473+
<br>
54405474

54415475
---
54425476

0 commit comments

Comments
 (0)