Skip to content

Commit a13a0c6

Browse files
Trozzclaude
Trozz
and
claude
authored
docs: Update documentation and attempt to trigger Terraform Registry refresh (#41)
Co-authored-by: Claude Opus 4.5 <noreply@anthropic.com>
1 parent 41295e8 commit a13a0c6

File tree

14 files changed

+57
-40
lines changed

14 files changed

+57
-40
lines changed

‎docs/data-sources/client.md‎

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
3-
page_title: "pocketid_client Data Source - pocketid"
3+
page_title: "pocketid_client Data Source - terraform-provider-pocketid"
44
subcategory: ""
55
description: |-
66
Fetches an OIDC client from Pocket-ID by its ID.
@@ -70,6 +70,8 @@ output "existing_client_pkce_enabled" {
7070
- `callback_urls` (List of String) List of allowed callback URLs for the OIDC client.
7171
- `has_logo` (Boolean) Whether the client has a logo configured.
7272
- `is_public` (Boolean) Whether this is a public client (no client secret).
73+
- `launch_url` (String) Optional launch URL associated with the client.
7374
- `logout_callback_urls` (List of String) List of allowed logout callback URLs for the OIDC client.
7475
- `name` (String) The display name of the OIDC client.
7576
- `pkce_enabled` (Boolean) Whether PKCE is enabled for this client.
77+
- `requires_reauthentication` (Boolean) Whether this client requires reauthentication on each authorization.

‎docs/data-sources/clients.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
3-
page_title: "pocketid_clients Data Source - pocketid"
3+
page_title: "pocketid_clients Data Source - terraform-provider-pocketid"
44
subcategory: ""
55
description: |-
66
Fetches all OIDC clients from Pocket-ID.
@@ -90,8 +90,8 @@ Read-Only:
9090
- `has_logo` (Boolean) Whether the client has a logo configured.
9191
- `id` (String) The ID of the OIDC client.
9292
- `is_public` (Boolean) Whether this is a public client (no client secret).
93+
- `launch_url` (String) Optional launch URL associated with the client.
9394
- `logout_callback_urls` (List of String) List of allowed logout callback URLs for the OIDC client.
9495
- `name` (String) The display name of the OIDC client.
9596
- `pkce_enabled` (Boolean) Whether PKCE is enabled for this client.
96-
- `requires_reauthentication` (Boolean) Whether this client requires reauthentication on all authorizations.
97-
- `launch_url` (String) Optional launch URL associated with the client.
97+
- `requires_reauthentication` (Boolean) Whether this client requires reauthentication for certain flows.

‎docs/data-sources/group.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
page_title: "pocketid_group Data Source - pocketid"
2+
page_title: "pocketid_group Data Source - terraform-provider-pocketid"
33
subcategory: ""
44
description: |-
55
Retrieves information about a Pocket-ID group.

‎docs/data-sources/groups.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
page_title: "pocketid_groups Data Source - pocketid"
2+
page_title: "pocketid_groups Data Source - terraform-provider-pocketid"
33
subcategory: ""
44
description: |-
55
Retrieves information about all Pocket-ID groups.

‎docs/data-sources/user.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
3-
page_title: "pocketid_user Data Source - pocketid"
3+
page_title: "pocketid_user Data Source - terraform-provider-pocketid"
44
subcategory: ""
55
description: |-
66
Fetches a user from Pocket-ID by their ID or username. Exactly one of id or username must be specified.

‎docs/data-sources/users.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
3-
page_title: "pocketid_users Data Source - pocketid"
3+
page_title: "pocketid_users Data Source - terraform-provider-pocketid"
44
subcategory: ""
55
description: |-
66
Fetches all users from Pocket-ID.

‎docs/resources/client.md‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
3-
page_title: "pocketid_client Resource - pocketid"
3+
page_title: "pocketid_client Resource - terraform-provider-pocketid"
44
subcategory: ""
55
description: |-
66
Manages an OIDC client in Pocket-ID. OIDC clients are applications that can authenticate users through Pocket-ID.
@@ -16,7 +16,7 @@ Manages an OIDC client in Pocket-ID. OIDC clients are applications that can auth
1616
## Example Usage
1717

1818
```terraform
19-
## Create a public SPA client (no client secret)
19+
# Create a public SPA client (no client secret)
2020
resource "pocketid_client" "spa_app" {
2121
name = "React SPA Application"
2222
@@ -32,10 +32,10 @@ resource "pocketid_client" "spa_app" {
3232
3333
is_public = true
3434
pkce_enabled = true
35-
launch_url = "https://spa.example.com/launch"
35+
launch_url = "https://spa.example.com"
3636
}
3737
38-
## Create a client with a custom client ID
38+
# Create a client with a custom client ID
3939
resource "pocketid_client" "custom_id_app" {
4040
name = "Custom ID Application"
4141
client_id = "my-custom-client-id"
@@ -46,8 +46,6 @@ resource "pocketid_client" "custom_id_app" {
4646
4747
is_public = false
4848
pkce_enabled = true
49-
requires_reauthentication = true
50-
launch_url = "https://custom.example.com/launch"
5149
}
5250
5351
# Create a confidential web application
@@ -104,8 +102,10 @@ resource "pocketid_client" "admin_portal" {
104102
"https://admin.example.com/logout"
105103
]
106104
107-
is_public = false
108-
pkce_enabled = true
105+
is_public = false
106+
pkce_enabled = true
107+
requires_reauthentication = true
108+
launch_url = "https://admin.example.com"
109109
110110
# Only admins and developers can access this client
111111
allowed_user_groups = [
@@ -147,13 +147,13 @@ output "spa_client_id" {
147147

148148
### Optional
149149

150-
- `client_id` (String) The client ID to use for the OIDC client. If not set, one will be generated.
151150
- `allowed_user_groups` (List of String) List of user group IDs that are allowed to use this client. If empty, all users can use this client.
151+
- `client_id` (String) The client ID to use for the OIDC client. If not set, one will be generated.
152152
- `is_public` (Boolean) Whether this is a public client (no client secret). Defaults to false.
153+
- `launch_url` (String) Optional launch URL associated with the client.
153154
- `logout_callback_urls` (List of String) List of allowed logout callback URLs for the OIDC client.
154155
- `pkce_enabled` (Boolean) Whether PKCE is enabled for this client. Defaults to true.
155-
- `requires_reauthentication` (Boolean) Whether this client requires reauthentication on each authorization. Defaults to false.
156-
- `launch_url` (String) Optional launch URL associated with the client.
156+
- `requires_reauthentication` (Boolean) Whether this client requires reauthentication for certain flows. Defaults to false.
157157

158158
### Read-Only
159159

‎docs/resources/group.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
3-
page_title: "pocketid_group Resource - pocketid"
3+
page_title: "pocketid_group Resource - terraform-provider-pocketid"
44
subcategory: ""
55
description: |-
66
Manages a user group in Pocket-ID. Groups can be used to organize users and control access to OIDC clients.

‎docs/resources/one_time_access_token.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
3-
page_title: "pocketid_one_time_access_token Resource - pocketid"
3+
page_title: "pocketid_one_time_access_token Resource - terraform-provider-pocketid"
44
subcategory: ""
55
description: |-
66
Manages a one-time access token for a user in Pocket-ID. These tokens allow users to authenticate when they don't have access to their passkey.
@@ -99,7 +99,7 @@ resource "example_email" "welcome" {
9999

100100
### Optional
101101

102-
- `skip_recreate` (Boolean) If true, the resource will not be recreated when the token is not found (used or expired). This is useful for initial user setup where the token is sent via another provider.
102+
- `skip_recreate` (Boolean) If true (default), the resource will not be recreated when the token is not found (used or expired). This is useful for initial user setup where the token is sent via another provider. Note: Setting this to false will enable standard Terraform behavior, where the resource is recreated if the token is missing.
103103

104104
### Read-Only
105105

‎docs/resources/user.md‎

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
# generated by https://github.com/hashicorp/terraform-plugin-docs
3-
page_title: "pocketid_user Resource - pocketid"
3+
page_title: "pocketid_user Resource - terraform-provider-pocketid"
44
subcategory: ""
55
description: |-
66
Manages a user in Pocket-ID.
@@ -24,14 +24,13 @@ resource "pocketid_user" "example" {
2424
2525
# Create a user with full details
2626
resource "pocketid_user" "full_example" {
27-
username = "jane.smith"
28-
email = "jane.smith@example.com"
29-
first_name = "Jane"
30-
last_name = "Smith"
31-
display_name = "Jane Smith" # Optional: if not set, defaults to "first_name last_name"
32-
locale = "en-US"
33-
is_admin = false
34-
disabled = false
27+
username = "jane.smith"
28+
email = "jane.smith@example.com"
29+
first_name = "Jane"
30+
last_name = "Smith"
31+
locale = "en-US"
32+
is_admin = false
33+
disabled = false
3534
}
3635
3736
# Create an admin user
@@ -98,7 +97,7 @@ resource "pocketid_user" "team" {
9897
### Optional
9998

10099
- `disabled` (Boolean) Whether the user account is disabled. Defaults to false. Note: Due to API limitations, this field cannot be set during user creation. To create a disabled user, first create the user and then update it to set disabled to true.
101-
- `display_name` (String) The display name of the user. If not provided, it is automatically set to first_name + last_name.
100+
- `display_name` (String) The display name of the user. Computed from first and last name if not set.
102101
- `first_name` (String) The first name of the user.
103102
- `groups` (Set of String) List of group IDs the user belongs to.
104103
- `is_admin` (Boolean) Whether the user has administrator privileges. Defaults to false.

0 commit comments

Comments
 (0)