TenantInboundSamlConfig

Inbound SAML configuration for a Identity Toolkit tenant.

You must enable the Google Identity Platform in the marketplace prior to using this resource.

Create a TenantInboundSamlConfig Resource

new TenantInboundSamlConfig(name: string, args: TenantInboundSamlConfigArgs, opts?: CustomResourceOptions);

def TenantInboundSamlConfig(resource_name, opts=None, display_name=None, enabled=None, idp_config=None, name=None, project=None, sp_config=None, tenant=None, __props__=None);

func NewTenantInboundSamlConfig(ctx *Context, name string, args TenantInboundSamlConfigArgs, opts ...ResourceOption) (*TenantInboundSamlConfig, error)

public TenantInboundSamlConfig(string name, TenantInboundSamlConfigArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args TenantInboundSamlConfigArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args TenantInboundSamlConfigArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args TenantInboundSamlConfigArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

TenantInboundSamlConfig Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The TenantInboundSamlConfig resource accepts the following input properties:

DisplayName string: Human friendly display name.
IdpConfig TenantInboundSamlConfigIdpConfigArgs: SAML IdP configuration when the project acts as the relying party Structure is documented below.
SpConfig TenantInboundSamlConfigSpConfigArgs: SAML SP (Service Provider) configuration when the project acts as the relying party to receive and accept an authentication assertion issued by a SAML identity provider. Structure is documented below.
Tenant string: The name of the tenant where this inbound SAML config resource exists
Enabled bool: If this config allows users to sign in with the provider.
Name string: The name of the InboundSamlConfig resource. Must start with ‘saml.’ and can only have alphanumeric characters, hyphens, underscores or periods. The part after ‘saml.’ must also start with a lowercase letter, end with an alphanumeric character, and have at least 2 characters.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

DisplayName string: Human friendly display name.
IdpConfig TenantInboundSamlConfigIdpConfig: SAML IdP configuration when the project acts as the relying party Structure is documented below.
SpConfig TenantInboundSamlConfigSpConfig: SAML SP (Service Provider) configuration when the project acts as the relying party to receive and accept an authentication assertion issued by a SAML identity provider. Structure is documented below.
Tenant string: The name of the tenant where this inbound SAML config resource exists
Enabled bool: If this config allows users to sign in with the provider.
Name string: The name of the InboundSamlConfig resource. Must start with ‘saml.’ and can only have alphanumeric characters, hyphens, underscores or periods. The part after ‘saml.’ must also start with a lowercase letter, end with an alphanumeric character, and have at least 2 characters.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

displayName string: Human friendly display name.
idpConfig TenantInboundSamlConfigIdpConfig: SAML IdP configuration when the project acts as the relying party Structure is documented below.
spConfig TenantInboundSamlConfigSpConfig: SAML SP (Service Provider) configuration when the project acts as the relying party to receive and accept an authentication assertion issued by a SAML identity provider. Structure is documented below.
tenant string: The name of the tenant where this inbound SAML config resource exists
enabled boolean: If this config allows users to sign in with the provider.
name string: The name of the InboundSamlConfig resource. Must start with ‘saml.’ and can only have alphanumeric characters, hyphens, underscores or periods. The part after ‘saml.’ must also start with a lowercase letter, end with an alphanumeric character, and have at least 2 characters.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

display_name str: Human friendly display name.
idp_config Dict[TenantInboundSamlConfigIdpConfig]: SAML IdP configuration when the project acts as the relying party Structure is documented below.
sp_config Dict[TenantInboundSamlConfigSpConfig]: SAML SP (Service Provider) configuration when the project acts as the relying party to receive and accept an authentication assertion issued by a SAML identity provider. Structure is documented below.
tenant str: The name of the tenant where this inbound SAML config resource exists
enabled bool: If this config allows users to sign in with the provider.
name str: The name of the InboundSamlConfig resource. Must start with ‘saml.’ and can only have alphanumeric characters, hyphens, underscores or periods. The part after ‘saml.’ must also start with a lowercase letter, end with an alphanumeric character, and have at least 2 characters.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

Outputs

All input properties are implicitly available as output properties. Additionally, the TenantInboundSamlConfig resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing TenantInboundSamlConfig Resource

Get an existing TenantInboundSamlConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: TenantInboundSamlConfigState, opts?: CustomResourceOptions): TenantInboundSamlConfig

