Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] add missing notes on priced gated features to docs #28

Merged
merged 1 commit into from
Dec 3, 2024
Merged

[Docs] add missing notes on priced gated features to docs #28

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/resources/api_key_settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,15 @@
page_title: "propelauth_api_key_settings Resource - propelauth"
subcategory: ""
description: |-
Api Key Configurations. This is for configuring the API global settings for your project.
Api Key Configurations. API Key authentication allows you to create API Keys for your end users as well as your organizations in order to protect requests they make to your product. This resource is for configuring the API key settings in your project.
Note: API Keys are only available for use in non-test environments for some pricing plans.
---

# propelauth_api_key_settings (Resource)

Api Key Configurations. This is for configuring the API global settings for your project.
Api Key Configurations. API Key authentication allows you to create API Keys for your end users as well as your organizations in order to protect requests they make to your product. This resource is for configuring the API key settings in your project.

Note: API Keys are only available for use in non-test environments for some pricing plans.

## Example Usage

Expand Down
4 changes: 2 additions & 2 deletions docs/resources/basic_auth_configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ resource "propelauth_basic_auth_configuration" "example" {
- `has_password_login` (Boolean) If true, your users will be able to log in using their email and password. The default setting is true.
- `has_passwordless_login` (Boolean) If true, your users will be able to log in using a magic link sent to their email. The default setting is false.
- `include_login_method` (Boolean) If true, the login method will be included in the access token. The default setting is false.See `https://docs.propelauth.com/overview/user-management/user-properties#login-method-property` for more information.
- `signup_domain_allowlist` (List of String) A list of email domains that are allowed to sign up.
- `signup_domain_blocklist` (List of String) A list of email domains that are blocked from signing up. This is only used if `signup_domain_allowlist` is empty.
- `signup_domain_allowlist` (List of String) A list of email domains that are allowed to sign up. Note: This feature is only available on some pricing plans.
- `signup_domain_blocklist` (List of String) A list of email domains that are blocked from signing up. This is only used if `signup_domain_allowlist` is empty.Note: This feature is only available on some pricing plans.
- `user_autologout_seconds` (Number) The number of seconds before a user is automatically logged out. The default setting is 1209600 (14 days).See also "user_autologout_type" for more information.
- `user_autologout_type` (String) This sets the behavior for when the counting for "user_autologout_seconds" starts. Valid values are "AfterInactivity" and the stricter "AfterLogin". The default setting is "AfterInactivity".
- `users_can_change_email` (Boolean) If true, your users will be able to change their email address. The default setting is true.
Expand Down
2 changes: 1 addition & 1 deletion docs/resources/custom_domain.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ resource "propelauth_custom_domain" "my_custom_domain" {
### Required

- `domain` (String) The domain name for the custom domain. Your resulting auth domain will be `auth.<domain>`. You can also specify a subdomain like prod.example.com which will result in auth.prod.example.com
- `environment` (String) The environment for which you are configuring the custom domain. Accepted values are `Staging` and `Prod`.
- `environment` (String) The environment for which you are configuring the custom domain. Accepted values are `Staging` and `Prod`. Note: Staging environments are only available on some pricing plans.

### Optional

Expand Down
2 changes: 1 addition & 1 deletion docs/resources/user_property_settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ resource "propelauth_user_property_settings" "example" {

### Optional

- `custom_properties` (Attributes List) Custom properties for the user. If no blocks are provided, no custom properties will be enabled. (see [below for nested schema](#nestedatt--custom_properties))
- `custom_properties` (Attributes List) Custom properties for the user. If no blocks are provided, no custom properties will be enabled. Note: Custom properties are only available on some pricing plans. (see [below for nested schema](#nestedatt--custom_properties))
- `metadata_property` (Attributes) Settings for the user's metadata property. If no block is provided, the metadata property will be disabled. (see [below for nested schema](#nestedatt--metadata_property))
- `name_property` (Attributes) Settings for the user's name property. If no block is provided, the name property will be disabled. (see [below for nested schema](#nestedatt--name_property))
- `phone_number_property` (Attributes) Settings for the user's phone number property. If no block is provided, the phone number property will be disabled. (see [below for nested schema](#nestedatt--phone_number_property))
Expand Down
5 changes: 4 additions & 1 deletion internal/provider/api_key_settings_resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,10 @@ func (r *apiKeySettingsResource) Metadata(ctx context.Context, req resource.Meta

func (r *apiKeySettingsResource) Schema(ctx context.Context, req resource.SchemaRequest, resp *resource.SchemaResponse) {
resp.Schema = schema.Schema{
Description: "Api Key Configurations. This is for configuring the API global settings for your project.",
Description: "Api Key Configurations. API Key authentication allows you to create API Keys for your end users as well as " +
"your organizations in order to protect requests they make to your product. This resource is for configuring the API " +
"key settings in your project.\n\nNote: API Keys are only available for use in non-test environments for some " +
"pricing plans.",
Attributes: map[string]schema.Attribute{
"personal_api_keys_enabled": schema.BoolAttribute{
Optional: true,
Expand Down
5 changes: 3 additions & 2 deletions internal/provider/basic_auth_configuration_resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,12 +62,13 @@ func (r *basicAuthConfigurationResource) Schema(ctx context.Context, req resourc
"signup_domain_allowlist": schema.ListAttribute{
ElementType: types.StringType,
Optional: true,
Description: "A list of email domains that are allowed to sign up.",
Description: "A list of email domains that are allowed to sign up. Note: This feature is only available on some pricing plans.",
},
"signup_domain_blocklist": schema.ListAttribute{
ElementType: types.StringType,
Optional: true,
Description: "A list of email domains that are blocked from signing up. This is only used if `signup_domain_allowlist` is empty.",
Description: "A list of email domains that are blocked from signing up. This is only used if `signup_domain_allowlist` is empty." +
"Note: This feature is only available on some pricing plans.",
},
"has_password_login": schema.BoolAttribute{
Optional: true,
Expand Down
3 changes: 2 additions & 1 deletion internal/provider/custom_domain_resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,8 @@ func (r *customDomainResource) Schema(ctx context.Context, req resource.SchemaRe
PlanModifiers: []planmodifier.String{
stringplanmodifier.RequiresReplace(),
},
Description: "The environment for which you are configuring the custom domain. Accepted values are `Staging` and `Prod`.",
Description: "The environment for which you are configuring the custom domain. Accepted values are `Staging` and `Prod`. " +
"Note: Staging environments are only available on some pricing plans.",
},
"domain": schema.StringAttribute{
Required: true,
Expand Down
5 changes: 3 additions & 2 deletions internal/provider/user_property_settings_resource.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,8 +221,9 @@ func (r *userPropertySettingsResource) Schema(ctx context.Context, req resource.
},
},
"custom_properties": schema.ListNestedAttribute{
Optional: true,
Description: "Custom properties for the user. If no blocks are provided, no custom properties will be enabled.",
Optional: true,
Description: "Custom properties for the user. If no blocks are provided, no custom properties will be enabled. " +
"Note: Custom properties are only available on some pricing plans.",
NestedObject: schema.NestedAttributeObject{
Attributes: map[string]schema.Attribute{
"name": schema.StringAttribute{
Expand Down
Loading