1. Packages
  2. Ibm Provider
  3. API Docs
  4. getAppidIdpSaml
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

ibm.getAppidIdpSaml

Explore with Pulumi AI

ibm logo
ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud

    Retrieve information about an IBM Cloud AppID SAML IDP. For more information, see SAML

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as ibm from "@pulumi/ibm";
    
    const saml = ibm.getAppidIdpSaml({
        tenantId: _var.tenant_id,
    });
    
    import pulumi
    import pulumi_ibm as ibm
    
    saml = ibm.get_appid_idp_saml(tenant_id=var["tenant_id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/ibm/ibm"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := ibm.LookupAppidIdpSaml(ctx, &ibm.LookupAppidIdpSamlArgs{
    			TenantId: _var.Tenant_id,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Ibm = Pulumi.Ibm;
    
    return await Deployment.RunAsync(() => 
    {
        var saml = Ibm.GetAppidIdpSaml.Invoke(new()
        {
            TenantId = @var.Tenant_id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.ibm.IbmFunctions;
    import com.pulumi.ibm.inputs.GetAppidIdpSamlArgs;
    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 saml = IbmFunctions.getAppidIdpSaml(GetAppidIdpSamlArgs.builder()
                .tenantId(var_.tenant_id())
                .build());
    
        }
    }
    
    variables:
      saml:
        fn::invoke:
          function: ibm:getAppidIdpSaml
          arguments:
            tenantId: ${var.tenant_id}
    

    Using getAppidIdpSaml

    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 getAppidIdpSaml(args: GetAppidIdpSamlArgs, opts?: InvokeOptions): Promise<GetAppidIdpSamlResult>
    function getAppidIdpSamlOutput(args: GetAppidIdpSamlOutputArgs, opts?: InvokeOptions): Output<GetAppidIdpSamlResult>
    def get_appid_idp_saml(id: Optional[str] = None,
                           tenant_id: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetAppidIdpSamlResult
    def get_appid_idp_saml_output(id: Optional[pulumi.Input[str]] = None,
                           tenant_id: Optional[pulumi.Input[str]] = None,
                           opts: Optional[InvokeOptions] = None) -> Output[GetAppidIdpSamlResult]
    func LookupAppidIdpSaml(ctx *Context, args *LookupAppidIdpSamlArgs, opts ...InvokeOption) (*LookupAppidIdpSamlResult, error)
    func LookupAppidIdpSamlOutput(ctx *Context, args *LookupAppidIdpSamlOutputArgs, opts ...InvokeOption) LookupAppidIdpSamlResultOutput

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

    public static class GetAppidIdpSaml 
    {
        public static Task<GetAppidIdpSamlResult> InvokeAsync(GetAppidIdpSamlArgs args, InvokeOptions? opts = null)
        public static Output<GetAppidIdpSamlResult> Invoke(GetAppidIdpSamlInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetAppidIdpSamlResult> getAppidIdpSaml(GetAppidIdpSamlArgs args, InvokeOptions options)
    public static Output<GetAppidIdpSamlResult> getAppidIdpSaml(GetAppidIdpSamlArgs args, InvokeOptions options)
    
    fn::invoke:
      function: ibm:index/getAppidIdpSaml:getAppidIdpSaml
      arguments:
        # arguments dictionary

    The following arguments are supported:

    TenantId string
    The AppID instance GUID
    Id string
    TenantId string
    The AppID instance GUID
    Id string
    tenantId String
    The AppID instance GUID
    id String
    tenantId string
    The AppID instance GUID
    id string
    tenant_id str
    The AppID instance GUID
    id str
    tenantId String
    The AppID instance GUID
    id String

    getAppidIdpSaml Result

    The following output properties are available:

    Configs List<GetAppidIdpSamlConfig>
    (List of Object, Max: 1) current SAML IDP configuration if active
    Id string
    IsActive bool
    (String) true if SAML IDP is active
    TenantId string
    Configs []GetAppidIdpSamlConfig
    (List of Object, Max: 1) current SAML IDP configuration if active
    Id string
    IsActive bool
    (String) true if SAML IDP is active
    TenantId string
    configs List<GetAppidIdpSamlConfig>
    (List of Object, Max: 1) current SAML IDP configuration if active
    id String
    isActive Boolean
    (String) true if SAML IDP is active
    tenantId String
    configs GetAppidIdpSamlConfig[]
    (List of Object, Max: 1) current SAML IDP configuration if active
    id string
    isActive boolean
    (String) true if SAML IDP is active
    tenantId string
    configs Sequence[GetAppidIdpSamlConfig]
    (List of Object, Max: 1) current SAML IDP configuration if active
    id str
    is_active bool
    (String) true if SAML IDP is active
    tenant_id str
    configs List<Property Map>
    (List of Object, Max: 1) current SAML IDP configuration if active
    id String
    isActive Boolean
    (String) true if SAML IDP is active
    tenantId String

    Supporting Types

    GetAppidIdpSamlConfig

    AuthnContexts List<GetAppidIdpSamlConfigAuthnContext>
    (List of Object, Max: 1) SAML authNContext configuration
    Certificates List<string>
    (List of String) List of certificates, primary and optional secondary
    DisplayName string
    (String) Optional provider name
    EncryptResponse bool
    (Bool) true if SAML responses should be encrypted
    EntityId string
    (String) Unique name for an Identity Provider
    IncludeScoping bool
    (Bool) true if scopes are included
    SignInUrl string
    (String) SAML SSO url
    SignRequest bool
    (Bool) true if SAML requests should be signed
    AuthnContexts []GetAppidIdpSamlConfigAuthnContext
    (List of Object, Max: 1) SAML authNContext configuration
    Certificates []string
    (List of String) List of certificates, primary and optional secondary
    DisplayName string
    (String) Optional provider name
    EncryptResponse bool
    (Bool) true if SAML responses should be encrypted
    EntityId string
    (String) Unique name for an Identity Provider
    IncludeScoping bool
    (Bool) true if scopes are included
    SignInUrl string
    (String) SAML SSO url
    SignRequest bool
    (Bool) true if SAML requests should be signed
    authnContexts List<GetAppidIdpSamlConfigAuthnContext>
    (List of Object, Max: 1) SAML authNContext configuration
    certificates List<String>
    (List of String) List of certificates, primary and optional secondary
    displayName String
    (String) Optional provider name
    encryptResponse Boolean
    (Bool) true if SAML responses should be encrypted
    entityId String
    (String) Unique name for an Identity Provider
    includeScoping Boolean
    (Bool) true if scopes are included
    signInUrl String
    (String) SAML SSO url
    signRequest Boolean
    (Bool) true if SAML requests should be signed
    authnContexts GetAppidIdpSamlConfigAuthnContext[]
    (List of Object, Max: 1) SAML authNContext configuration
    certificates string[]
    (List of String) List of certificates, primary and optional secondary
    displayName string
    (String) Optional provider name
    encryptResponse boolean
    (Bool) true if SAML responses should be encrypted
    entityId string
    (String) Unique name for an Identity Provider
    includeScoping boolean
    (Bool) true if scopes are included
    signInUrl string
    (String) SAML SSO url
    signRequest boolean
    (Bool) true if SAML requests should be signed
    authn_contexts Sequence[GetAppidIdpSamlConfigAuthnContext]
    (List of Object, Max: 1) SAML authNContext configuration
    certificates Sequence[str]
    (List of String) List of certificates, primary and optional secondary
    display_name str
    (String) Optional provider name
    encrypt_response bool
    (Bool) true if SAML responses should be encrypted
    entity_id str
    (String) Unique name for an Identity Provider
    include_scoping bool
    (Bool) true if scopes are included
    sign_in_url str
    (String) SAML SSO url
    sign_request bool
    (Bool) true if SAML requests should be signed
    authnContexts List<Property Map>
    (List of Object, Max: 1) SAML authNContext configuration
    certificates List<String>
    (List of String) List of certificates, primary and optional secondary
    displayName String
    (String) Optional provider name
    encryptResponse Boolean
    (Bool) true if SAML responses should be encrypted
    entityId String
    (String) Unique name for an Identity Provider
    includeScoping Boolean
    (Bool) true if scopes are included
    signInUrl String
    (String) SAML SSO url
    signRequest Boolean
    (Bool) true if SAML requests should be signed

    GetAppidIdpSamlConfigAuthnContext

    Classes List<string>
    Comparison string
    Classes []string
    Comparison string
    classes List<String>
    comparison String
    classes string[]
    comparison string
    classes Sequence[str]
    comparison str
    classes List<String>
    comparison String

    Package Details

    Repository
    ibm ibm-cloud/terraform-provider-ibm
    License
    Notes
    This Pulumi package is based on the ibm Terraform Provider.
    ibm logo
    ibm 1.77.1 published on Monday, Apr 14, 2025 by ibm-cloud