Skip to content

Commit

Permalink
ENG-13675: update documentation for identity_provider field
Browse files Browse the repository at this point in the history
Rephrase
  • Loading branch information
ricardorey10 committed Mar 21, 2024
1 parent f42b390 commit b2dd809
Showing 1 changed file with 15 additions and 3 deletions.
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"+
" - `v4.12` and below:\n - Provide the ID (Alias) of the identity provider "+
"integration to allow user authentication using an IdP.\n"+
" - `v4.13` and later:\n - If not supplied, then end-user "+
"authentication is disabled.\n - If end-user authentication "+
"with Cyral Access Token is desired, then set to `ACCESS_TOKEN` or any "+
"other non-empty string.\n - 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

0 comments on commit b2dd809

Please sign in to comment.