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

ENG-13675: update documentation for identity_provider field #516

Merged
merged 2 commits into from
Mar 21, 2024
Merged

ENG-13675: update documentation for identity_provider field #516

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b2dd809
ENG-13675: update documentation for identity_provider field
ricardorey10 Mar 13, 2024
1f23ef3
Rebase with prettyfier fix
ricardorey10 Mar 21, 2024
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
18 changes: 15 additions & 3 deletions cyral/internal/repository/confauth/resource_cyral_repository_conf_auth.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,9 +215,21 @@ func repositoryConfAuthResourceSchemaV0() *schema.Resource {
Default: DefaultClientTLS,
},
"identity_provider": {
Description: "The ID (Alias) of the identity provider integration.",
Type: schema.TypeString,
Optional: true,
Description: fmt.Sprintf(
"The semantics of this field changed in control planes `v4.13` and later. See how "+
"it should be configured depending on your control plane version:\n"+
"\t- `v4.12` and below:\n\t\t- Provide the ID (Alias) of the identity provider "+
"integration to allow user authentication using an IdP.\n"+
"\t- `v4.13` and later:\n\t\t- If not supplied, then end-user "+
"authentication is disabled.\n\t\t- If end-user authentication "+
"with Cyral Access Token is desired, then set to `ACCESS_TOKEN` or any "+
"other non-empty string.\n\t\t- If end-user authentication with "+
"AWS IAM is desired, then this must be the ID of an AWS IAM integration, "+
"and the `auth_type` attribute must be set to `%s`.",
AwsIAMAuthType,
),
Type: schema.TypeString,
Optional: true,
},
"repo_tls": {
Description: fmt.Sprintf("Is TLS enabled for the repository? Default is %q.", DefaultRepoTLS),
Expand Down
8 changes: 7 additions & 1 deletion docs/resources/repository_conf_auth.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,13 @@ resource "cyral_repository_conf_auth" "some_resource_name" {
- `ACCESS_TOKEN`
- `AWS_IAM`
- `client_tls` (String) Is the repo Client using TLS? Default is "disable".
- `identity_provider` (String) The ID (Alias) of the identity provider integration.
- `identity_provider` (String) The semantics of this field changed in control planes `v4.13` and later. See how it should be configured depending on your control plane version:
- `v4.12` and below:
- Provide the ID (Alias) of the identity provider integration to allow user authentication using an IdP.
- `v4.13` and later:
- If not supplied, then end-user authentication is disabled.
- If end-user authentication with Cyral Access Token is desired, then set to `ACCESS_TOKEN` or any other non-empty string.
- If end-user authentication with AWS IAM is desired, then this must be the ID of an AWS IAM integration, and the `auth_type` attribute must be set to `AWS_IAM`.
- `repo_tls` (String) Is TLS enabled for the repository? Default is "disable".

### Read-Only
Expand Down
Loading