added user resource and fixed some typos
This commit is contained in:
60
docs/resources/user.md
Normal file
60
docs/resources/user.md
Normal file
@ -0,0 +1,60 @@
|
||||
---
|
||||
# generated by https://github.com/hashicorp/terraform-plugin-docs
|
||||
page_title: "gitea_user Resource - terraform-provider-gitea"
|
||||
subcategory: ""
|
||||
description: |-
|
||||
gitea_user manages a native gitea user.
|
||||
If you are using OIDC or other kinds of authentication mechanisms you can still try to managessh keys or other ressources this way
|
||||
---
|
||||
|
||||
# gitea_user (Resource)
|
||||
|
||||
`gitea_user` manages a native gitea user.
|
||||
|
||||
If you are using OIDC or other kinds of authentication mechanisms you can still try to managessh keys or other ressources this way
|
||||
|
||||
## Example Usage
|
||||
|
||||
```terraform
|
||||
resource "gitea_user" "test" {
|
||||
username = "test"
|
||||
login_name = "test"
|
||||
password = "Geheim1!"
|
||||
email = "test@user.dev"
|
||||
must_change_password = false
|
||||
}
|
||||
```
|
||||
|
||||
<!-- schema generated by tfplugindocs -->
|
||||
## Schema
|
||||
|
||||
### Required
|
||||
|
||||
- `email` (String) E-Mail Address of the user
|
||||
- `login_name` (String) The login name can differ from the username
|
||||
- `password` (String, Sensitive) Password to be set for the user
|
||||
- `username` (String) Username of the user to be created
|
||||
|
||||
### Optional
|
||||
|
||||
- `active` (Boolean) Flag if this user should be active or not
|
||||
- `admin` (Boolean) Flag if this user should be an administrator or not
|
||||
- `allow_create_organization` (Boolean)
|
||||
- `allow_git_hook` (Boolean)
|
||||
- `allow_import_local` (Boolean)
|
||||
- `description` (String) A description of the user
|
||||
- `force_password_change` (Boolean) Flag if the user defined password should be overwritten or not
|
||||
- `full_name` (String) Full name of the user
|
||||
- `location` (String)
|
||||
- `max_repo_creation` (Number)
|
||||
- `must_change_password` (Boolean) Flag if the user should change the password after first login
|
||||
- `prohibit_login` (Boolean) Flag if the user should not be allowed to log in (bot user)
|
||||
- `restricted` (Boolean)
|
||||
- `send_notification` (Boolean) Flag to send a notification about the user creation to the defined `email`
|
||||
- `visibility` (String) Visibility of the user. Can be `public`, `limited` or `private`
|
||||
|
||||
### Read-Only
|
||||
|
||||
- `id` (String) The ID of this resource.
|
||||
|
||||
|
Reference in New Issue
Block a user