-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add resource 'platform_saml_settings'
- Loading branch information
Showing
7 changed files
with
636 additions
and
1 deletion.
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
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,68 @@ | ||
--- | ||
# generated by https://github.com/hashicorp/terraform-plugin-docs | ||
page_title: "platform_saml_settings Resource - terraform-provider-platform" | ||
subcategory: "" | ||
description: |- | ||
Provides a JFrog SAML SSO Settings https://jfrog.com/help/r/jfrog-platform-administration-documentation/saml-sso resource. | ||
~>Only available for self-hosted instances. | ||
--- | ||
|
||
# platform_saml_settings (Resource) | ||
|
||
Provides a JFrog [SAML SSO Settings](https://jfrog.com/help/r/jfrog-platform-administration-documentation/saml-sso) resource. | ||
|
||
~>Only available for self-hosted instances. | ||
|
||
## Example Usage | ||
|
||
```terraform | ||
resource "platform_saml_settings" "my-okta-saml-settings" { | ||
name = "my-okta-saml-settings" | ||
enable = true | ||
certificate = "MIICTjCCA...gPRXbm49Mz4o1nbwH" | ||
email_attribute = "email" | ||
group_attribute = "group" | ||
name_id_attribute = "id" | ||
login_url = "http://tempurl.org/saml" | ||
logout_url = "https://myaccount.okta.com" | ||
no_auto_user_creation = false | ||
service_provider_name = "okta" | ||
allow_user_to_access_profile = true | ||
auto_redirect = true | ||
sync_groups = true | ||
verify_audience_restriction = true | ||
use_encrypted_assertion = false | ||
} | ||
``` | ||
|
||
<!-- schema generated by tfplugindocs --> | ||
## Schema | ||
|
||
### Required | ||
|
||
- `certificate` (String) The certificate for SAML Authentication in Base64 format. NOTE! The certificate must contain the public key to allow Artifactory to verify sign-in requests. | ||
- `login_url` (String) The identity provider login URL (when you try to login, the service provider redirects to this URL). | ||
- `logout_url` (String) The identity provider logout URL (when you try to logout, the service provider redirects to this URL). | ||
- `name` (String) SAML Settings name. | ||
- `service_provider_name` (String) The SAML service provider name. This should be a URI that is also known as the entityID, providerID, or entity identity. | ||
|
||
### Optional | ||
|
||
- `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`. | ||
- `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.. | ||
- `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.. | ||
- `name_id_attribute` (String) The username attribute used to configure the SSO URL for the identity provider. | ||
- `no_auto_user_creation` (Boolean) When disabled, the system will automatically create new users for those who have logged in using SAML, and assign them to the default groups. Default value is `false`. | ||
- `sync_groups` (Boolean) When set, in addition to the groups the user is already associated with, he will also be associated with the groups returned in the SAML login response. Note that the user's association with the returned groups is not persistent. It is only valid for the current login session. Default value is `false`. | ||
- `use_encrypted_assertion` (Boolean) When set, an X.509 public certificate will be created by Artifactory. Download this certificate and upload it to your IDP and choose your own encryption algorithm. This process will let you encrypt the assertion section in your SAML response. Default value is `false`. | ||
- `verify_audience_restriction` (Boolean) Set this flag to specify who the assertion is intended for. The "audience" will be the service provider and is typically a URL but can technically be formatted as any string of data. Default value is `true`. | ||
|
||
## Import | ||
|
||
Import is supported using the following syntax: | ||
|
||
```shell | ||
terraform import platform_saml_settings.my-okta-saml-settings my-okta-saml-settings | ||
``` |
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 @@ | ||
terraform import platform_saml_settings.my-okta-saml-settings my-okta-saml-settings |
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,17 @@ | ||
resource "platform_saml_settings" "my-okta-saml-settings" { | ||
name = "my-okta-saml-settings" | ||
enable = true | ||
certificate = "MIICTjCCA...gPRXbm49Mz4o1nbwH" | ||
email_attribute = "email" | ||
group_attribute = "group" | ||
name_id_attribute = "id" | ||
login_url = "http://tempurl.org/saml" | ||
logout_url = "https://myaccount.okta.com" | ||
no_auto_user_creation = false | ||
service_provider_name = "okta" | ||
allow_user_to_access_profile = true | ||
auto_redirect = true | ||
sync_groups = true | ||
verify_audience_restriction = true | ||
use_encrypted_assertion = false | ||
} |
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
Oops, something went wrong.