Docs Packages
  1. Packages
  2. Google Cloud (GCP) Classic
  3. API Docs
  4. identityplatform
  5. TenantInboundSamlConfig
Google Cloud Classic v7.29.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-gcp

gcp.identityplatform.TenantInboundSamlConfig

Explore with Pulumi AI

gcp logo
Google Cloud Classic v7.29.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-gcp

    Inbound SAML configuration for a Identity Toolkit tenant.

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

    Example Usage

    Identity Platform Tenant Inbound Saml Config Basic

    import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
import * as std from "@pulumi/std";

const tenant = new gcp.identityplatform.Tenant("tenant", {displayName: "tenant"});
const tenantSamlConfig = new gcp.identityplatform.TenantInboundSamlConfig("tenant_saml_config", {
    name: "saml.tf-config",
    displayName: "Display Name",
    tenant: tenant.name,
    idpConfig: {
        idpEntityId: "tf-idp",
        signRequest: true,
        ssoUrl: "https://example.com",
        idpCertificates: [{
            x509Certificate: std.file({
                input: "test-fixtures/rsa_cert.pem",
            }).then(invoke => invoke.result),
        }],
    },
    spConfig: {
        spEntityId: "tf-sp",
        callbackUri: "https://example.com",
    },
});

    import pulumi
import pulumi_gcp as gcp
import pulumi_std as std

