pulumi-gcp-kotlin/com.pulumi.gcp.identityplatform.kotlin/InboundSamlConfigArgs

InboundSamlConfigArgs

data class InboundSamlConfigArgs(val displayName: Output<String>? = null, val enabled: Output<Boolean>? = null, val idpConfig: Output<InboundSamlConfigIdpConfigArgs>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val spConfig: Output<InboundSamlConfigSpConfigArgs>? = null) : ConvertibleToJava<InboundSamlConfigArgs>

Inbound SAML configuration for a Identity Toolkit project. You must enable the Google Identity Platform in the marketplace prior to using this resource.

Example Usage

Identity Platform Inbound Saml Config Basic

import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
import * as std from "@pulumi/std";
const samlConfig = new gcp.identityplatform.InboundSamlConfig("saml_config", {
    name: "saml.tf-config",
    displayName: "Display 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",
    },
});
Content copied to clipboard
import pulumi
import pulumi_gcp as gcp
import pulumi_std as std
saml_config = gcp.identityplatform.InboundSamlConfig("saml_config",
    name="saml.tf-config",
    display_name="Display 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",
    })
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
using Std = Pulumi.Std;
return await Deployment.RunAsync(() =>
{
    var samlConfig = new Gcp.IdentityPlatform.InboundSamlConfig("saml_config", new()
    {
        Name = "saml.tf-config",
        DisplayName = "Display Name",
        IdpConfig = new Gcp.IdentityPlatform.Inputs.InboundSamlConfigIdpConfigArgs
        {
            IdpEntityId = "tf-idp",
            SignRequest = true,
            SsoUrl = "https://example.com",
            IdpCertificates = new[]
            {
                new Gcp.IdentityPlatform.Inputs.InboundSamlConfigIdpConfigIdpCertificateArgs
                {
                    X509Certificate = Std.File.Invoke(new()
                    {
                        Input = "test-fixtures/rsa_cert.pem",
                    }).Apply(invoke => invoke.Result),
                },
            },
        },
        SpConfig = new Gcp.IdentityPlatform.Inputs.InboundSamlConfigSpConfigArgs
        {
            SpEntityId = "tf-sp",
            CallbackUri = "https://example.com",
        },
    });
});
Content copied to clipboard
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 {
		invokeFile, err := std.File(ctx, &std.FileArgs{
			Input: "test-fixtures/rsa_cert.pem",
		}, nil)
		if err != nil {
			return err
		}
		_, err = identityplatform.NewInboundSamlConfig(ctx, "saml_config", &identityplatform.InboundSamlConfigArgs{
			Name:        pulumi.String("saml.tf-config"),
			DisplayName: pulumi.String("Display Name"),
			IdpConfig: &identityplatform.InboundSamlConfigIdpConfigArgs{
				IdpEntityId: pulumi.String("tf-idp"),
				SignRequest: pulumi.Bool(true),
				SsoUrl:      pulumi.String("https://example.com"),
				IdpCertificates: identityplatform.InboundSamlConfigIdpConfigIdpCertificateArray{
					&identityplatform.InboundSamlConfigIdpConfigIdpCertificateArgs{
						X509Certificate: pulumi.String(invokeFile.Result),
					},
				},
			},
			SpConfig: &identityplatform.InboundSamlConfigSpConfigArgs{
				SpEntityId:  pulumi.String("tf-sp"),
				CallbackUri: pulumi.String("https://example.com"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.identityplatform.InboundSamlConfig;
import com.pulumi.gcp.identityplatform.InboundSamlConfigArgs;
import com.pulumi.gcp.identityplatform.inputs.InboundSamlConfigIdpConfigArgs;
import com.pulumi.gcp.identityplatform.inputs.InboundSamlConfigSpConfigArgs;
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 samlConfig = new InboundSamlConfig("samlConfig", InboundSamlConfigArgs.builder()
            .name("saml.tf-config")
            .displayName("Display Name")
            .idpConfig(InboundSamlConfigIdpConfigArgs.builder()
                .idpEntityId("tf-idp")
                .signRequest(true)
                .ssoUrl("https://example.com")
                .idpCertificates(InboundSamlConfigIdpConfigIdpCertificateArgs.builder()
                    .x509Certificate(StdFunctions.file(FileArgs.builder()
                        .input("test-fixtures/rsa_cert.pem")
                        .build()).result())
                    .build())
                .build())
            .spConfig(InboundSamlConfigSpConfigArgs.builder()
                .spEntityId("tf-sp")
                .callbackUri("https://example.com")
                .build())
            .build());
    }
}
Content copied to clipboard
resources:
  samlConfig:
    type: gcp:identityplatform:InboundSamlConfig
    name: saml_config
    properties:
      name: saml.tf-config
      displayName: Display 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
Content copied to clipboard

Import

InboundSamlConfig can be imported using any of these accepted formats:

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

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

  • {{name}} When using the pulumi import command, InboundSamlConfig can be imported using one of the formats above. For example:

$ pulumi import gcp:identityplatform/inboundSamlConfig:InboundSamlConfig default projects/{{project}}/inboundSamlConfigs/{{name}}
Content copied to clipboard
$ pulumi import gcp:identityplatform/inboundSamlConfig:InboundSamlConfig default {{project}}/{{name}}
Content copied to clipboard
$ pulumi import gcp:identityplatform/inboundSamlConfig:InboundSamlConfig default {{name}}
Content copied to clipboard

Constructors

Link copied to clipboard
constructor(displayName: Output<String>? = null, enabled: Output<Boolean>? = null, idpConfig: Output<InboundSamlConfigIdpConfigArgs>? = null, name: Output<String>? = null, project: Output<String>? = null, spConfig: Output<InboundSamlConfigSpConfigArgs>? = null)

Properties

Link copied to clipboard
val displayName: Output<String>? = null

Human friendly display name.

Link copied to clipboard
val enabled: Output<Boolean>? = null

If this config allows users to sign in with the provider.

Link copied to clipboard
val idpConfig: Output<InboundSamlConfigIdpConfigArgs>? = null

SAML IdP configuration when the project acts as the relying party Structure is documented below.

Link copied to clipboard
val name: Output<String>? = null

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.

Link copied to clipboard
val project: Output<String>? = null
Link copied to clipboard
val spConfig: Output<InboundSamlConfigSpConfigArgs>? = null

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.

Functions

Link copied to clipboard
open override fun toJava(): InboundSamlConfigArgs