TenantInboundSamlConfigArgs

data class TenantInboundSamlConfigArgs(val displayName: Output<String>? = null, val enabled: Output<Boolean>? = null, val idpConfig: Output<TenantInboundSamlConfigIdpConfigArgs>? = null, val name: Output<String>? = null, val project: Output<String>? = null, val spConfig: Output<TenantInboundSamlConfigSpConfigArgs>? = null, val tenant: Output<String>? = null) : ConvertibleToJava<TenantInboundSamlConfigArgs>

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/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: 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
})
}
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

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

Link copied to clipboard
constructor(displayName: Output<String>? = null, enabled: Output<Boolean>? = null, idpConfig: Output<TenantInboundSamlConfigIdpConfigArgs>? = null, name: Output<String>? = null, project: Output<String>? = null, spConfig: Output<TenantInboundSamlConfigSpConfigArgs>? = null, tenant: Output<String>? = 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

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

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.

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

The name of the tenant where this inbound SAML config resource exists

Functions

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