static get(resource_name, id, opts=None, display_name=None, enabled=None, idp_config=None, name=None, project=None, sp_config=None, tenant=None, __props__=None);

func GetTenantInboundSamlConfig(ctx *Context, name string, id IDInput, state *TenantInboundSamlConfigState, opts ...ResourceOption) (*TenantInboundSamlConfig, error)

public static TenantInboundSamlConfig Get(string name, Input<string> id, TenantInboundSamlConfigState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

DisplayName string: Human friendly display name.
Enabled bool: If this config allows users to sign in with the provider.
IdpConfig TenantInboundSamlConfigIdpConfigArgs: SAML IdP configuration when the project acts as the relying party Structure is documented below.
Name string: The name of the InboundSamlConfig resource. Must start with ‘saml.’ and can only have alphanumeric characters, hyphens, underscores or periods. The part after ‘saml.’ must also start with a lowercase letter, end with an alphanumeric character, and have at least 2 characters.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SpConfig TenantInboundSamlConfigSpConfigArgs: SAML SP (Service Provider) configuration when the project acts as the relying party to receive and accept an authentication assertion issued by a SAML identity provider. Structure is documented below.
Tenant string: The name of the tenant where this inbound SAML config resource exists

DisplayName string: Human friendly display name.
Enabled bool: If this config allows users to sign in with the provider.
IdpConfig TenantInboundSamlConfigIdpConfig: SAML IdP configuration when the project acts as the relying party Structure is documented below.
Name string: The name of the InboundSamlConfig resource. Must start with ‘saml.’ and can only have alphanumeric characters, hyphens, underscores or periods. The part after ‘saml.’ must also start with a lowercase letter, end with an alphanumeric character, and have at least 2 characters.
Project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
SpConfig TenantInboundSamlConfigSpConfig: SAML SP (Service Provider) configuration when the project acts as the relying party to receive and accept an authentication assertion issued by a SAML identity provider. Structure is documented below.
Tenant string: The name of the tenant where this inbound SAML config resource exists

displayName string: Human friendly display name.
enabled boolean: If this config allows users to sign in with the provider.
idpConfig TenantInboundSamlConfigIdpConfig: SAML IdP configuration when the project acts as the relying party Structure is documented below.
name string: The name of the InboundSamlConfig resource. Must start with ‘saml.’ and can only have alphanumeric characters, hyphens, underscores or periods. The part after ‘saml.’ must also start with a lowercase letter, end with an alphanumeric character, and have at least 2 characters.
project string: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
spConfig TenantInboundSamlConfigSpConfig: SAML SP (Service Provider) configuration when the project acts as the relying party to receive and accept an authentication assertion issued by a SAML identity provider. Structure is documented below.
tenant string: The name of the tenant where this inbound SAML config resource exists

display_name str: Human friendly display name.
enabled bool: If this config allows users to sign in with the provider.
idp_config Dict[TenantInboundSamlConfigIdpConfig]: SAML IdP configuration when the project acts as the relying party Structure is documented below.
name str: The name of the InboundSamlConfig resource. Must start with ‘saml.’ and can only have alphanumeric characters, hyphens, underscores or periods. The part after ‘saml.’ must also start with a lowercase letter, end with an alphanumeric character, and have at least 2 characters.
project str: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
sp_config Dict[TenantInboundSamlConfigSpConfig]: SAML SP (Service Provider) configuration when the project acts as the relying party to receive and accept an authentication assertion issued by a SAML identity provider. Structure is documented below.
tenant str: The name of the tenant where this inbound SAML config resource exists

Supporting Types

TenantInboundSamlConfigIdpConfig

See the input and output API doc for this type.

IdpCertificates List<TenantInboundSamlConfigIdpConfigIdpCertificateArgs>: The IDP’s certificate data to verify the signature in the SAMLResponse issued by the IDP. Structure is documented below.
IdpEntityId string: Unique identifier for all SAML entities
SsoUrl string: URL to send Authentication request to.
SignRequest bool: Indicates if outbounding SAMLRequest should be signed.

IdpCertificates []TenantInboundSamlConfigIdpConfigIdpCertificate: The IDP’s certificate data to verify the signature in the SAMLResponse issued by the IDP. Structure is documented below.
IdpEntityId string: Unique identifier for all SAML entities
SsoUrl string: URL to send Authentication request to.
SignRequest bool: Indicates if outbounding SAMLRequest should be signed.

idpCertificates TenantInboundSamlConfigIdpConfigIdpCertificate[]: The IDP’s certificate data to verify the signature in the SAMLResponse issued by the IDP. Structure is documented below.
idpEntityId string: Unique identifier for all SAML entities
ssoUrl string: URL to send Authentication request to.
signRequest boolean: Indicates if outbounding SAMLRequest should be signed.

idpCertificates List[TenantInboundSamlConfigIdpConfigIdpCertificate]: The IDP’s certificate data to verify the signature in the SAMLResponse issued by the IDP. Structure is documented below.
idpEntityId str: Unique identifier for all SAML entities
ssoUrl str: URL to send Authentication request to.
signRequest bool: Indicates if outbounding SAMLRequest should be signed.

TenantInboundSamlConfigIdpConfigIdpCertificate

See the input and output API doc for this type.

X509Certificate string: - The x509 certificate

X509Certificate string: - The x509 certificate

x509Certificate string: - The x509 certificate

x509Certificate str: - The x509 certificate

TenantInboundSamlConfigSpConfig

See the input and output API doc for this type.

CallbackUri string: Callback URI where responses from IDP are handled. Must start with https://.
SpEntityId string: Unique identifier for all SAML entities.
SpCertificates List<TenantInboundSamlConfigSpConfigSpCertificateArgs>: - The IDP’s certificate data to verify the signature in the SAMLResponse issued by the IDP. Structure is documented below.

CallbackUri string: Callback URI where responses from IDP are handled. Must start with https://.
SpEntityId string: Unique identifier for all SAML entities.
SpCertificates []TenantInboundSamlConfigSpConfigSpCertificate: - The IDP’s certificate data to verify the signature in the SAMLResponse issued by the IDP. Structure is documented below.

callbackUri string: Callback URI where responses from IDP are handled. Must start with https://.
spEntityId string: Unique identifier for all SAML entities.
spCertificates TenantInboundSamlConfigSpConfigSpCertificate[]: - The IDP’s certificate data to verify the signature in the SAMLResponse issued by the IDP. Structure is documented below.

callbackUri str: Callback URI where responses from IDP are handled. Must start with https://.
spEntityId str: Unique identifier for all SAML entities.
spCertificates List[TenantInboundSamlConfigSpConfigSpCertificate]: - The IDP’s certificate data to verify the signature in the SAMLResponse issued by the IDP. Structure is documented below.

TenantInboundSamlConfigSpConfigSpCertificate

See the input and output API doc for this type.

X509Certificate string: - The x509 certificate

X509Certificate string: - The x509 certificate

x509Certificate string: - The x509 certificate

x509Certificate str: - The x509 certificate

Package Details

Repository: https://github.com/pulumi/pulumi-gcp
License: Apache-2.0
Notes: This Pulumi package is based on the google-beta Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

TenantInboundSamlConfig

Create a TenantInboundSamlConfig Resource

TenantInboundSamlConfig Resource Properties

Inputs

Outputs

Look up an Existing TenantInboundSamlConfig Resource

Supporting Types

TenantInboundSamlConfigIdpConfig

TenantInboundSamlConfigIdpConfigIdpCertificate

TenantInboundSamlConfigSpConfig

TenantInboundSamlConfigSpConfigSpCertificate

Package Details

On This Page