1. Packages
  2. Zitadel
  3. API Docs
  4. getIdpSaml
Viewing docs for zitadel v0.2.0
published on Monday, Mar 24, 2025 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-zitadel

zitadel.getIdpSaml

zitadel logo
Viewing docs for zitadel v0.2.0
published on Monday, Mar 24, 2025 by pulumiverse
Schema (JSON)
pulumiverse/pulumi-zitadel

    Datasource representing a SAML IDP on the instance.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Zitadel = Pulumi.Zitadel;

return await Deployment.RunAsync(() => 
{
    var @default = Zitadel.GetIdpSaml.Invoke(new()
    {
        Id = "123456789012345678",
    });

});

    package main

import (
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumiverse/pulumi-zitadel/sdk/go/zitadel"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := zitadel.LookupIdpSaml(ctx, &zitadel.LookupIdpSamlArgs{
			Id: "123456789012345678",
		}, nil)
		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.zitadel.ZitadelFunctions;
import com.pulumi.zitadel.inputs.GetIdpSamlArgs;
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) {
        final var default = ZitadelFunctions.getIdpSaml(GetIdpSamlArgs.builder()
            .id("123456789012345678")
            .build());

    }
}

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

const default = zitadel.getIdpSaml({
    id: "123456789012345678",
});

    import pulumi
import pulumi_zitadel as zitadel

default = zitadel.get_idp_saml(id="123456789012345678")

    variables:
  default:
    fn::invoke:
      Function: zitadel:getIdpSaml
      Arguments:
        id: '123456789012345678'

    Using getIdpSaml

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getIdpSaml(args: GetIdpSamlArgs, opts?: InvokeOptions): Promise<GetIdpSamlResult>
function getIdpSamlOutput(args: GetIdpSamlOutputArgs, opts?: InvokeOptions): Output<GetIdpSamlResult>
    def get_idp_saml(id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetIdpSamlResult
def get_idp_saml_output(id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetIdpSamlResult]
    func LookupIdpSaml(ctx *Context, args *LookupIdpSamlArgs, opts ...InvokeOption) (*LookupIdpSamlResult, error)
func LookupIdpSamlOutput(ctx *Context, args *LookupIdpSamlOutputArgs, opts ...InvokeOption) LookupIdpSamlResultOutput

    > Note: This function is named LookupIdpSaml in the Go SDK.

    public static class GetIdpSaml 
{
    public static Task<GetIdpSamlResult> InvokeAsync(GetIdpSamlArgs args, InvokeOptions? opts = null)
    public static Output<GetIdpSamlResult> Invoke(GetIdpSamlInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetIdpSamlResult> getIdpSaml(GetIdpSamlArgs args, InvokeOptions options)
public static Output<GetIdpSamlResult> getIdpSaml(GetIdpSamlArgs args, InvokeOptions options)

    fn::invoke:
  function: zitadel:index/getIdpSaml:getIdpSaml
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    The ID of this resource.
    Id string
    The ID of this resource.
    id String
    The ID of this resource.
    id string
    The ID of this resource.
    id str
    The ID of this resource.
    id String
    The ID of this resource.

    getIdpSaml Result

    The following output properties are available:

    Binding string
    The binding
    Id string
    The ID of this resource.
    IsAutoCreation bool
    enabled if a new account in ZITADEL are created automatically on login with an external account
    IsAutoUpdate bool
    enabled if a the ZITADEL account fields are updated automatically on each login
    IsCreationAllowed bool
    enabled if users are able to create a new account in ZITADEL when using an external account
    IsLinkingAllowed bool
    enabled if users are able to link an existing ZITADEL user with an external account
    MetadataXml string
    The metadata XML as plain string
    Name string
    Name of the IDP
    WithSignedRequest string
    Whether the SAML IDP requires signed requests
    Binding string
    The binding
    Id string
    The ID of this resource.
    IsAutoCreation bool
    enabled if a new account in ZITADEL are created automatically on login with an external account
    IsAutoUpdate bool
    enabled if a the ZITADEL account fields are updated automatically on each login
    IsCreationAllowed bool
    enabled if users are able to create a new account in ZITADEL when using an external account
    IsLinkingAllowed bool
    enabled if users are able to link an existing ZITADEL user with an external account
    MetadataXml string
    The metadata XML as plain string
    Name string
    Name of the IDP
    WithSignedRequest string
    Whether the SAML IDP requires signed requests
    binding String
    The binding
    id String
    The ID of this resource.
    isAutoCreation Boolean
    enabled if a new account in ZITADEL are created automatically on login with an external account
    isAutoUpdate Boolean
    enabled if a the ZITADEL account fields are updated automatically on each login
    isCreationAllowed Boolean
    enabled if users are able to create a new account in ZITADEL when using an external account
    isLinkingAllowed Boolean
    enabled if users are able to link an existing ZITADEL user with an external account
    metadataXml String
    The metadata XML as plain string
    name String
    Name of the IDP
    withSignedRequest String
    Whether the SAML IDP requires signed requests
    binding string
    The binding
    id string
    The ID of this resource.
    isAutoCreation boolean
    enabled if a new account in ZITADEL are created automatically on login with an external account
    isAutoUpdate boolean
    enabled if a the ZITADEL account fields are updated automatically on each login
    isCreationAllowed boolean
    enabled if users are able to create a new account in ZITADEL when using an external account
    isLinkingAllowed boolean
    enabled if users are able to link an existing ZITADEL user with an external account
    metadataXml string
    The metadata XML as plain string
    name string
    Name of the IDP
    withSignedRequest string
    Whether the SAML IDP requires signed requests
    binding str
    The binding
    id str
    The ID of this resource.
    is_auto_creation bool
    enabled if a new account in ZITADEL are created automatically on login with an external account
    is_auto_update bool
    enabled if a the ZITADEL account fields are updated automatically on each login
    is_creation_allowed bool
    enabled if users are able to create a new account in ZITADEL when using an external account
    is_linking_allowed bool
    enabled if users are able to link an existing ZITADEL user with an external account
    metadata_xml str
    The metadata XML as plain string
    name str
    Name of the IDP
    with_signed_request str
    Whether the SAML IDP requires signed requests
    binding String
    The binding
    id String
    The ID of this resource.
    isAutoCreation Boolean
    enabled if a new account in ZITADEL are created automatically on login with an external account
    isAutoUpdate Boolean
    enabled if a the ZITADEL account fields are updated automatically on each login
    isCreationAllowed Boolean
    enabled if users are able to create a new account in ZITADEL when using an external account
    isLinkingAllowed Boolean
    enabled if users are able to link an existing ZITADEL user with an external account
    metadataXml String
    The metadata XML as plain string
    name String
    Name of the IDP
    withSignedRequest String
    Whether the SAML IDP requires signed requests

    Package Details

    Repository
    zitadel pulumiverse/pulumi-zitadel
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the zitadel Terraform Provider.
    zitadel logo
    Viewing docs for zitadel v0.2.0
    published on Monday, Mar 24, 2025 by pulumiverse
    Schema (JSON)
    pulumiverse/pulumi-zitadel
      Try Pulumi Cloud free. Your team will thank you.