mirror of
https://github.com/BerriAI/litellm.git
synced 2026-09-12 23:01:41 +00:00
3653e5893f
* feat(terraform): close key/team schema gaps, fix team read envelope, add import support * feat(terraform): add fallback resource/data source and key/team block resources * feat(terraform): add access group and unified access group resources and data sources * feat(terraform): add guardrail and prompt resources and data sources * feat(terraform): add agent and search tool resources and data sources * feat(terraform): add user and budget resources and data sources * feat(terraform): add tag and project resources and data sources * docs(terraform): changelog and readme for parity additions * feat(terraform): add data sources for keys, teams, models, organizations, and mcp servers * fix(terraform): key update 400 on empty budget_duration, key info envelope, config-supplied key * fix(terraform): hash raw keys to SHA-256 tokens in key lookup URLs and block resource IDs
47 lines
1.6 KiB
Markdown
47 lines
1.6 KiB
Markdown
# litellm_users Data Source
|
|
|
|
Retrieves a page of LiteLLM users, with optional server-side filters
|
|
|
|
## Example Usage
|
|
|
|
```hcl
|
|
data "litellm_users" "internal" {
|
|
role = "internal_user"
|
|
page = 1
|
|
page_size = 100
|
|
}
|
|
|
|
output "internal_user_ids" {
|
|
value = data.litellm_users.internal.ids
|
|
}
|
|
```
|
|
|
|
## Argument Reference
|
|
|
|
- `role` (Optional) - Filter users by role
|
|
- `user_ids` (Optional) - Comma-separated list of user IDs to filter by
|
|
- `user_email` (Optional) - Filter users by partial email match
|
|
- `team` (Optional) - Filter users by team ID
|
|
- `page` (Optional, Default `1`) - Page number to fetch
|
|
- `page_size` (Optional, Default `25`) - Number of users per page, max 100
|
|
- `sort_by` (Optional) - Column to sort by, e.g. `user_id`, `user_email`, `created_at`
|
|
- `sort_order` (Optional) - Sort order, `asc` or `desc`
|
|
|
|
## Attribute Reference
|
|
|
|
- `users` - Users returned for the requested page. Each entry has:
|
|
- `user_id` - The user ID
|
|
- `user_email` - Email address of the user
|
|
- `user_alias` - Descriptive name for the user
|
|
- `user_role` - Role of the user on the proxy
|
|
- `teams` - List of team IDs the user belongs to
|
|
- `models` - Models the user is allowed to call
|
|
- `max_budget` - Maximum budget in USD
|
|
- `spend` - Current spend in USD
|
|
- `tpm_limit` - Tokens per minute limit
|
|
- `rpm_limit` - Requests per minute limit
|
|
- `key_count` - Number of API keys owned by the user
|
|
- `created_at` - Timestamp when the user was created
|
|
- `ids` - IDs of the users returned for the requested page
|
|
- `total` - Total number of users matching the filters
|
|
- `total_pages` - Total number of pages available
|