InboundSamlConfig

Inbound SAML configuration for a Identity Toolkit project.

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

Create a InboundSamlConfig Resource

new InboundSamlConfig(name: string, args: InboundSamlConfigArgs, opts?: CustomResourceOptions);

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

func NewInboundSamlConfig(ctx *Context, name string, args InboundSamlConfigArgs, opts ...ResourceOption) (*InboundSamlConfig, error)

public InboundSamlConfig(string name, InboundSamlConfigArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args InboundSamlConfigArgs: 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 InboundSamlConfigArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

InboundSamlConfig Resource Properties

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

Inputs

The InboundSamlConfig resource accepts the following input properties:

DisplayName string: Human friendly display name.
IdpConfig InboundSamlConfigIdpConfigArgs: SAML IdP configuration when the project acts as the relying party Structure is documented below.
SpConfig InboundSamlConfigSpConfigArgs: 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.
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 InboundSamlConfigIdpConfig: SAML IdP configuration when the project acts as the relying party Structure is documented below.
SpConfig InboundSamlConfigSpConfig: 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.
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 InboundSamlConfigIdpConfig: SAML IdP configuration when the project acts as the relying party Structure is documented below.
spConfig InboundSamlConfigSpConfig: 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.
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[InboundSamlConfigIdpConfig]: SAML IdP configuration when the project acts as the relying party Structure is documented below.
sp_config Dict[InboundSamlConfigSpConfig]: 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.
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 InboundSamlConfig 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 InboundSamlConfig Resource

Get an existing InboundSamlConfig 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?: InboundSamlConfigState, opts?: CustomResourceOptions): InboundSamlConfig

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

func GetInboundSamlConfig(ctx *Context, name string, id IDInput, state *InboundSamlConfigState, opts ...ResourceOption) (*InboundSamlConfig, error)

public static InboundSamlConfig Get(string name, Input<string> id, InboundSamlConfigState? 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 InboundSamlConfigIdpConfigArgs: 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 InboundSamlConfigSpConfigArgs: 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.

DisplayName string: Human friendly display name.
Enabled bool: If this config allows users to sign in with the provider.
IdpConfig InboundSamlConfigIdpConfig: 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 InboundSamlConfigSpConfig: 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.

displayName string: Human friendly display name.
enabled boolean: If this config allows users to sign in with the provider.
idpConfig InboundSamlConfigIdpConfig: 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 InboundSamlConfigSpConfig: 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.

display_name str: Human friendly display name.
enabled bool: If this config allows users to sign in with the provider.
idp_config Dict[InboundSamlConfigIdpConfig]: 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[InboundSamlConfigSpConfig]: 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.

Supporting Types

InboundSamlConfigIdpConfig

See the input and output API doc for this type.

IdpCertificates List<InboundSamlConfigIdpConfigIdpCertificateArgs>: 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 []InboundSamlConfigIdpConfigIdpCertificate: 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 InboundSamlConfigIdpConfigIdpCertificate[]: 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[InboundSamlConfigIdpConfigIdpCertificate]: 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.

InboundSamlConfigIdpConfigIdpCertificate

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

InboundSamlConfigSpConfig

See the input and output API doc for this type.

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

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

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

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

InboundSamlConfigSpConfigSpCertificate

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

InboundSamlConfig

Create a InboundSamlConfig Resource

InboundSamlConfig Resource Properties

Inputs

Outputs

Look up an Existing InboundSamlConfig Resource

Supporting Types

InboundSamlConfigIdpConfig

InboundSamlConfigIdpConfigIdpCertificate

InboundSamlConfigSpConfig

InboundSamlConfigSpConfigSpCertificate

Package Details

On This Page