Module identityplatform

This page documents the language specification for the gcp package. If you're looking for help working with the inputs, outputs, or functions of gcp resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

DefaultSupportedIdpConfig
InboundSamlConfig
OauthIdpConfig
Tenant
TenantDefaultSupportedIdpConfig
TenantInboundSamlConfig
TenantOauthIdpConfig

Resources

Resource DefaultSupportedIdpConfig

class DefaultSupportedIdpConfig extends CustomResource

Configurations options for authenticating with a the standard set of Identity Toolkit-trusted IDPs.

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

Example Usage - Identity Platform Default Supported Idp Config Basic

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

const idpConfig = new gcp.identityplatform.DefaultSupportedIdpConfig("idpConfig", {
    clientId: "client-id",
    clientSecret: "secret",
    enabled: true,
    idpId: "playgames.google.com",
});

constructor

new DefaultSupportedIdpConfig(name: string, args: DefaultSupportedIdpConfigArgs, opts?: pulumi.CustomResourceOptions)

Create a DefaultSupportedIdpConfig resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DefaultSupportedIdpConfigState, opts?: pulumi.CustomResourceOptions): DefaultSupportedIdpConfig

Get an existing DefaultSupportedIdpConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is DefaultSupportedIdpConfig

Returns true if the given object is an instance of DefaultSupportedIdpConfig. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property clientId

public clientId: pulumi.Output<string>;

OAuth client ID

property clientSecret

public clientSecret: pulumi.Output<string>;

OAuth client secret

property enabled

public enabled: pulumi.Output<boolean | undefined>;

If this IDP allows the user to sign in

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property idpId

public idpId: pulumi.Output<string>;

ID of the IDP. Possible values include: * apple.com * facebook.com * gc.apple.com * github.com * google.com * linkedin.com * microsoft.com * playgames.google.com * twitter.com * yahoo.com

property name

public name: pulumi.Output<string>;

The name of the DefaultSupportedIdpConfig resource

property project

public project: pulumi.Output<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource InboundSamlConfig

class InboundSamlConfig extends CustomResource

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 * from "fs";

const samlConfig = new gcp.identityplatform.InboundSamlConfig("samlConfig", {
    displayName: "Display Name",
    idp_config: {
        idpEntityId: "tf-idp",
        signRequest: true,
        ssoUrl: "https://example.com",
        idp_certificates: [{
            x509Certificate: fs.readFileSync("test-fixtures/rsa_cert.pem"),
        }],
    },
    sp_config: {
        spEntityId: "tf-sp",
        callbackUri: "https://example.com",
    },
});

constructor

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

Create a InboundSamlConfig resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: InboundSamlConfigState, opts?: pulumi.CustomResourceOptions): InboundSamlConfig

Get an existing InboundSamlConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is InboundSamlConfig

Returns true if the given object is an instance of InboundSamlConfig. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property displayName

public displayName: pulumi.Output<string>;

Human friendly display name.

property enabled

public enabled: pulumi.Output<boolean | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property idpConfig

public idpConfig: pulumi.Output<InboundSamlConfigIdpConfig>;

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

property name

public name: pulumi.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.

property project

public project: pulumi.Output<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property spConfig

public spConfig: pulumi.Output<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.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource OauthIdpConfig

class OauthIdpConfig extends CustomResource

OIDC IdP 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 Oauth Idp Config Basic

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

const oauthIdpConfig = new gcp.identityplatform.OauthIdpConfig("oauthIdpConfig", {
    clientId: "client-id",
    clientSecret: "secret",
    displayName: "Display Name",
    enabled: true,
    issuer: "issuer",
});

constructor

new OauthIdpConfig(name: string, args: OauthIdpConfigArgs, opts?: pulumi.CustomResourceOptions)

Create a OauthIdpConfig resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: OauthIdpConfigState, opts?: pulumi.CustomResourceOptions): OauthIdpConfig

Get an existing OauthIdpConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is OauthIdpConfig

Returns true if the given object is an instance of OauthIdpConfig. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property clientId

public clientId: pulumi.Output<string>;

The client id of an OAuth client.

property clientSecret

public clientSecret: pulumi.Output<string | undefined>;

The client secret of the OAuth client, to enable OIDC code flow.

