Skip to content

Latest commit

 

History

History
1822 lines (1154 loc) · 75.6 KB

samlSettings.python.md

File metadata and controls

1822 lines (1154 loc) · 75.6 KB

samlSettings Submodule

Constructs

SamlSettings

Represents a {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings tfe_saml_settings}.

Initializers 

from cdktf_cdktf_provider_tfe import saml_settings

samlSettings.SamlSettings(
  scope: Construct,
  id: str,
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  idp_cert: str,
  slo_endpoint_url: str,
  sso_endpoint_url: str,
  attr_groups: str = None,
  attr_site_admin: str = None,
  attr_username: str = None,
  authn_requests_signed: typing.Union[bool, IResolvable] = None,
  certificate: str = None,
  debug: typing.Union[bool, IResolvable] = None,
  private_key: str = None,
  signature_digest_method: str = None,
  signature_signing_method: str = None,
  site_admin_role: str = None,
  sso_api_token_session_timeout: typing.Union[int, float] = None,
  team_management_enabled: typing.Union[bool, IResolvable] = None,
  want_assertions_signed: typing.Union[bool, IResolvable] = None
)
Name Type Description
scope constructs.Construct The scope in which to define this construct.
id str The scoped construct ID.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
idp_cert str Identity Provider Certificate specifies the PEM encoded X.509 Certificate as provided by the IdP configuration.
slo_endpoint_url str Single Log Out URL specifies the HTTPS endpoint on your IdP for single logout requests.
sso_endpoint_url str Single Sign On URL specifies the HTTPS endpoint on your IdP for single sign-on requests.
attr_groups str Team Attribute Name specifies the name of the SAML attribute that determines team membership.
attr_site_admin str Specifies the role for site admin access. Overrides the "Site Admin Role" method.
attr_username str Username Attribute Name specifies the name of the SAML attribute that determines the user's username.
authn_requests_signed typing.Union[bool, cdktf.IResolvable] Ensure that samlp:AuthnRequest messages are signed.
certificate str The certificate used for request and assertion signing.
debug typing.Union[bool, cdktf.IResolvable] When sign-on fails and this is enabled, the SAMLResponse XML will be displayed on the login page.
private_key str The private key used for request and assertion signing.
signature_digest_method str Signature Digest Method. Must be either SHA1 or SHA256. Defaults to SHA256.
signature_signing_method str Signature Signing Method. Must be either SHA1 or SHA256. Defaults to SHA256.
site_admin_role str Specifies the role for site admin access, provided in the list of roles sent in the Team Attribute Name attribute.
sso_api_token_session_timeout typing.Union[int, float] Specifies the Single Sign On session timeout in seconds. Defaults to 14 days.
team_management_enabled typing.Union[bool, cdktf.IResolvable] Set it to false if you would rather use Terraform Enterprise to manage team membership.
want_assertions_signed typing.Union[bool, cdktf.IResolvable] Ensure that saml:Assertion elements are signed.
scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

idRequired
  • Type: str

The scoped construct ID.

Must be unique amongst siblings in the same scope

connectionOptional
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional
  • Type: cdktf.ITerraformIterator
lifecycleOptional
  • Type: cdktf.TerraformResourceLifecycle
providerOptional
  • Type: cdktf.TerraformProvider
provisionersOptional
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
idp_certRequired
  • Type: str

Identity Provider Certificate specifies the PEM encoded X.509 Certificate as provided by the IdP configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#idp_cert SamlSettings#idp_cert}

slo_endpoint_urlRequired
  • Type: str

Single Log Out URL specifies the HTTPS endpoint on your IdP for single logout requests.

This value is provided by the IdP configuration

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#slo_endpoint_url SamlSettings#slo_endpoint_url}

sso_endpoint_urlRequired
  • Type: str

Single Sign On URL specifies the HTTPS endpoint on your IdP for single sign-on requests.

This value is provided by the IdP configuration

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#sso_endpoint_url SamlSettings#sso_endpoint_url}

attr_groupsOptional
  • Type: str

Team Attribute Name specifies the name of the SAML attribute that determines team membership.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#attr_groups SamlSettings#attr_groups}

attr_site_adminOptional
  • Type: str

Specifies the role for site admin access. Overrides the "Site Admin Role" method.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#attr_site_admin SamlSettings#attr_site_admin}

attr_usernameOptional
  • Type: str

Username Attribute Name specifies the name of the SAML attribute that determines the user's username.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#attr_username SamlSettings#attr_username}