tenant = gcp.identityplatform.Tenant("tenant", display_name="tenant")
tenant_saml_config = gcp.identityplatform.TenantInboundSamlConfig("tenant_saml_config",
    name="saml.tf-config",
    display_name="Display Name",
    tenant=tenant.name,
    idp_config=gcp.identityplatform.TenantInboundSamlConfigIdpConfigArgs(
        idp_entity_id="tf-idp",
        sign_request=True,
        sso_url="https://example.com",
        idp_certificates=[gcp.identityplatform.TenantInboundSamlConfigIdpConfigIdpCertificateArgs(
            x509_certificate=std.file(input="test-fixtures/rsa_cert.pem").result,
        )],
    ),
    sp_config=gcp.identityplatform.TenantInboundSamlConfigSpConfigArgs(
        sp_entity_id="tf-sp",
        callback_uri="https://example.com",
    ))

    package main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v7/go/gcp/identityplatform"
	"github.com/pulumi/pulumi-std/sdk/go/std"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		tenant, err := identityplatform.NewTenant(ctx, "tenant", &identityplatform.TenantArgs{
			DisplayName: pulumi.String("tenant"),
		})
		if err != nil {
			return err
		}
		invokeFile, err := std.File(ctx, &std.FileArgs{
			Input: "test-fixtures/rsa_cert.pem",
		}, nil)
		if err != nil {
			return err
		}
		_, err = identityplatform.NewTenantInboundSamlConfig(ctx, "tenant_saml_config", &identityplatform.TenantInboundSamlConfigArgs{
			Name:        pulumi.String("saml.tf-config"),
			DisplayName: pulumi.String("Display Name"),
			Tenant:      tenant.Name,
			IdpConfig: &identityplatform.TenantInboundSamlConfigIdpConfigArgs{
				IdpEntityId: pulumi.String("tf-idp"),
				SignRequest: pulumi.Bool(true),
				SsoUrl:      pulumi.String("https://example.com"),
				IdpCertificates: identityplatform.TenantInboundSamlConfigIdpConfigIdpCertificateArray{
					&identityplatform.TenantInboundSamlConfigIdpConfigIdpCertificateArgs{
						X509Certificate: invokeFile.Result,
					},
				},
			},
			SpConfig: &identityplatform.TenantInboundSamlConfigSpConfigArgs{
				SpEntityId:  pulumi.String("tf-sp"),
				CallbackUri: pulumi.String("https://example.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
using Std = Pulumi.Std;

return await Deployment.RunAsync(() => 
{
    var tenant = new Gcp.IdentityPlatform.Tenant("tenant", new()
    {
        DisplayName = "tenant",
    });

    var tenantSamlConfig = new Gcp.IdentityPlatform.TenantInboundSamlConfig("tenant_saml_config", new()
    {
        Name = "saml.tf-config",
        DisplayName = "Display Name",
        Tenant = tenant.Name,
        IdpConfig = new Gcp.IdentityPlatform.Inputs.TenantInboundSamlConfigIdpConfigArgs
        {
            IdpEntityId = "tf-idp",
            SignRequest = true,
            SsoUrl = "https://example.com",
            IdpCertificates = new[]
            {
                new Gcp.IdentityPlatform.Inputs.TenantInboundSamlConfigIdpConfigIdpCertificateArgs
                {
                    X509Certificate = Std.File.Invoke(new()
                    {
                        Input = "test-fixtures/rsa_cert.pem",
                    }).Apply(invoke => invoke.Result),
                },
            },
        },
        SpConfig = new Gcp.IdentityPlatform.Inputs.TenantInboundSamlConfigSpConfigArgs
        {
            SpEntityId = "tf-sp",
            CallbackUri = "https://example.com",
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.identityplatform.Tenant;
import com.pulumi.gcp.identityplatform.TenantArgs;
import com.pulumi.gcp.identityplatform.TenantInboundSamlConfig;
import com.pulumi.gcp.identityplatform.TenantInboundSamlConfigArgs;
import com.pulumi.gcp.identityplatform.inputs.TenantInboundSamlConfigIdpConfigArgs;
import com.pulumi.gcp.identityplatform.inputs.TenantInboundSamlConfigSpConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var tenant = new Tenant("tenant", TenantArgs.builder()
            .displayName("tenant")
            .build());

        var tenantSamlConfig = new TenantInboundSamlConfig("tenantSamlConfig", TenantInboundSamlConfigArgs.builder()
            .name("saml.tf-config")
            .displayName("Display Name")
            .tenant(tenant.name())
            .idpConfig(TenantInboundSamlConfigIdpConfigArgs.builder()
                .idpEntityId("tf-idp")
                .signRequest(true)
                .ssoUrl("https://example.com")
                .idpCertificates(TenantInboundSamlConfigIdpConfigIdpCertificateArgs.builder()
                    .x509Certificate(StdFunctions.file(FileArgs.builder()
                        .input("test-fixtures/rsa_cert.pem")
                        .build()).result())
                    .build())
                .build())
            .spConfig(TenantInboundSamlConfigSpConfigArgs.builder()
                .spEntityId("tf-sp")
                .callbackUri("https://example.com")
                .build())
            .build());

    }
}

    resources:
  tenant:
    type: gcp:identityplatform:Tenant
    properties:
      displayName: tenant
  tenantSamlConfig:
    type: gcp:identityplatform:TenantInboundSamlConfig
    name: tenant_saml_config
    properties:
      name: saml.tf-config
      displayName: Display Name
      tenant: ${tenant.name}
      idpConfig:
        idpEntityId: tf-idp
        signRequest: true
        ssoUrl: https://example.com
        idpCertificates:
          - x509Certificate:
              fn::invoke:
                Function: std:file
                Arguments:
                  input: test-fixtures/rsa_cert.pem
                Return: result
      spConfig:
        spEntityId: tf-sp
        callbackUri: https://example.com

    Create TenantInboundSamlConfig Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new TenantInboundSamlConfig(name: string, args: TenantInboundSamlConfigArgs, opts?: CustomResourceOptions);
    @overload
def TenantInboundSamlConfig(resource_name: str,
                            args: TenantInboundSamlConfigArgs,
                            opts: Optional[ResourceOptions] = None)

@overload
def TenantInboundSamlConfig(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            display_name: Optional[str] = None,
                            idp_config: Optional[TenantInboundSamlConfigIdpConfigArgs] = None,
                            sp_config: Optional[TenantInboundSamlConfigSpConfigArgs] = None,
                            tenant: Optional[str] = None,
                            enabled: Optional[bool] = None,
                            name: Optional[str] = None,
                            project: Optional[str] = None)
    func NewTenantInboundSamlConfig(ctx *Context, name string, args TenantInboundSamlConfigArgs, opts ...ResourceOption) (*TenantInboundSamlConfig, error)
    public TenantInboundSamlConfig(string name, TenantInboundSamlConfigArgs args, CustomResourceOptions? opts = null)
    public TenantInboundSamlConfig(String name, TenantInboundSamlConfigArgs args)
public TenantInboundSamlConfig(String name, TenantInboundSamlConfigArgs args, CustomResourceOptions options)

    type: gcp:identityplatform:TenantInboundSamlConfig
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.
    args TenantInboundSamlConfigArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control 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.
    name String
    The unique name of the resource.
    args TenantInboundSamlConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var tenantInboundSamlConfigResource = new Gcp.IdentityPlatform.TenantInboundSamlConfig("tenantInboundSamlConfigResource", new()
{
    DisplayName = "string",
    IdpConfig = new Gcp.IdentityPlatform.Inputs.TenantInboundSamlConfigIdpConfigArgs
    {
        IdpCertificates = new[]
        {
            new Gcp.IdentityPlatform.Inputs.TenantInboundSamlConfigIdpConfigIdpCertificateArgs
            {
                X509Certificate = "string",
            },
        },
        IdpEntityId = "string",
        SsoUrl = "string",
        SignRequest = false,
    },
    SpConfig = new Gcp.IdentityPlatform.Inputs.TenantInboundSamlConfigSpConfigArgs
    {
        CallbackUri = "string",
        SpEntityId = "string",
        SpCertificates = new[]
        {
            new Gcp.IdentityPlatform.Inputs.TenantInboundSamlConfigSpConfigSpCertificateArgs
            {
                X509Certificate = "string",
            },
        },
    },
    Tenant = "string",
    Enabled = false,
    Name = "string",
    Project = "string",
});

    example, err := identityplatform.NewTenantInboundSamlConfig(ctx, "tenantInboundSamlConfigResource", &identityplatform.TenantInboundSamlConfigArgs{
	DisplayName: pulumi.String("string"),
	IdpConfig: &identityplatform.TenantInboundSamlConfigIdpConfigArgs{
		IdpCertificates: identityplatform.TenantInboundSamlConfigIdpConfigIdpCertificateArray{
			&identityplatform.TenantInboundSamlConfigIdpConfigIdpCertificateArgs{
				X509Certificate: pulumi.String("string"),
			},
		},
		IdpEntityId: pulumi.String("string"),
		SsoUrl:      pulumi.String("string"),
		SignRequest: pulumi.Bool(false),
	},
	SpConfig: &identityplatform.TenantInboundSamlConfigSpConfigArgs{
		CallbackUri: pulumi.String("string"),
		SpEntityId:  pulumi.String("string"),
		SpCertificates: identityplatform.TenantInboundSamlConfigSpConfigSpCertificateArray{
			&identityplatform.TenantInboundSamlConfigSpConfigSpCertificateArgs{
				X509Certificate: pulumi.String("string"),
			},
		},
	},
	Tenant:  pulumi.String("string"),
	Enabled: pulumi.Bool(false),
	Name:    pulumi.String("string"),
	Project: pulumi.String("string"),
})

    var tenantInboundSamlConfigResource = new TenantInboundSamlConfig("tenantInboundSamlConfigResource", TenantInboundSamlConfigArgs.builder()
    .displayName("string")
    .idpConfig(TenantInboundSamlConfigIdpConfigArgs.builder()
        .idpCertificates(TenantInboundSamlConfigIdpConfigIdpCertificateArgs.builder()
            .x509Certificate("string")
            .build())
        .idpEntityId("string")
        .ssoUrl("string")
        .signRequest(false)
        .build())
    .spConfig(TenantInboundSamlConfigSpConfigArgs.builder()
        .callbackUri("string")
        .spEntityId("string")
        .spCertificates(TenantInboundSamlConfigSpConfigSpCertificateArgs.builder()
            .x509Certificate("string")
            .build())
        .build())
    .tenant("string")
    .enabled(false)
    .name("string")
    .project("string")
    .build());

    tenant_inbound_saml_config_resource = gcp.identityplatform.TenantInboundSamlConfig("tenantInboundSamlConfigResource",
    display_name="string",
    idp_config=gcp.identityplatform.TenantInboundSamlConfigIdpConfigArgs(
        idp_certificates=[gcp.identityplatform.TenantInboundSamlConfigIdpConfigIdpCertificateArgs(
            x509_certificate="string",
        )],
        idp_entity_id="string",
        sso_url="string",
        sign_request=False,
    ),
    sp_config=gcp.identityplatform.TenantInboundSamlConfigSpConfigArgs(
        callback_uri="string",
        sp_entity_id="string",
        sp_certificates=[gcp.identityplatform.TenantInboundSamlConfigSpConfigSpCertificateArgs(
            x509_certificate="string",
        )],
    ),
    tenant="string",
    enabled=False,
    name="string",
    project="string")

    const tenantInboundSamlConfigResource = new gcp.identityplatform.TenantInboundSamlConfig("tenantInboundSamlConfigResource", {
    displayName: "string",
    idpConfig: {
        idpCertificates: [{
            x509Certificate: "string",
        }],
        idpEntityId: "string",
        ssoUrl: "string",
        signRequest: false,
    },
    spConfig: {
        callbackUri: "string",
        spEntityId: "string",
        spCertificates: [{
            x509Certificate: "string",
        }],
    },
    tenant: "string",
    enabled: false,
    name: "string",
    project: "string",
});

    type: gcp:identityplatform:TenantInboundSamlConfig
properties:
    displayName: string
    enabled: false
    idpConfig:
        idpCertificates:
            - x509Certificate: string
        idpEntityId: string
        signRequest: false
        ssoUrl: string
    name: string
    project: string
    spConfig:
        callbackUri: string
        spCertificates:
            - x509Certificate: string
        spEntityId: string
    tenant: string

    TenantInboundSamlConfig Resource Properties

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

    Inputs

    The TenantInboundSamlConfig resource accepts the following input properties:

    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
    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
    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
    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
    display_name str
    Human friendly display name.
    idp_config TenantInboundSamlConfigIdpConfigArgs
    SAML IdP configuration when the project acts as the relying party Structure is documented below.
    sp_config 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 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
    displayName String
    Human friendly display name.
    idpConfig Property Map
    SAML IdP configuration when the project acts as the relying party Structure is documented below.
    spConfig Property Map
    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

    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 string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up 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
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        display_name: Optional[str] = None,
        enabled: Optional[bool] = None,
        idp_config: Optional[TenantInboundSamlConfigIdpConfigArgs] = None,
        name: Optional[str] = None,
        project: Optional[str] = None,
        sp_config: Optional[TenantInboundSamlConfigSpConfigArgs] = None,
        tenant: Optional[str] = None) -> TenantInboundSamlConfig
    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)
    public static TenantInboundSamlConfig get(String name, Output<String> id, TenantInboundSamlConfigState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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 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
    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 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
    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 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
    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
    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 TenantInboundSamlConfigIdpConfigArgs
    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
    sp_config 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 str
    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 Property Map
    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
    spConfig Property Map
    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

    Supporting Types

    TenantInboundSamlConfigIdpConfig, TenantInboundSamlConfigIdpConfigArgs

    IdpCertificates List<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 bool
    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 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 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.
    idp_certificates Sequence[TenantInboundSamlConfigIdpConfigIdpCertificate]
    The IDP's certificate data to verify the signature in the SAMLResponse issued by the IDP. Structure is documented below.
    idp_entity_id str
    Unique identifier for all SAML entities
    sso_url str
    URL to send Authentication request to.
    sign_request bool
    Indicates if outbounding SAMLRequest should be signed.
    idpCertificates List<Property Map>
    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.

    TenantInboundSamlConfigIdpConfigIdpCertificate, TenantInboundSamlConfigIdpConfigIdpCertificateArgs

    X509Certificate string
    The x509 certificate
    X509Certificate string
    The x509 certificate
    x509Certificate String
    The x509 certificate
    x509Certificate string
    The x509 certificate
    x509_certificate str
    The x509 certificate
    x509Certificate String
    The x509 certificate

    TenantInboundSamlConfigSpConfig, TenantInboundSamlConfigSpConfigArgs

    CallbackUri string
    Callback URI where responses from IDP are handled. Must start with https://.
    SpEntityId string
    Unique identifier for all SAML entities.
    SpCertificates List<TenantInboundSamlConfigSpConfigSpCertificate>

    (Output) The IDP's certificate data to verify the signature in the SAMLResponse issued by the IDP. Structure is documented below.

    The sp_certificates block contains:

    CallbackUri string
    Callback URI where responses from IDP are handled. Must start with https://.
    SpEntityId string
    Unique identifier for all SAML entities.
    SpCertificates []TenantInboundSamlConfigSpConfigSpCertificate

    (Output) The IDP's certificate data to verify the signature in the SAMLResponse issued by the IDP. Structure is documented below.

    The sp_certificates block contains:

    callbackUri String
    Callback URI where responses from IDP are handled. Must start with https://.
    spEntityId String
    Unique identifier for all SAML entities.
    spCertificates List<TenantInboundSamlConfigSpConfigSpCertificate>

    (Output) The IDP's certificate data to verify the signature in the SAMLResponse issued by the IDP. Structure is documented below.

    The sp_certificates block contains:

    callbackUri string
    Callback URI where responses from IDP are handled. Must start with https://.
    spEntityId string
    Unique identifier for all SAML entities.
    spCertificates TenantInboundSamlConfigSpConfigSpCertificate[]

    (Output) The IDP's certificate data to verify the signature in the SAMLResponse issued by the IDP. Structure is documented below.

    The sp_certificates block contains:

    callback_uri str
    Callback URI where responses from IDP are handled. Must start with https://.
    sp_entity_id str
    Unique identifier for all SAML entities.
    sp_certificates Sequence[TenantInboundSamlConfigSpConfigSpCertificate]

    (Output) The IDP's certificate data to verify the signature in the SAMLResponse issued by the IDP. Structure is documented below.

    The sp_certificates block contains:

    callbackUri String
    Callback URI where responses from IDP are handled. Must start with https://.
    spEntityId String
    Unique identifier for all SAML entities.
    spCertificates List<Property Map>

    (Output) The IDP's certificate data to verify the signature in the SAMLResponse issued by the IDP. Structure is documented below.

    The sp_certificates block contains:

    TenantInboundSamlConfigSpConfigSpCertificate, TenantInboundSamlConfigSpConfigSpCertificateArgs

    X509Certificate string
    The x509 certificate
    X509Certificate string
    The x509 certificate
    x509Certificate String
    The x509 certificate
    x509Certificate string
    The x509 certificate
    x509_certificate str
    The x509 certificate
    x509Certificate String
    The x509 certificate

    Import

    TenantInboundSamlConfig can be imported using any of these accepted formats:

    • projects/{{project}}/tenants/{{tenant}}/inboundSamlConfigs/{{name}}

    • {{project}}/{{tenant}}/{{name}}

    • {{tenant}}/{{name}}

    When using the pulumi import command, TenantInboundSamlConfig can be imported using one of the formats above. For example:

    $ pulumi import gcp:identityplatform/tenantInboundSamlConfig:TenantInboundSamlConfig default projects/{{project}}/tenants/{{tenant}}/inboundSamlConfigs/{{name}}

    $ pulumi import gcp:identityplatform/tenantInboundSamlConfig:TenantInboundSamlConfig default {{project}}/{{tenant}}/{{name}}

    $ pulumi import gcp:identityplatform/tenantInboundSamlConfig:TenantInboundSamlConfig default {{tenant}}/{{name}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Google Cloud (GCP) Classic pulumi/pulumi-gcp
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the google-beta Terraform Provider.
    gcp logo
    Google Cloud Classic v7.29.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-gcp