property displayName

public displayName: pulumi.Output<string | undefined>;

Human friendly display name.

property enabled

public enabled: pulumi.Output<boolean | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property issuer

public issuer: pulumi.Output<string>;

For OIDC Idps, the issuer identifier.

property name

public name: pulumi.Output<string>;

The name of the OauthIdpConfig. Must start with oidc..

property project

public project: pulumi.Output<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Tenant

class Tenant extends CustomResource

Tenant configuration in a multi-tenant project.

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

You must enable multi-tenancy via the Cloud Console prior to creating tenants.

Example Usage - Identity Platform Tenant Basic

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

const tenant = new gcp.identityplatform.Tenant("tenant", {
    allowPasswordSignup: true,
    displayName: "tenant",
});

constructor

new Tenant(name: string, args: TenantArgs, opts?: pulumi.CustomResourceOptions)

Create a Tenant resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TenantState, opts?: pulumi.CustomResourceOptions): Tenant

Get an existing Tenant resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is Tenant

Returns true if the given object is an instance of Tenant. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property allowPasswordSignup

public allowPasswordSignup: pulumi.Output<boolean | undefined>;

Whether to allow email/password user authentication.

property disableAuth

public disableAuth: pulumi.Output<boolean | undefined>;

Whether authentication is disabled for the tenant. If true, the users under the disabled tenant are not allowed to sign-in. Admins of the disabled tenant are not able to manage its users.

property displayName

public displayName: pulumi.Output<string>;

Human friendly display name of the tenant.

property enableEmailLinkSignin

public enableEmailLinkSignin: pulumi.Output<boolean | undefined>;

Whether to enable email link user authentication.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The name of the tenant that is generated by the server

property project

public project: pulumi.Output<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource TenantDefaultSupportedIdpConfig

class TenantDefaultSupportedIdpConfig extends CustomResource

Configurations options for the tenant for authenticating with a the standard set of Identity Toolkit-trusted IDPs.

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

Example Usage - Identity Platform Tenant Default Supported Idp Config Basic

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

const tenant = new gcp.identityplatform.Tenant("tenant", {displayName: "tenant"});
const idpConfig = new gcp.identityplatform.TenantDefaultSupportedIdpConfig("idpConfig", {
    enabled: true,
    tenant: tenant.name,
    idpId: "playgames.google.com",
    clientId: "my-client-id",
    clientSecret: "secret",
});

constructor

new TenantDefaultSupportedIdpConfig(name: string, args: TenantDefaultSupportedIdpConfigArgs, opts?: pulumi.CustomResourceOptions)

Create a TenantDefaultSupportedIdpConfig resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TenantDefaultSupportedIdpConfigState, opts?: pulumi.CustomResourceOptions): TenantDefaultSupportedIdpConfig

Get an existing TenantDefaultSupportedIdpConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is TenantDefaultSupportedIdpConfig

Returns true if the given object is an instance of TenantDefaultSupportedIdpConfig. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property clientId

public clientId: pulumi.Output<string>;

OAuth client ID

property clientSecret

public clientSecret: pulumi.Output<string>;

OAuth client secret

property enabled

public enabled: pulumi.Output<boolean | undefined>;

If this IDP allows the user to sign in

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property idpId

public idpId: pulumi.Output<string>;

property name

public name: pulumi.Output<string>;

The name of the default supported IDP config resource

property project

public project: pulumi.Output<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property tenant

public tenant: pulumi.Output<string>;

The name of the tenant where this DefaultSupportedIdpConfig resource exists

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource TenantInboundSamlConfig

class TenantInboundSamlConfig extends CustomResource

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 * from "fs";

const tenant = new gcp.identityplatform.Tenant("tenant", {displayName: "tenant"});
const tenantSamlConfig = new gcp.identityplatform.TenantInboundSamlConfig("tenantSamlConfig", {
    displayName: "Display Name",
    tenant: tenant.name,
    idp_config: {
        idpEntityId: "tf-idp",
        signRequest: true,
        ssoUrl: "https://example.com",
        idp_certificates: [{
            x509Certificate: fs.readFileSync("test-fixtures/rsa_cert.pem"),
        }],
    },
    sp_config: {
        spEntityId: "tf-sp",
        callbackUri: "https://example.com",
    },
});