authn_requests_signedOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Ensure that samlp:AuthnRequest messages are signed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#authn_requests_signed SamlSettings#authn_requests_signed}

certificateOptional
  • Type: str

The certificate used for request and assertion signing.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#certificate SamlSettings#certificate}

debugOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

When sign-on fails and this is enabled, the SAMLResponse XML will be displayed on the login page.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#debug SamlSettings#debug}

private_keyOptional
  • Type: str

The private key used for request and assertion signing.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#private_key SamlSettings#private_key}

signature_digest_methodOptional
  • Type: str

Signature Digest Method. Must be either SHA1 or SHA256. Defaults to SHA256.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#signature_digest_method SamlSettings#signature_digest_method}

signature_signing_methodOptional
  • Type: str

Signature Signing Method. Must be either SHA1 or SHA256. Defaults to SHA256.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#signature_signing_method SamlSettings#signature_signing_method}

site_admin_roleOptional
  • Type: str

Specifies the role for site admin access, provided in the list of roles sent in the Team Attribute Name attribute.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#site_admin_role SamlSettings#site_admin_role}

sso_api_token_session_timeoutOptional
  • Type: typing.Union[int, float]

Specifies the Single Sign On session timeout in seconds. Defaults to 14 days.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#sso_api_token_session_timeout SamlSettings#sso_api_token_session_timeout}

team_management_enabledOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Set it to false if you would rather use Terraform Enterprise to manage team membership.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#team_management_enabled SamlSettings#team_management_enabled}

want_assertions_signedOptional
  • Type: typing.Union[bool, cdktf.IResolvable]

Ensure that saml:Assertion elements are signed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#want_assertions_signed SamlSettings#want_assertions_signed}

Methods

Name Description
to_string Returns a string representation of this construct.
add_override No description.
override_logical_id Overrides the auto-generated logical ID with a specific ID.
reset_override_logical_id Resets a previously passed logical Id to use the auto-generated logical id again.
to_hcl_terraform No description.
to_metadata No description.
to_terraform Adds this resource to the terraform JSON output.
add_move_target Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
get_any_map_attribute No description.
get_boolean_attribute No description.
get_boolean_map_attribute No description.
get_list_attribute No description.
get_number_attribute No description.
get_number_list_attribute No description.
get_number_map_attribute No description.
get_string_attribute No description.
get_string_map_attribute No description.
has_resource_move No description.
import_from No description.
interpolation_for_attribute No description.
move_from_id Move the resource corresponding to "id" to this resource.
move_to Moves this resource to the target resource given by moveTarget.
move_to_id Moves this resource to the resource corresponding to "id".
reset_attr_groups No description.
reset_attr_site_admin No description.
reset_attr_username No description.
reset_authn_requests_signed No description.
reset_certificate No description.
reset_debug No description.
reset_private_key No description.
reset_signature_digest_method No description.
reset_signature_signing_method No description.
reset_site_admin_role No description.
reset_sso_api_token_session_timeout No description.
reset_team_management_enabled No description.
reset_want_assertions_signed No description.
to_string 
def to_string() -> str

Returns a string representation of this construct.

add_override 
def add_override(
  path: str,
  value: typing.Any
) -> None
pathRequired
  • Type: str
valueRequired
  • Type: typing.Any
override_logical_id 
def override_logical_id(
  new_logical_id: str
) -> None

Overrides the auto-generated logical ID with a specific ID.

new_logical_idRequired
  • Type: str

The new logical ID to use for this stack element.

reset_override_logical_id 
def reset_override_logical_id() -> None

Resets a previously passed logical Id to use the auto-generated logical id again.

to_hcl_terraform 
def to_hcl_terraform() -> typing.Any
to_metadata 
def to_metadata() -> typing.Any
to_terraform 
def to_terraform() -> typing.Any

Adds this resource to the terraform JSON output.

add_move_target 
def add_move_target(
  move_target: str
) -> None

Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.

move_targetRequired
  • Type: str

The string move target that will correspond to this resource.

get_any_map_attribute 
def get_any_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Any]
terraform_attributeRequired
  • Type: str
get_boolean_attribute 
def get_boolean_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
get_boolean_map_attribute 
def get_boolean_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[bool]
terraform_attributeRequired
  • Type: str
get_list_attribute 
def get_list_attribute(
  terraform_attribute: str
) -> typing.List[str]
terraform_attributeRequired
  • Type: str
