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.

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

Update platform_saml_settings docs to drop removed attribute #196

Merged
merged 1 commit into from
Jan 28, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
4 changes: 2 additions & 2 deletions docs/resources/saml_settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ resource "platform_saml_settings" "my-okta-saml-settings" {
name_id_attribute = "id"
login_url = "http://tempurl.org/saml"
logout_url = "https://myaccount.okta.com"
no_auto_user_creation = false
auto_user_creation = true
service_provider_name = "okta"
allow_user_to_access_profile = true
auto_redirect = true
Expand All @@ -51,7 +51,7 @@ resource "platform_saml_settings" "my-okta-saml-settings" {
- `allow_user_to_access_profile` (Boolean) When set, auto created users will have access to their profile page and will be able to perform actions such as generating an API key. Default value is `false`.
- `auto_redirect` (Boolean) When set, clicking on the login link will direct users to the configured SAML login URL. Default value is `false`.
- `auto_user_creation` (Boolean) When set, authenticated users are automatically created in Artifactory. When not set, for every request from an SSO user, the user is temporarily associated with default groups (if such groups are defined), and the permissions for these groups apply. Without automatic user creation, you must manually create the user inside Artifactory to manage user permissions not attached to their default groups. Default value is `true`.
- `email_attribute` (String) If `no_auto_user_creation` is diabled or an internal user exists, the system will set the user's email to the value in this attribute that is returned by the SAML login XML response.
- `email_attribute` (String) If `auto_user_creation` is enabled or an internal user exists, the system will set the user's email to the value in this attribute that is returned by the SAML login XML response.
- `enable` (Boolean) When set, SAML integration is enabled and users may be authenticated via a SAML server. Default value is `true`.
- `group_attribute` (String) The group attribute in the SAML login XML response. Note that the system will search for a case-sensitive match to an existing group..
- `ldap_group_settings` (Set of String) List of LDAP group setting names. Only support in Artifactory 7.98 or later. See [Enabling Synchronization of LDAP Groups for SAML SSO](https://jfrog.com/help/r/jfrog-platform-administration-documentation/enabling-synchronization-of-ldap-groups-for-saml-sso) for more details.
Expand Down
2 changes: 1 addition & 1 deletion examples/resources/platform_saml_settings/resource.tf
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ resource "platform_saml_settings" "my-okta-saml-settings" {
name_id_attribute = "id"
login_url = "http://tempurl.org/saml"
logout_url = "https://myaccount.okta.com"
no_auto_user_creation = false
auto_user_creation = true
service_provider_name = "okta"
allow_user_to_access_profile = true
auto_redirect = true
Expand Down
2 changes: 1 addition & 1 deletion pkg/platform/resource_saml_settings.go
Original file line number Diff line number Diff line change
Expand Up @@ -205,7 +205,7 @@ var samlSettingsSchemaV0 = map[string]schema.Attribute{
Validators: []validator.String{
stringvalidator.LengthAtLeast(1),
},
MarkdownDescription: "If `no_auto_user_creation` is diabled or an internal user exists, the system will set the user's email to the value in this attribute that is returned by the SAML login XML response.",
MarkdownDescription: "If `auto_user_creation` is enabled or an internal user exists, the system will set the user's email to the value in this attribute that is returned by the SAML login XML response.",
},
"group_attribute": schema.StringAttribute{
Optional: true,
Expand Down
Loading