Represents a {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/saml_settings tfe_saml_settings}.
using HashiCorp.Cdktf.Providers.Tfe;
new SamlSettings(Construct Scope, string Id, SamlSettingsConfig Config);
Name | Type | Description |
---|---|---|
Scope |
Constructs.Construct |
The scope in which to define this construct. |
Id |
string |
The scoped construct ID. |
Config |
SamlSettingsConfig |
No description. |
- Type: Constructs.Construct
The scope in which to define this construct.
- Type: string
The scoped construct ID.
Must be unique amongst siblings in the same scope
- Type: SamlSettingsConfig
Name | Description |
---|---|
ToString |
Returns a string representation of this construct. |
AddOverride |
No description. |
OverrideLogicalId |
Overrides the auto-generated logical ID with a specific ID. |
ResetOverrideLogicalId |
Resets a previously passed logical Id to use the auto-generated logical id again. |
ToHclTerraform |
No description. |
ToMetadata |
No description. |
ToTerraform |
Adds this resource to the terraform JSON output. |
AddMoveTarget |
Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move. |
GetAnyMapAttribute |
No description. |
GetBooleanAttribute |
No description. |
GetBooleanMapAttribute |
No description. |
GetListAttribute |
No description. |
GetNumberAttribute |
No description. |
GetNumberListAttribute |
No description. |
GetNumberMapAttribute |
No description. |
GetStringAttribute |
No description. |
GetStringMapAttribute |
No description. |
HasResourceMove |
No description. |
ImportFrom |
No description. |
InterpolationForAttribute |
No description. |
MoveFromId |
Move the resource corresponding to "id" to this resource. |
MoveTo |
Moves this resource to the target resource given by moveTarget. |
MoveToId |
Moves this resource to the resource corresponding to "id". |
ResetAttrGroups |
No description. |
ResetAttrSiteAdmin |
No description. |
ResetAttrUsername |
No description. |
ResetAuthnRequestsSigned |
No description. |
ResetCertificate |
No description. |
ResetDebug |
No description. |
ResetPrivateKey |
No description. |
ResetSignatureDigestMethod |
No description. |
ResetSignatureSigningMethod |
No description. |
ResetSiteAdminRole |
No description. |
ResetSsoApiTokenSessionTimeout |
No description. |
ResetTeamManagementEnabled |
No description. |
ResetWantAssertionsSigned |
No description. |
private string ToString()
Returns a string representation of this construct.
private void AddOverride(string Path, object Value)
- Type: string
- Type: object
private void OverrideLogicalId(string NewLogicalId)
Overrides the auto-generated logical ID with a specific ID.
- Type: string
The new logical ID to use for this stack element.
private void ResetOverrideLogicalId()
Resets a previously passed logical Id to use the auto-generated logical id again.
private object ToHclTerraform()
private object ToMetadata()
private object ToTerraform()
Adds this resource to the terraform JSON output.
private void AddMoveTarget(string MoveTarget)
Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
- Type: string
The string move target that will correspond to this resource.
private System.Collections.Generic.IDictionary<string, object> GetAnyMapAttribute(string TerraformAttribute)
- Type: string
private IResolvable GetBooleanAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, bool> GetBooleanMapAttribute(string TerraformAttribute)
- Type: string
private string[] GetListAttribute(string TerraformAttribute)
- Type: string
private double GetNumberAttribute(string TerraformAttribute)
- Type: string
private double[] GetNumberListAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, double> GetNumberMapAttribute(string TerraformAttribute)
- Type: string
private string GetStringAttribute(string TerraformAttribute)
- Type: string
private System.Collections.Generic.IDictionary<string, string> GetStringMapAttribute(string TerraformAttribute)
- Type: string
private object HasResourceMove()
private void ImportFrom(string Id, TerraformProvider Provider = null)
- Type: string
- Type: HashiCorp.Cdktf.TerraformProvider
private IResolvable InterpolationForAttribute(string TerraformAttribute)
- Type: string
private void MoveFromId(string Id)
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.
- Type: string
Full id of resource being moved from, e.g. "aws_s3_bucket.example".
private void MoveTo(string MoveTarget, object Index = null)
Moves this resource to the target resource given by moveTarget.
- Type: string
The previously set user defined string set by .addMoveTarget() corresponding to the resource to move to.
- Type: object
Optional The index corresponding to the key the resource is to appear in the foreach of a resource to move to.
private void MoveToId(string Id)
Moves this resource to the resource corresponding to "id".
- Type: string
Full id of resource to move to, e.g. "aws_s3_bucket.example".
private void ResetAttrGroups()
private void ResetAttrSiteAdmin()
private void ResetAttrUsername()
private void ResetAuthnRequestsSigned()
private void ResetCertificate()
private void ResetDebug()
private void ResetPrivateKey()
private void ResetSignatureDigestMethod()
private void ResetSignatureSigningMethod()
private void ResetSiteAdminRole()
private void ResetSsoApiTokenSessionTimeout()
private void ResetTeamManagementEnabled()
private void ResetWantAssertionsSigned()
Name | Description |
---|---|
IsConstruct |
Checks if x is a construct. |
IsTerraformElement |
No description. |
IsTerraformResource |
No description. |
GenerateConfigForImport |
Generates CDKTF code for importing a SamlSettings resource upon running "cdktf plan ". |
using HashiCorp.Cdktf.Providers.Tfe;
SamlSettings.IsConstruct(object X);
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.
- Type: object
Any object.
using HashiCorp.Cdktf.Providers.Tfe;
SamlSettings.IsTerraformElement(object X);
- Type: object
using HashiCorp.Cdktf.Providers.Tfe;
SamlSettings.IsTerraformResource(object X);
- Type: object
using HashiCorp.Cdktf.Providers.Tfe;
SamlSettings.GenerateConfigForImport(Construct Scope, string ImportToId, string ImportFromId, TerraformProvider Provider = null);
Generates CDKTF code for importing a SamlSettings resource upon running "cdktf plan ".
- Type: Constructs.Construct
The scope in which to define this construct.
- Type: string
The construct id used in the generated config for the SamlSettings to import.
- Type: string
The id of the existing SamlSettings that should be imported.
Refer to the {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/saml_settings#import import section} in the documentation of this resource for the id to use
- Type: HashiCorp.Cdktf.TerraformProvider
? Optional instance of the provider where the SamlSettings to import is found.
Name | Type | Description |
---|---|---|
Node |
Constructs.Node |
The tree node. |
CdktfStack |
HashiCorp.Cdktf.TerraformStack |
No description. |
Fqn |
string |
No description. |
FriendlyUniqueId |
string |
No description. |
TerraformMetaArguments |
System.Collections.Generic.IDictionary<string, object> |
No description. |
TerraformResourceType |
string |
No description. |
TerraformGeneratorMetadata |
HashiCorp.Cdktf.TerraformProviderGeneratorMetadata |
No description. |
Connection |
object |
No description. |
Count |
object |
No description. |
DependsOn |
string[] |
No description. |
ForEach |
HashiCorp.Cdktf.ITerraformIterator |
No description. |
Lifecycle |
HashiCorp.Cdktf.TerraformResourceLifecycle |
No description. |
Provider |
HashiCorp.Cdktf.TerraformProvider |
No description. |
Provisioners |
object[] |
No description. |
AcsConsumerUrl |
string |
No description. |
Enabled |
HashiCorp.Cdktf.IResolvable |
No description. |
Id |
string |
No description. |
MetadataUrl |
string |
No description. |
OldIdpCert |
string |
No description. |
AttrGroupsInput |
string |
No description. |
AttrSiteAdminInput |
string |
No description. |
AttrUsernameInput |
string |
No description. |
AuthnRequestsSignedInput |
object |
No description. |
CertificateInput |
string |
No description. |
DebugInput |
object |
No description. |
IdpCertInput |
string |
No description. |
PrivateKeyInput |
string |
No description. |
SignatureDigestMethodInput |
string |
No description. |
SignatureSigningMethodInput |
string |
No description. |
SiteAdminRoleInput |
string |
No description. |
SloEndpointUrlInput |
string |
No description. |
SsoApiTokenSessionTimeoutInput |
double |
No description. |
SsoEndpointUrlInput |
string |
No description. |
TeamManagementEnabledInput |
object |
No description. |
WantAssertionsSignedInput |
object |
No description. |
AttrGroups |
string |
No description. |
AttrSiteAdmin |
string |
No description. |
AttrUsername |
string |
No description. |
AuthnRequestsSigned |
object |
No description. |
Certificate |
string |
No description. |
Debug |
object |
No description. |
IdpCert |
string |
No description. |
PrivateKey |
string |
No description. |
SignatureDigestMethod |
string |
No description. |
SignatureSigningMethod |
string |
No description. |
SiteAdminRole |
string |
No description. |
SloEndpointUrl |
string |
No description. |
SsoApiTokenSessionTimeout |
double |
No description. |
SsoEndpointUrl |
string |
No description. |
TeamManagementEnabled |
object |
No description. |
WantAssertionsSigned |
object |
No description. |
public Node Node { get; }
- Type: Constructs.Node
The tree node.
public TerraformStack CdktfStack { get; }
- Type: HashiCorp.Cdktf.TerraformStack
public string Fqn { get; }
- Type: string
public string FriendlyUniqueId { get; }
- Type: string
public System.Collections.Generic.IDictionary<string, object> TerraformMetaArguments { get; }
- Type: System.Collections.Generic.IDictionary<string, object>
public string TerraformResourceType { get; }
- Type: string
public TerraformProviderGeneratorMetadata TerraformGeneratorMetadata { get; }
- Type: HashiCorp.Cdktf.TerraformProviderGeneratorMetadata
public object Connection { get; }
- Type: object
public object Count { get; }
- Type: object
public string[] DependsOn { get; }
- Type: string[]
public ITerraformIterator ForEach { get; }
- Type: HashiCorp.Cdktf.ITerraformIterator
public TerraformResourceLifecycle Lifecycle { get; }
- Type: HashiCorp.Cdktf.TerraformResourceLifecycle
public TerraformProvider Provider { get; }
- Type: HashiCorp.Cdktf.TerraformProvider
public object[] Provisioners { get; }
- Type: object[]
public string AcsConsumerUrl { get; }
- Type: string
public IResolvable Enabled { get; }
- Type: HashiCorp.Cdktf.IResolvable
public string Id { get; }
- Type: string
public string MetadataUrl { get; }
- Type: string
public string OldIdpCert { get; }
- Type: string
public string AttrGroupsInput { get; }
- Type: string
public string AttrSiteAdminInput { get; }
- Type: string
public string AttrUsernameInput { get; }
- Type: string
public object AuthnRequestsSignedInput { get; }
- Type: object
public string CertificateInput { get; }
- Type: string
public object DebugInput { get; }
- Type: object
public string IdpCertInput { get; }
- Type: string
public string PrivateKeyInput { get; }
- Type: string
public string SignatureDigestMethodInput { get; }
- Type: string
public string SignatureSigningMethodInput { get; }
- Type: string
public string SiteAdminRoleInput { get; }
- Type: string
public string SloEndpointUrlInput { get; }
- Type: string
public double SsoApiTokenSessionTimeoutInput { get; }
- Type: double
public string SsoEndpointUrlInput { get; }
- Type: string
public object TeamManagementEnabledInput { get; }
- Type: object
public object WantAssertionsSignedInput { get; }
- Type: object
public string AttrGroups { get; }
- Type: string
public string AttrSiteAdmin { get; }
- Type: string
public string AttrUsername { get; }
- Type: string
public object AuthnRequestsSigned { get; }
- Type: object
public string Certificate { get; }
- Type: string
public object Debug { get; }
- Type: object
public string IdpCert { get; }
- Type: string
public string PrivateKey { get; }
- Type: string
public string SignatureDigestMethod { get; }
- Type: string
public string SignatureSigningMethod { get; }
- Type: string
public string SiteAdminRole { get; }
- Type: string
public string SloEndpointUrl { get; }
- Type: string
public double SsoApiTokenSessionTimeout { get; }
- Type: double
public string SsoEndpointUrl { get; }
- Type: string
public object TeamManagementEnabled { get; }
- Type: object
public object WantAssertionsSigned { get; }
- Type: object
Name | Type | Description |
---|---|---|
TfResourceType |
string |
No description. |
public string TfResourceType { get; }
- Type: string
using HashiCorp.Cdktf.Providers.Tfe;
new SamlSettingsConfig {
object Connection = null,
object Count = null,
ITerraformDependable[] DependsOn = null,
ITerraformIterator ForEach = null,
TerraformResourceLifecycle Lifecycle = null,
TerraformProvider Provider = null,
object[] Provisioners = null,
string IdpCert,
string SloEndpointUrl,
string SsoEndpointUrl,
string AttrGroups = null,
string AttrSiteAdmin = null,
string AttrUsername = null,
object AuthnRequestsSigned = null,
string Certificate = null,
object Debug = null,
string PrivateKey = null,
string SignatureDigestMethod = null,
string SignatureSigningMethod = null,
string SiteAdminRole = null,
double SsoApiTokenSessionTimeout = null,
object TeamManagementEnabled = null,
object WantAssertionsSigned = null
};
Name | Type | Description |
---|---|---|
Connection |
object |
No description. |
Count |
object |
No description. |
DependsOn |
HashiCorp.Cdktf.ITerraformDependable[] |
No description. |
ForEach |
HashiCorp.Cdktf.ITerraformIterator |
No description. |
Lifecycle |
HashiCorp.Cdktf.TerraformResourceLifecycle |
No description. |
Provider |
HashiCorp.Cdktf.TerraformProvider |
No description. |
Provisioners |
object[] |
No description. |
IdpCert |
string |
Identity Provider Certificate specifies the PEM encoded X.509 Certificate as provided by the IdP configuration. |
SloEndpointUrl |
string |
Single Log Out URL specifies the HTTPS endpoint on your IdP for single logout requests. |
SsoEndpointUrl |
string |
Single Sign On URL specifies the HTTPS endpoint on your IdP for single sign-on requests. |
AttrGroups |
string |
Team Attribute Name specifies the name of the SAML attribute that determines team membership. |
AttrSiteAdmin |
string |
Specifies the role for site admin access. Overrides the "Site Admin Role" method. |
AttrUsername |
string |
Username Attribute Name specifies the name of the SAML attribute that determines the user's username. |
AuthnRequestsSigned |
object |
Ensure that samlp:AuthnRequest messages are signed. |
Certificate |
string |
The certificate used for request and assertion signing. |
Debug |
object |
When sign-on fails and this is enabled, the SAMLResponse XML will be displayed on the login page. |
PrivateKey |
string |
The private key used for request and assertion signing. |
SignatureDigestMethod |
string |
Signature Digest Method. Must be either SHA1 or SHA256 . Defaults to SHA256 . |
SignatureSigningMethod |
string |
Signature Signing Method. Must be either SHA1 or SHA256 . Defaults to SHA256 . |
SiteAdminRole |
string |
Specifies the role for site admin access, provided in the list of roles sent in the Team Attribute Name attribute. |
SsoApiTokenSessionTimeout |
double |
Specifies the Single Sign On session timeout in seconds. Defaults to 14 days. |
TeamManagementEnabled |
object |
Set it to false if you would rather use Terraform Enterprise to manage team membership. |
WantAssertionsSigned |
object |
Ensure that saml:Assertion elements are signed. |
public object Connection { get; set; }
- Type: object
public object Count { get; set; }
- Type: object
public ITerraformDependable[] DependsOn { get; set; }
- Type: HashiCorp.Cdktf.ITerraformDependable[]
public ITerraformIterator ForEach { get; set; }
- Type: HashiCorp.Cdktf.ITerraformIterator
public TerraformResourceLifecycle Lifecycle { get; set; }
- Type: HashiCorp.Cdktf.TerraformResourceLifecycle
public TerraformProvider Provider { get; set; }
- Type: HashiCorp.Cdktf.TerraformProvider
public object[] Provisioners { get; set; }
- Type: object[]
public string IdpCert { get; set; }
- Type: string
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.55.0/docs/resources/saml_settings#idp_cert SamlSettings#idp_cert}
public string SloEndpointUrl { get; set; }
- Type: string
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.55.0/docs/resources/saml_settings#slo_endpoint_url SamlSettings#slo_endpoint_url}
public string SsoEndpointUrl { get; set; }
- Type: string
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.55.0/docs/resources/saml_settings#sso_endpoint_url SamlSettings#sso_endpoint_url}
public string AttrGroups { get; set; }
- Type: string
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.55.0/docs/resources/saml_settings#attr_groups SamlSettings#attr_groups}
public string AttrSiteAdmin { get; set; }
- Type: string
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.55.0/docs/resources/saml_settings#attr_site_admin SamlSettings#attr_site_admin}
public string AttrUsername { get; set; }
- Type: string
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.55.0/docs/resources/saml_settings#attr_username SamlSettings#attr_username}
public object AuthnRequestsSigned { get; set; }
- Type: object
Ensure that samlp:AuthnRequest messages are signed.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/saml_settings#authn_requests_signed SamlSettings#authn_requests_signed}
public string Certificate { get; set; }
- Type: string
The certificate used for request and assertion signing.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/saml_settings#certificate SamlSettings#certificate}
public object Debug { get; set; }
- Type: object
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.55.0/docs/resources/saml_settings#debug SamlSettings#debug}
public string PrivateKey { get; set; }
- Type: string
The private key used for request and assertion signing.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/saml_settings#private_key SamlSettings#private_key}
public string SignatureDigestMethod { get; set; }
- Type: string
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.55.0/docs/resources/saml_settings#signature_digest_method SamlSettings#signature_digest_method}
public string SignatureSigningMethod { get; set; }
- Type: string
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.55.0/docs/resources/saml_settings#signature_signing_method SamlSettings#signature_signing_method}
public string SiteAdminRole { get; set; }
- Type: string
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.55.0/docs/resources/saml_settings#site_admin_role SamlSettings#site_admin_role}
public double SsoApiTokenSessionTimeout { get; set; }
- Type: double
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.55.0/docs/resources/saml_settings#sso_api_token_session_timeout SamlSettings#sso_api_token_session_timeout}
public object TeamManagementEnabled { get; set; }
- Type: object
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.55.0/docs/resources/saml_settings#team_management_enabled SamlSettings#team_management_enabled}
public object WantAssertionsSigned { get; set; }
- Type: object
Ensure that saml:Assertion elements are signed.
Docs at Terraform Registry: {@link https://registry.terraform.io/providers/hashicorp/tfe/0.55.0/docs/resources/saml_settings#want_assertions_signed SamlSettings#want_assertions_signed}