get_number_attribute 
def get_number_attribute(
  terraform_attribute: str
) -> typing.Union[int, float]
terraform_attributeRequired
  • Type: str
get_number_list_attribute 
def get_number_list_attribute(
  terraform_attribute: str
) -> typing.List[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_number_map_attribute 
def get_number_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[typing.Union[int, float]]
terraform_attributeRequired
  • Type: str
get_string_attribute 
def get_string_attribute(
  terraform_attribute: str
) -> str
terraform_attributeRequired
  • Type: str
get_string_map_attribute 
def get_string_map_attribute(
  terraform_attribute: str
) -> typing.Mapping[str]
terraform_attributeRequired
  • Type: str
has_resource_move 
def has_resource_move() -> typing.Union[TerraformResourceMoveByTarget, TerraformResourceMoveById]
import_from 
def import_from(
  id: str,
  provider: TerraformProvider = None
) -> None
idRequired
  • Type: str
providerOptional
  • Type: cdktf.TerraformProvider
interpolation_for_attribute 
def interpolation_for_attribute(
  terraform_attribute: str
) -> IResolvable
terraform_attributeRequired
  • Type: str
move_from_id 
def move_from_id(
  id: str
) -> None

Move the resource corresponding to "id" to this resource.

Note that the resource being moved from must be marked as moved using it's instance function.

idRequired
  • Type: str

Full id of resource being moved from, e.g. "aws_s3_bucket.example".

move_to 
def move_to(
  move_target: str,
  index: typing.Union[str, typing.Union[int, float]] = None
) -> None

Moves this resource to the target resource given by moveTarget.

move_targetRequired
  • Type: str

The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.

indexOptional
  • Type: typing.Union[str, typing.Union[int, float]]

Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.

move_to_id 
def move_to_id(
  id: str
) -> None

Moves this resource to the resource corresponding to "id".

idRequired
  • Type: str

Full id of resource to move to, e.g. "aws_s3_bucket.example".

reset_attr_groups 
def reset_attr_groups() -> None
reset_attr_site_admin 
def reset_attr_site_admin() -> None
reset_attr_username 
def reset_attr_username() -> None
reset_authn_requests_signed 
def reset_authn_requests_signed() -> None
reset_certificate 
def reset_certificate() -> None
reset_debug 
def reset_debug() -> None
reset_private_key 
def reset_private_key() -> None
reset_signature_digest_method 
def reset_signature_digest_method() -> None
reset_signature_signing_method 
def reset_signature_signing_method() -> None
reset_site_admin_role 
def reset_site_admin_role() -> None
reset_sso_api_token_session_timeout 
def reset_sso_api_token_session_timeout() -> None
reset_team_management_enabled 
def reset_team_management_enabled() -> None
reset_want_assertions_signed 
def reset_want_assertions_signed() -> None

Static Functions

Name Description
is_construct Checks if x is a construct.
is_terraform_element No description.
is_terraform_resource No description.
generate_config_for_import Generates CDKTF code for importing a SamlSettings resource upon running "cdktf plan ".
is_construct 
from cdktf_cdktf_provider_tfe import saml_settings

samlSettings.SamlSettings.is_construct(
  x: typing.Any
)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

xRequired
  • Type: typing.Any

Any object.

is_terraform_element 
from cdktf_cdktf_provider_tfe import saml_settings

samlSettings.SamlSettings.is_terraform_element(
  x: typing.Any
)
xRequired
  • Type: typing.Any
is_terraform_resource 
from cdktf_cdktf_provider_tfe import saml_settings

samlSettings.SamlSettings.is_terraform_resource(
  x: typing.Any
)
xRequired
  • Type: typing.Any
generate_config_for_import 
from cdktf_cdktf_provider_tfe import saml_settings

samlSettings.SamlSettings.generate_config_for_import(
  scope: Construct,
  import_to_id: str,
  import_from_id: str,
  provider: TerraformProvider = None
)

Generates CDKTF code for importing a SamlSettings resource upon running "cdktf plan ".

scopeRequired
  • Type: constructs.Construct

The scope in which to define this construct.

import_to_idRequired
  • Type: str

The construct id used in the generated config for the SamlSettings to import.

import_from_idRequired
  • Type: str

The id of the existing SamlSettings that should be imported.

Refer to the {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#import import section} in the documentation of this resource for the id to use

providerOptional
  • Type: cdktf.TerraformProvider

? Optional instance of the provider where the SamlSettings to import is found.

Properties

Name Type Description
node constructs.Node The tree node.
cdktf_stack cdktf.TerraformStack No description.
fqn str No description.
friendly_unique_id str No description.
terraform_meta_arguments typing.Mapping[typing.Any] No description.
terraform_resource_type str No description.
terraform_generator_metadata cdktf.TerraformProviderGeneratorMetadata No description.
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[str] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
acs_consumer_url str No description.
enabled cdktf.IResolvable No description.
id str No description.
metadata_url str No description.
old_idp_cert str No description.
attr_groups_input str No description.
attr_site_admin_input str No description.
attr_username_input str No description.
authn_requests_signed_input typing.Union[bool, cdktf.IResolvable] No description.
certificate_input str No description.
debug_input typing.Union[bool, cdktf.IResolvable] No description.
idp_cert_input str No description.
private_key_input str No description.
signature_digest_method_input str No description.
signature_signing_method_input str No description.
site_admin_role_input str No description.
slo_endpoint_url_input str No description.
sso_api_token_session_timeout_input typing.Union[int, float] No description.
sso_endpoint_url_input str No description.
team_management_enabled_input typing.Union[bool, cdktf.IResolvable] No description.
want_assertions_signed_input typing.Union[bool, cdktf.IResolvable] No description.
attr_groups str No description.
attr_site_admin str No description.
attr_username str No description.
authn_requests_signed typing.Union[bool, cdktf.IResolvable] No description.
certificate str No description.
debug typing.Union[bool, cdktf.IResolvable] No description.
idp_cert str No description.
private_key str No description.
signature_digest_method str No description.
signature_signing_method str No description.
site_admin_role str No description.
slo_endpoint_url str No description.
sso_api_token_session_timeout typing.Union[int, float] No description.
sso_endpoint_url str No description.
team_management_enabled typing.Union[bool, cdktf.IResolvable] No description.
want_assertions_signed typing.Union[bool, cdktf.IResolvable] No description.
nodeRequired 
node: Node
  • Type: constructs.Node

The tree node.

cdktf_stackRequired 
cdktf_stack: TerraformStack
  • Type: cdktf.TerraformStack
fqnRequired 
fqn: str
  • Type: str
friendly_unique_idRequired 
friendly_unique_id: str
  • Type: str
terraform_meta_argumentsRequired 
terraform_meta_arguments: typing.Mapping[typing.Any]
  • Type: typing.Mapping[typing.Any]
terraform_resource_typeRequired 
terraform_resource_type: str
  • Type: str
terraform_generator_metadataOptional 
terraform_generator_metadata: TerraformProviderGeneratorMetadata
  • Type: cdktf.TerraformProviderGeneratorMetadata
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[str]
  • Type: typing.List[str]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
acs_consumer_urlRequired 
acs_consumer_url: str
  • Type: str
enabledRequired 
enabled: IResolvable
  • Type: cdktf.IResolvable
idRequired 
id: str
  • Type: str
metadata_urlRequired 
metadata_url: str
  • Type: str
old_idp_certRequired 
old_idp_cert: str
  • Type: str
attr_groups_inputOptional 
attr_groups_input: str
  • Type: str
attr_site_admin_inputOptional 
attr_site_admin_input: str
  • Type: str
attr_username_inputOptional 
attr_username_input: str
  • Type: str
authn_requests_signed_inputOptional 
authn_requests_signed_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
certificate_inputOptional 
certificate_input: str
  • Type: str
debug_inputOptional 
debug_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
idp_cert_inputOptional 
idp_cert_input: str
  • Type: str
private_key_inputOptional 
private_key_input: str
  • Type: str
signature_digest_method_inputOptional 
signature_digest_method_input: str
  • Type: str
signature_signing_method_inputOptional 
signature_signing_method_input: str
  • Type: str
site_admin_role_inputOptional 
site_admin_role_input: str
  • Type: str
slo_endpoint_url_inputOptional 
slo_endpoint_url_input: str
  • Type: str
sso_api_token_session_timeout_inputOptional 
sso_api_token_session_timeout_input: typing.Union[int, float]
  • Type: typing.Union[int, float]
sso_endpoint_url_inputOptional 
sso_endpoint_url_input: str
  • Type: str
team_management_enabled_inputOptional 
team_management_enabled_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
want_assertions_signed_inputOptional 
want_assertions_signed_input: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
attr_groupsRequired 
attr_groups: str
  • Type: str
attr_site_adminRequired 
attr_site_admin: str
  • Type: str
attr_usernameRequired 
attr_username: str
  • Type: str
authn_requests_signedRequired 
authn_requests_signed: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
certificateRequired 
certificate: str
  • Type: str
debugRequired 
debug: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
idp_certRequired 
idp_cert: str
  • Type: str
private_keyRequired 
private_key: str
  • Type: str
signature_digest_methodRequired 
signature_digest_method: str
  • Type: str
signature_signing_methodRequired 
signature_signing_method: str
  • Type: str
site_admin_roleRequired 
site_admin_role: str
  • Type: str
slo_endpoint_urlRequired 
slo_endpoint_url: str
  • Type: str
sso_api_token_session_timeoutRequired 
sso_api_token_session_timeout: typing.Union[int, float]
  • Type: typing.Union[int, float]
sso_endpoint_urlRequired 
sso_endpoint_url: str
  • Type: str
team_management_enabledRequired 
team_management_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]
want_assertions_signedRequired 
want_assertions_signed: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Constants

Name Type Description
tfResourceType str No description.
tfResourceTypeRequired 
tfResourceType: str
  • Type: str

Structs

SamlSettingsConfig

Initializer 

from cdktf_cdktf_provider_tfe import saml_settings

samlSettings.SamlSettingsConfig(
  connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection] = None,
  count: typing.Union[typing.Union[int, float], TerraformCount] = None,
  depends_on: typing.List[ITerraformDependable] = None,
  for_each: ITerraformIterator = None,
  lifecycle: TerraformResourceLifecycle = None,
  provider: TerraformProvider = None,
  provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]] = None,
  idp_cert: str,
  slo_endpoint_url: str,
  sso_endpoint_url: str,
  attr_groups: str = None,
  attr_site_admin: str = None,
  attr_username: str = None,
  authn_requests_signed: typing.Union[bool, IResolvable] = None,
  certificate: str = None,
  debug: typing.Union[bool, IResolvable] = None,
  private_key: str = None,
  signature_digest_method: str = None,
  signature_signing_method: str = None,
  site_admin_role: str = None,
  sso_api_token_session_timeout: typing.Union[int, float] = None,
  team_management_enabled: typing.Union[bool, IResolvable] = None,
  want_assertions_signed: typing.Union[bool, IResolvable] = None
)

