terraform-provider-woodpecker/docs/data-sources/user.md

41 lines
1001 B
Markdown
Raw Normal View History

2023-08-26 14:42:23 +00:00
---
# generated by https://github.com/hashicorp/terraform-plugin-docs
page_title: "woodpecker_user Data Source - terraform-provider-woodpecker"
subcategory: ""
description: |-
Use this data source to retrieve information about a user.
---
# woodpecker_user (Data Source)
Use this data source to retrieve information about a user.
## Example Usage
```terraform
# Retrieve information about the currently authenticated user.
data "woodpecker_user" "current" {
login = ""
}
# Retrieve information about a user.
data "woodpecker_user" "user" {
login = "user"
}
```
<!-- schema generated by tfplugindocs -->
## Schema
### Required
- `login` (String) The user's login. Use an empty string "" to retrieve information about the currently authenticated user.
### Read-Only
2023-09-02 05:11:10 +00:00
- `avatar_url` (String) the user's avatar URL
2023-08-26 14:42:23 +00:00
- `email` (String) the user's email
- `id` (Number) the user's id
2023-09-02 05:11:10 +00:00
- `is_active` (Boolean) whether user is active in the system
- `is_admin` (Boolean) whether user is an admin