constructor

new TenantInboundSamlConfig(name: string, args: TenantInboundSamlConfigArgs, opts?: pulumi.CustomResourceOptions)

Create a TenantInboundSamlConfig resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TenantInboundSamlConfigState, opts?: pulumi.CustomResourceOptions): TenantInboundSamlConfig

Get an existing TenantInboundSamlConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is TenantInboundSamlConfig

Returns true if the given object is an instance of TenantInboundSamlConfig. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property displayName

public displayName: pulumi.Output<string>;

Human friendly display name.

property enabled

public enabled: pulumi.Output<boolean | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property idpConfig

public idpConfig: pulumi.Output<TenantInboundSamlConfigIdpConfig>;

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

property name

public name: pulumi.Output<string>;

property project

public project: pulumi.Output<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property spConfig

public spConfig: pulumi.Output<TenantInboundSamlConfigSpConfig>;

property tenant

public tenant: pulumi.Output<string>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource TenantOauthIdpConfig

class TenantOauthIdpConfig extends CustomResource

OIDC IdP configuration for a Identity Toolkit project within a tenant.

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

Example Usage - Identity Platform Tenant Oauth Idp Config Basic

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

const tenant = new gcp.identityplatform.Tenant("tenant", {displayName: "tenant"});
const tenantOauthIdpConfig = new gcp.identityplatform.TenantOauthIdpConfig("tenantOauthIdpConfig", {
    tenant: tenant.name,
    displayName: "Display Name",
    clientId: "client-id",
    issuer: "issuer",
    enabled: true,
    clientSecret: "secret",
});

constructor

new TenantOauthIdpConfig(name: string, args: TenantOauthIdpConfigArgs, opts?: pulumi.CustomResourceOptions)

Create a TenantOauthIdpConfig resource with the given unique name, arguments, and options.

name The unique name of the resource.
args The arguments to use to populate this resource's properties.
opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: TenantOauthIdpConfigState, opts?: pulumi.CustomResourceOptions): TenantOauthIdpConfig

Get an existing TenantOauthIdpConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): obj is TenantOauthIdpConfig

Returns true if the given object is an instance of TenantOauthIdpConfig. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property clientId

public clientId: pulumi.Output<string>;

The client id of an OAuth client.

property clientSecret

public clientSecret: pulumi.Output<string | undefined>;

The client secret of the OAuth client, to enable OIDC code flow.

property displayName

public displayName: pulumi.Output<string>;

Human friendly display name.

property enabled

public enabled: pulumi.Output<boolean | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property issuer

public issuer: pulumi.Output<string>;

For OIDC Idps, the issuer identifier.

property name

public name: pulumi.Output<string>;

The name of the OauthIdpConfig. Must start with oidc..

property project

public project: pulumi.Output<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property tenant

public tenant: pulumi.Output<string>;

The name of the tenant where this OIDC IDP configuration resource exists

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Others

interface DefaultSupportedIdpConfigArgs

interface DefaultSupportedIdpConfigArgs

The set of arguments for constructing a DefaultSupportedIdpConfig resource.

property clientId

clientId: pulumi.Input<string>;

OAuth client ID

property clientSecret

clientSecret: pulumi.Input<string>;

OAuth client secret

property enabled

enabled?: pulumi.Input<boolean>;

If this IDP allows the user to sign in

property idpId

idpId: pulumi.Input<string>;

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

interface DefaultSupportedIdpConfigState

interface DefaultSupportedIdpConfigState

Input properties used for looking up and filtering DefaultSupportedIdpConfig resources.

property clientId

clientId?: pulumi.Input<string>;

OAuth client ID

property clientSecret

clientSecret?: pulumi.Input<string>;

OAuth client secret

property enabled

enabled?: pulumi.Input<boolean>;

If this IDP allows the user to sign in

property idpId

idpId?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

The name of the DefaultSupportedIdpConfig resource

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

interface InboundSamlConfigArgs

interface InboundSamlConfigArgs

The set of arguments for constructing a InboundSamlConfig resource.

property displayName

displayName: pulumi.Input<string>;

Human friendly display name.

property enabled

enabled?: pulumi.Input<boolean>;

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