Properties

Name Type Description
connection typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection] No description.
count typing.Union[typing.Union[int, float], cdktf.TerraformCount] No description.
depends_on typing.List[cdktf.ITerraformDependable] No description.
for_each cdktf.ITerraformIterator No description.
lifecycle cdktf.TerraformResourceLifecycle No description.
provider cdktf.TerraformProvider No description.
provisioners typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]] No description.
idp_cert str Identity Provider Certificate specifies the PEM encoded X.509 Certificate as provided by the IdP configuration.
slo_endpoint_url str Single Log Out URL specifies the HTTPS endpoint on your IdP for single logout requests.
sso_endpoint_url str Single Sign On URL specifies the HTTPS endpoint on your IdP for single sign-on requests.
attr_groups str Team Attribute Name specifies the name of the SAML attribute that determines team membership.
attr_site_admin str Specifies the role for site admin access. Overrides the "Site Admin Role" method.
attr_username str Username Attribute Name specifies the name of the SAML attribute that determines the user's username.
authn_requests_signed typing.Union[bool, cdktf.IResolvable] Ensure that samlp:AuthnRequest messages are signed.
certificate str The certificate used for request and assertion signing.
debug typing.Union[bool, cdktf.IResolvable] When sign-on fails and this is enabled, the SAMLResponse XML will be displayed on the login page.
private_key str The private key used for request and assertion signing.
signature_digest_method str Signature Digest Method. Must be either SHA1 or SHA256. Defaults to SHA256.
signature_signing_method str Signature Signing Method. Must be either SHA1 or SHA256. Defaults to SHA256.
site_admin_role str Specifies the role for site admin access, provided in the list of roles sent in the Team Attribute Name attribute.
sso_api_token_session_timeout typing.Union[int, float] Specifies the Single Sign On session timeout in seconds. Defaults to 14 days.
team_management_enabled typing.Union[bool, cdktf.IResolvable] Set it to false if you would rather use Terraform Enterprise to manage team membership.
want_assertions_signed typing.Union[bool, cdktf.IResolvable] Ensure that saml:Assertion elements are signed.
connectionOptional 
connection: typing.Union[SSHProvisionerConnection, WinrmProvisionerConnection]
  • Type: typing.Union[cdktf.SSHProvisionerConnection, cdktf.WinrmProvisionerConnection]
