TenantInboundSamlConfig class

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={
        "idp_entity_id": "tf-idp",
        "sign_request": True,
        "sso_url": "https://example.com",
        "idp_certificates": [{
            "x509_certificate": std.file(input="test-fixtures/rsa_cert.pem").result,
        }],
    },
    sp_config={
        "sp_entity_id": "tf-sp",
        "callback_uri": "https://example.com",
    })

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 main

import (
	"github.com/pulumi/pulumi-gcp/sdk/v9/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: pulumi.String(invokeFile.Result),
					},
				},
			},
			SpConfig: &identityplatform.TenantInboundSamlConfigSpConfigArgs{
				SpEntityId:  pulumi.String("tf-sp"),
				CallbackUri: pulumi.String("https://example.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

pulumi {
  required_providers {
    gcp = {
      source = "pulumi/gcp"
    }
    std = {
      source = "pulumi/std"
    }
  }
}

resource "gcp_identityplatform_tenant" "tenant" {
  display_name = "tenant"
}
resource "gcp_identityplatform_tenantinboundsamlconfig" "tenant_saml_config" {
  name         = "saml.tf-config"
  display_name = "Display Name"
  tenant       = gcp_identityplatform_tenant.tenant.name
  idp_config = {
    idp_entity_id = "tf-idp"
    sign_request  = true
    sso_url       = "https://example.com"
    idp_certificates = [{
      "x509Certificate" = file("test-fixtures/rsa_cert.pem")
    }]
  }
  sp_config = {
    sp_entity_id = "tf-sp"
    callback_uri = "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.TenantInboundSamlConfigIdpConfigIdpCertificateArgs;
import com.pulumi.gcp.identityplatform.inputs.TenantInboundSamlConfigSpConfigArgs;
import com.pulumi.std.StdFunctions;
import com.pulumi.std.inputs.FileArgs;
import java.util.ArrayList;
import java.util.Arrays;
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

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}}

Constructors

TenantInboundSamlConfig(String name, {TenantInboundSamlConfigArgs? args, CustomResourceOptions? options}): Creates a new TenantInboundSamlConfig. name The Pulumi resource name. args Arguments used to configure this TenantInboundSamlConfig. The set of arguments for TenantInboundSamlConfig. options Resource options controlling this resource's behavior.
TenantInboundSamlConfig.reference(String urn): Creates a typed reference to an existing TenantInboundSamlConfig resource.

Properties

childResources → Set<Resource>: finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>: latefinalinherited
deletionPolicy ↔ Output<String>: Whether Terraform will be prevented from destroying the resource. Defaults to DELETE. When a 'terraform destroy' or 'pulumi up' would delete the resource, the command will fail if this field is set to "PREVENT" in Terraform state. When set to "ABANDON", the command will remove the resource from Terraform management without updating or deleting the resource in the API. When set to "DELETE", deleting the resource is allowed.
latefinal
displayName ↔ Output<String>: Human friendly display name.
latefinal
enabled ↔ Output<bool?>: If this config allows users to sign in with the provider.
latefinal
hashCode → int: The hash code for this object.
no setterinherited
id ↔ Output<String>: getter/setter pairinherited
idpConfig ↔ Output<TenantInboundSamlConfigIdpConfig>: SAML IdP configuration when the project acts as the relying party Structure is documented below.
latefinal
isCustom → bool: Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool: Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool: Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool: Whether this instance represents a resource value returned over RPC.
finalinherited
name ↔ Output<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.
latefinal
project ↔ Output<String>: The ID of the project in which the resource belongs. If it is not provided, the provider project is used.
latefinal
resourceTransforms → List<ResourceTransform>: Inherited/explicit async transforms.
no setterinherited
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
spConfig ↔ Output<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.
latefinal
tenant ↔ Output<String>: The name of the tenant where this inbound SAML config resource exists
latefinal
transformations → List<ResourceTransformation>: Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>: latefinalinherited

Methods

failId(Object error) → void: Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void: Completes all output properties with error.
inherited
failUrn(Object error) → void: Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?: Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String: Returns this resource's logical name.
inherited
getResourceType() → String: Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>: Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void: Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void: Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void: Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>: Serializes resource properties for RPC transmission.
inherited
toString() → String: A string representation of this object.
inherited

Operators

operator ==(Object other) → bool: The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {TenantInboundSamlConfigState? state, CustomResourceOptions? options}) → TenantInboundSamlConfig: Gets an existing TenantInboundSamlConfig resource's state with the given name and id.