property idpConfig

idpConfig: pulumi.Input<InboundSamlConfigIdpConfig>;

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

property name

name?: pulumi.Input<string>;

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property spConfig

spConfig: pulumi.Input<InboundSamlConfigSpConfig>;

interface InboundSamlConfigState

interface InboundSamlConfigState

Input properties used for looking up and filtering InboundSamlConfig resources.

property displayName

displayName?: pulumi.Input<string>;

Human friendly display name.

property enabled

enabled?: pulumi.Input<boolean>;

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

property idpConfig

idpConfig?: pulumi.Input<InboundSamlConfigIdpConfig>;

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

property name

name?: pulumi.Input<string>;

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property spConfig

spConfig?: pulumi.Input<InboundSamlConfigSpConfig>;

interface OauthIdpConfigArgs

interface OauthIdpConfigArgs

The set of arguments for constructing a OauthIdpConfig resource.

property clientId

clientId: pulumi.Input<string>;

The client id of an OAuth client.

property clientSecret

clientSecret?: pulumi.Input<string>;

The client secret of the OAuth client, to enable OIDC code flow.

property displayName

displayName?: pulumi.Input<string>;

Human friendly display name.

property enabled

enabled?: pulumi.Input<boolean>;

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

property issuer

issuer: pulumi.Input<string>;

For OIDC Idps, the issuer identifier.

property name

name?: pulumi.Input<string>;

The name of the OauthIdpConfig. Must start with oidc..

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

interface OauthIdpConfigState

interface OauthIdpConfigState

Input properties used for looking up and filtering OauthIdpConfig resources.

property clientId

clientId?: pulumi.Input<string>;

The client id of an OAuth client.

property clientSecret

clientSecret?: pulumi.Input<string>;

The client secret of the OAuth client, to enable OIDC code flow.

property displayName

displayName?: pulumi.Input<string>;

Human friendly display name.

property enabled

enabled?: pulumi.Input<boolean>;

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

property issuer

issuer?: pulumi.Input<string>;

For OIDC Idps, the issuer identifier.

property name

name?: pulumi.Input<string>;

The name of the OauthIdpConfig. Must start with oidc..

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

interface TenantArgs

interface TenantArgs

The set of arguments for constructing a Tenant resource.

property allowPasswordSignup

allowPasswordSignup?: pulumi.Input<boolean>;

Whether to allow email/password user authentication.

property disableAuth

disableAuth?: pulumi.Input<boolean>;

Whether authentication is disabled for the tenant. If true, the users under the disabled tenant are not allowed to sign-in. Admins of the disabled tenant are not able to manage its users.

property displayName

displayName: pulumi.Input<string>;

Human friendly display name of the tenant.

property enableEmailLinkSignin

enableEmailLinkSignin?: pulumi.Input<boolean>;

Whether to enable email link user authentication.

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

interface TenantDefaultSupportedIdpConfigArgs

interface TenantDefaultSupportedIdpConfigArgs

The set of arguments for constructing a TenantDefaultSupportedIdpConfig resource.

property clientId

clientId: pulumi.Input<string>;

OAuth client ID

property clientSecret

clientSecret: pulumi.Input<string>;

OAuth client secret

property enabled

enabled?: pulumi.Input<boolean>;

If this IDP allows the user to sign in

property idpId

idpId: pulumi.Input<string>;

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property tenant

tenant: pulumi.Input<string>;

The name of the tenant where this DefaultSupportedIdpConfig resource exists

interface TenantDefaultSupportedIdpConfigState

interface TenantDefaultSupportedIdpConfigState

Input properties used for looking up and filtering TenantDefaultSupportedIdpConfig resources.

property clientId

clientId?: pulumi.Input<string>;

OAuth client ID

property clientSecret

clientSecret?: pulumi.Input<string>;

OAuth client secret

property enabled

enabled?: pulumi.Input<boolean>;

If this IDP allows the user to sign in

property idpId

idpId?: pulumi.Input<string>;

property name

name?: pulumi.Input<string>;

The name of the default supported IDP config resource

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property tenant

tenant?: pulumi.Input<string>;

The name of the tenant where this DefaultSupportedIdpConfig resource exists

interface TenantInboundSamlConfigArgs