countOptional 
count: typing.Union[typing.Union[int, float], TerraformCount]
  • Type: typing.Union[typing.Union[int, float], cdktf.TerraformCount]
depends_onOptional 
depends_on: typing.List[ITerraformDependable]
  • Type: typing.List[cdktf.ITerraformDependable]
for_eachOptional 
for_each: ITerraformIterator
  • Type: cdktf.ITerraformIterator
lifecycleOptional 
lifecycle: TerraformResourceLifecycle
  • Type: cdktf.TerraformResourceLifecycle
providerOptional 
provider: TerraformProvider
  • Type: cdktf.TerraformProvider
provisionersOptional 
provisioners: typing.List[typing.Union[FileProvisioner, LocalExecProvisioner, RemoteExecProvisioner]]
  • Type: typing.List[typing.Union[cdktf.FileProvisioner, cdktf.LocalExecProvisioner, cdktf.RemoteExecProvisioner]]
idp_certRequired 
idp_cert: str
  • Type: str

Identity Provider Certificate specifies the PEM encoded X.509 Certificate as provided by the IdP configuration.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#idp_cert SamlSettings#idp_cert}

slo_endpoint_urlRequired 
slo_endpoint_url: str
  • Type: str

Single Log Out URL specifies the HTTPS endpoint on your IdP for single logout requests.

