This repository has been archived by the owner on Jan 29, 2025. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
4 changed files
with
156 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "pterodactyl_user Data Source - pterodactyl" | ||
subcategory: "" | ||
description: |- | ||
The Pterodactyl user data source allows Terraform to read user data from the Pterodactyl Panel API. | ||
--- | ||
|
||
# pterodactyl_user (Data Source) | ||
|
||
The Pterodactyl user data source allows Terraform to read user data from the Pterodactyl Panel API. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
data "pterodactyl_user" "first_user" { | ||
id = 1 | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Optional | ||
|
||
- `email` (String) The email of the user. | ||
- `external_id` (String) The external ID of the user. | ||
- `id` (Number) The ID of the user. | ||
- `username` (String) The username of the user. | ||
|
||
### Read-Only | ||
|
||
- `created_at` (String) The date and time the user was created. | ||
- `first_name` (String) The first name of the user. | ||
- `is_2fa` (Boolean) Is the user using 2FA. | ||
- `language` (String) The language of the user. | ||
- `last_name` (String) The last name of the user. | ||
- `root_admin` (Boolean) Is the user the root admin. | ||
- `updated_at` (String) The date and time the user was last updated. | ||
- `uuid` (String) The UUID of the user. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,42 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "pterodactyl_users Data Source - pterodactyl" | ||
subcategory: "" | ||
description: |- | ||
The Pterodactyl users data source allows Terraform to read user data from the Pterodactyl Panel API. | ||
--- | ||
|
||
# pterodactyl_users (Data Source) | ||
|
||
The Pterodactyl users data source allows Terraform to read user data from the Pterodactyl Panel API. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
data "pterodactyl_users" "all" {} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Read-Only | ||
|
||
- `users` (Attributes List) The list of users. (see [below for nested schema](#nestedatt--users)) | ||
|
||
<a id="nestedatt--users"></a> | ||
### Nested Schema for `users` | ||
|
||
Read-Only: | ||
|
||
- `created_at` (String) The creation date of the user. | ||
- `email` (String) The email of the user. | ||
- `external_id` (String) The external ID of the user. | ||
- `first_name` (String) The first name of the user. | ||
- `id` (Number) The ID of the user. | ||
- `is_2fa` (Boolean) Is the user using 2FA. | ||
- `language` (String) The language of the user. | ||
- `last_name` (String) The last name of the user. | ||
- `root_admin` (Boolean) Is the user the root admin. | ||
- `updated_at` (String) The last update date of the user. | ||
- `username` (String) The username of the user. | ||
- `uuid` (String) The UUID of the user. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "pterodactyl Provider" | ||
subcategory: "" | ||
description: |- | ||
The Pterodactyl provider allows Terraform to interact with the Pterodactyl Panel API. | ||
--- | ||
|
||
# pterodactyl Provider | ||
|
||
The Pterodactyl provider allows Terraform to interact with the Pterodactyl Panel API. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
provider "pterodactyl" { | ||
host = "https://panel.example.com" | ||
api_key = "your-api-key" | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Optional | ||
|
||
- `api_key` (String, Sensitive) The Pterodactyl Panel API key. | ||
- `host` (String) The Pterodactyl Panel host URL. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "pterodactyl_user Resource - pterodactyl" | ||
subcategory: "" | ||
description: |- | ||
The Pterodactyl user resource allows Terraform to manage users in the Pterodactyl Panel API. | ||
--- | ||
|
||
# pterodactyl_user (Resource) | ||
|
||
The Pterodactyl user resource allows Terraform to manage users in the Pterodactyl Panel API. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
resource "pterodactyl_user" "example" { | ||
username = "terraformer" | ||
email = "terra@form.de" | ||
first_name = "Terra" | ||
last_name = "Former" | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `email` (String) The email of the user. | ||
- `first_name` (String) The first name of the user. | ||
- `last_name` (String) The last name of the user. | ||
- `username` (String) The username of the user. | ||
|
||
### Read-Only | ||
|
||
- `created_at` (String) The creation date of the user. | ||
- `id` (Number) The ID of the user. | ||
- `updated_at` (String) The last update date of the user. | ||
|
||
## Import | ||
|
||
Import is supported using the following syntax: | ||
|
||
```shell | ||
terraform import pterodactyl_user.example terraformer | ||
``` |