interface TenantInboundSamlConfigArgs

The set of arguments for constructing a TenantInboundSamlConfig resource.

property displayName

displayName: pulumi.Input<string>;

Human friendly display name.

property enabled

enabled?: pulumi.Input<boolean>;

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

property idpConfig

idpConfig: pulumi.Input<TenantInboundSamlConfigIdpConfig>;

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

property name

name?: pulumi.Input<string>;

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property spConfig

spConfig: pulumi.Input<TenantInboundSamlConfigSpConfig>;

property tenant

tenant: pulumi.Input<string>;

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

interface TenantInboundSamlConfigState

interface TenantInboundSamlConfigState

Input properties used for looking up and filtering TenantInboundSamlConfig resources.

property displayName

displayName?: pulumi.Input<string>;

Human friendly display name.

property enabled

enabled?: pulumi.Input<boolean>;

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

property idpConfig

idpConfig?: pulumi.Input<TenantInboundSamlConfigIdpConfig>;

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

property name

name?: pulumi.Input<string>;

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property spConfig

spConfig?: pulumi.Input<TenantInboundSamlConfigSpConfig>;

property tenant

tenant?: pulumi.Input<string>;

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

interface TenantOauthIdpConfigArgs

interface TenantOauthIdpConfigArgs

The set of arguments for constructing a TenantOauthIdpConfig resource.

property clientId

clientId: pulumi.Input<string>;

The client id of an OAuth client.

property clientSecret

clientSecret?: pulumi.Input<string>;

The client secret of the OAuth client, to enable OIDC code flow.

property displayName

displayName: pulumi.Input<string>;

Human friendly display name.

property enabled

enabled?: pulumi.Input<boolean>;

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

property issuer

issuer: pulumi.Input<string>;

For OIDC Idps, the issuer identifier.

property name

name?: pulumi.Input<string>;

The name of the OauthIdpConfig. Must start with oidc..

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property tenant

tenant: pulumi.Input<string>;

The name of the tenant where this OIDC IDP configuration resource exists

interface TenantOauthIdpConfigState

interface TenantOauthIdpConfigState

Input properties used for looking up and filtering TenantOauthIdpConfig resources.

property clientId

clientId?: pulumi.Input<string>;

The client id of an OAuth client.

property clientSecret

clientSecret?: pulumi.Input<string>;

The client secret of the OAuth client, to enable OIDC code flow.

property displayName

displayName?: pulumi.Input<string>;

Human friendly display name.

property enabled

enabled?: pulumi.Input<boolean>;

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

property issuer

issuer?: pulumi.Input<string>;

For OIDC Idps, the issuer identifier.

property name

name?: pulumi.Input<string>;

The name of the OauthIdpConfig. Must start with oidc..

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

property tenant

tenant?: pulumi.Input<string>;

The name of the tenant where this OIDC IDP configuration resource exists

interface TenantState

interface TenantState

Input properties used for looking up and filtering Tenant resources.

property allowPasswordSignup

allowPasswordSignup?: pulumi.Input<boolean>;

Whether to allow email/password user authentication.

property disableAuth

disableAuth?: pulumi.Input<boolean>;

Whether authentication is disabled for the tenant. If true, the users under the disabled tenant are not allowed to sign-in. Admins of the disabled tenant are not able to manage its users.

property displayName

displayName?: pulumi.Input<string>;

Human friendly display name of the tenant.

property enableEmailLinkSignin

enableEmailLinkSignin?: pulumi.Input<boolean>;

Whether to enable email link user authentication.

property name

name?: pulumi.Input<string>;

The name of the tenant that is generated by the server

property project

project?: pulumi.Input<string>;

The ID of the project in which the resource belongs. If it is not provided, the provider project is used.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Module identityplatform

Resources

Others

Resources

Example Usage - Identity Platform Default Supported Idp Config Basic

Example Usage - Identity Platform Inbound Saml Config Basic

Example Usage - Identity Platform Oauth Idp Config Basic

Example Usage - Identity Platform Tenant Basic

Example Usage - Identity Platform Tenant Default Supported Idp Config Basic

Example Usage - Identity Platform Tenant Inbound Saml Config Basic

Example Usage - Identity Platform Tenant Oauth Idp Config Basic

Others