This value is provided by the IdP configuration

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#slo_endpoint_url SamlSettings#slo_endpoint_url}

sso_endpoint_urlRequired 
sso_endpoint_url: str
  • Type: str

Single Sign On URL specifies the HTTPS endpoint on your IdP for single sign-on requests.

This value is provided by the IdP configuration

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#sso_endpoint_url SamlSettings#sso_endpoint_url}

attr_groupsOptional 
attr_groups: str
  • Type: str

Team Attribute Name specifies the name of the SAML attribute that determines team membership.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#attr_groups SamlSettings#attr_groups}

attr_site_adminOptional 
attr_site_admin: str
  • Type: str

Specifies the role for site admin access. Overrides the "Site Admin Role" method.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#attr_site_admin SamlSettings#attr_site_admin}

attr_usernameOptional 
attr_username: str
  • Type: str

Username Attribute Name specifies the name of the SAML attribute that determines the user's username.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#attr_username SamlSettings#attr_username}

authn_requests_signedOptional 
authn_requests_signed: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Ensure that samlp:AuthnRequest messages are signed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#authn_requests_signed SamlSettings#authn_requests_signed}

certificateOptional 
certificate: str
  • Type: str

The certificate used for request and assertion signing.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#certificate SamlSettings#certificate}

debugOptional 
debug: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

When sign-on fails and this is enabled, the SAMLResponse XML will be displayed on the login page.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#debug SamlSettings#debug}

private_keyOptional 
private_key: str
  • Type: str

The private key used for request and assertion signing.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#private_key SamlSettings#private_key}

signature_digest_methodOptional 
signature_digest_method: str
  • Type: str

Signature Digest Method. Must be either SHA1 or SHA256. Defaults to SHA256.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#signature_digest_method SamlSettings#signature_digest_method}

signature_signing_methodOptional 
signature_signing_method: str
  • Type: str

Signature Signing Method. Must be either SHA1 or SHA256. Defaults to SHA256.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#signature_signing_method SamlSettings#signature_signing_method}

site_admin_roleOptional 
site_admin_role: str
  • Type: str

Specifies the role for site admin access, provided in the list of roles sent in the Team Attribute Name attribute.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#site_admin_role SamlSettings#site_admin_role}

sso_api_token_session_timeoutOptional 
sso_api_token_session_timeout: typing.Union[int, float]
  • Type: typing.Union[int, float]

Specifies the Single Sign On session timeout in seconds. Defaults to 14 days.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#sso_api_token_session_timeout SamlSettings#sso_api_token_session_timeout}

team_management_enabledOptional 
team_management_enabled: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Set it to false if you would rather use Terraform Enterprise to manage team membership.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#team_management_enabled SamlSettings#team_management_enabled}

want_assertions_signedOptional 
want_assertions_signed: typing.Union[bool, IResolvable]
  • Type: typing.Union[bool, cdktf.IResolvable]

Ensure that saml:Assertion elements are signed.

Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.63.0/docs/resources/saml_settings#want_assertions_signed SamlSettings#want_assertions_signed}