okta.idp.getSaml

Explore with Pulumi AI

Okta v4.15.0 published on Friday, Mar 7, 2025 by Pulumi

Example Usage

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

const example = okta.idp.getSaml({
    name: "Example App",
});

import pulumi
import pulumi_okta as okta

example = okta.idp.get_saml(name="Example App")

package main

import (
	"github.com/pulumi/pulumi-okta/sdk/v4/go/okta/idp"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := idp.LookupSaml(ctx, &idp.LookupSamlArgs{
			Name: pulumi.StringRef("Example App"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = Okta.Idp.GetSaml.Invoke(new()
    {
        Name = "Example App",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.okta.idp.IdpFunctions;
import com.pulumi.okta.idp.inputs.GetSamlArgs;
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 example = IdpFunctions.getSaml(GetSamlArgs.builder()
            .name("Example App")
            .build());

    }
}

variables:
  example:
    fn::invoke:
      function: okta:idp:getSaml
      arguments:
        name: Example App

Using getSaml

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 getSaml(args: GetSamlArgs, opts?: InvokeOptions): Promise<GetSamlResult>
function getSamlOutput(args: GetSamlOutputArgs, opts?: InvokeOptions): Output<GetSamlResult>

def get_saml(id: Optional[str] = None,
             name: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetSamlResult
def get_saml_output(id: Optional[pulumi.Input[str]] = None,
             name: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetSamlResult]

func LookupSaml(ctx *Context, args *LookupSamlArgs, opts ...InvokeOption) (*LookupSamlResult, error)
func LookupSamlOutput(ctx *Context, args *LookupSamlOutputArgs, opts ...InvokeOption) LookupSamlResultOutput

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

public static class GetSaml 
{
    public static Task<GetSamlResult> InvokeAsync(GetSamlArgs args, InvokeOptions? opts = null)
    public static Output<GetSamlResult> Invoke(GetSamlInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetSamlResult> getSaml(GetSamlArgs args, InvokeOptions options)
public static Output<GetSamlResult> getSaml(GetSamlArgs args, InvokeOptions options)

fn::invoke:
  function: okta:idp/getSaml:getSaml
  arguments:
    # arguments dictionary

The following arguments are supported:

Id string: Id of idp.
Name string: Name of the idp.

Id string: Id of idp.
Name string: Name of the idp.

id String: Id of idp.
name String: Name of the idp.

id string: Id of idp.
name string: Name of the idp.

id str: Id of idp.
name str: Name of the idp.

id String: Id of idp.
name String: Name of the idp.

getSaml Result

The following output properties are available:

AcsBinding string: ACS binding
AcsType string: Determines whether to publish an instance-specific (trust) or organization (shared) ACS endpoint in the SAML metadata.
Audience string: URI that identifies the target Okta IdP instance (SP)
Issuer string: URI that identifies the issuer (IdP).
IssuerMode string: Indicates whether Okta uses the original Okta org domain URL, or a custom domain URL in the request to the IdP.
Kid string: Key ID reference to the IdP's X.509 signature certificate.
SsoBinding string: Single sign-on binding.
SsoDestination string: SSO request binding, HTTP-POST or HTTP-REDIRECT.
SsoUrl string: Single sign-on url.
SubjectFilter string: Regular expression pattern used to filter untrusted IdP usernames.
SubjectFormats List<string>: Expression to generate or transform a unique username for the IdP user.
Type string: Type of idp.
Id string: Id of idp.
Name string: Name of the idp.

AcsBinding string: ACS binding
AcsType string: Determines whether to publish an instance-specific (trust) or organization (shared) ACS endpoint in the SAML metadata.
Audience string: URI that identifies the target Okta IdP instance (SP)
Issuer string: URI that identifies the issuer (IdP).
IssuerMode string: Indicates whether Okta uses the original Okta org domain URL, or a custom domain URL in the request to the IdP.
Kid string: Key ID reference to the IdP's X.509 signature certificate.
SsoBinding string: Single sign-on binding.
SsoDestination string: SSO request binding, HTTP-POST or HTTP-REDIRECT.
SsoUrl string: Single sign-on url.
SubjectFilter string: Regular expression pattern used to filter untrusted IdP usernames.
SubjectFormats []string: Expression to generate or transform a unique username for the IdP user.
Type string: Type of idp.
Id string: Id of idp.
Name string: Name of the idp.

acsBinding String: ACS binding
acsType String: Determines whether to publish an instance-specific (trust) or organization (shared) ACS endpoint in the SAML metadata.
audience String: URI that identifies the target Okta IdP instance (SP)
issuer String: URI that identifies the issuer (IdP).
issuerMode String: Indicates whether Okta uses the original Okta org domain URL, or a custom domain URL in the request to the IdP.
kid String: Key ID reference to the IdP's X.509 signature certificate.
ssoBinding String: Single sign-on binding.
ssoDestination String: SSO request binding, HTTP-POST or HTTP-REDIRECT.
ssoUrl String: Single sign-on url.
subjectFilter String: Regular expression pattern used to filter untrusted IdP usernames.
subjectFormats List<String>: Expression to generate or transform a unique username for the IdP user.
type String: Type of idp.
id String: Id of idp.
name String: Name of the idp.

acsBinding string: ACS binding
acsType string: Determines whether to publish an instance-specific (trust) or organization (shared) ACS endpoint in the SAML metadata.
audience string: URI that identifies the target Okta IdP instance (SP)
issuer string: URI that identifies the issuer (IdP).
issuerMode string: Indicates whether Okta uses the original Okta org domain URL, or a custom domain URL in the request to the IdP.
kid string: Key ID reference to the IdP's X.509 signature certificate.
ssoBinding string: Single sign-on binding.
ssoDestination string: SSO request binding, HTTP-POST or HTTP-REDIRECT.
ssoUrl string: Single sign-on url.
subjectFilter string: Regular expression pattern used to filter untrusted IdP usernames.
subjectFormats string[]: Expression to generate or transform a unique username for the IdP user.
type string: Type of idp.
id string: Id of idp.
name string: Name of the idp.

acs_binding str: ACS binding
acs_type str: Determines whether to publish an instance-specific (trust) or organization (shared) ACS endpoint in the SAML metadata.
audience str: URI that identifies the target Okta IdP instance (SP)
issuer str: URI that identifies the issuer (IdP).
issuer_mode str: Indicates whether Okta uses the original Okta org domain URL, or a custom domain URL in the request to the IdP.
kid str: Key ID reference to the IdP's X.509 signature certificate.
sso_binding str: Single sign-on binding.
sso_destination str: SSO request binding, HTTP-POST or HTTP-REDIRECT.
sso_url str: Single sign-on url.
subject_filter str: Regular expression pattern used to filter untrusted IdP usernames.
subject_formats Sequence[str]: Expression to generate or transform a unique username for the IdP user.
type str: Type of idp.
id str: Id of idp.
name str: Name of the idp.

acsBinding String: ACS binding
acsType String: Determines whether to publish an instance-specific (trust) or organization (shared) ACS endpoint in the SAML metadata.
audience String: URI that identifies the target Okta IdP instance (SP)
issuer String: URI that identifies the issuer (IdP).
issuerMode String: Indicates whether Okta uses the original Okta org domain URL, or a custom domain URL in the request to the IdP.
kid String: Key ID reference to the IdP's X.509 signature certificate.
ssoBinding String: Single sign-on binding.
ssoDestination String: SSO request binding, HTTP-POST or HTTP-REDIRECT.
ssoUrl String: Single sign-on url.
subjectFilter String: Regular expression pattern used to filter untrusted IdP usernames.
subjectFormats List<String>: Expression to generate or transform a unique username for the IdP user.
type String: Type of idp.
id String: Id of idp.
name String: Name of the idp.

Package Details

Repository: Okta pulumi/pulumi-okta
License: Apache-2.0
Notes: This Pulumi package is based on the okta Terraform Provider.

Okta v4.15.0 published on Friday, Mar 7, 2025 by Pulumi

pulumi/pulumi-okta

okta.idp.getSaml

On this page

On this page

Example Usage

Using getSaml

getSaml Result

Package Details

On this page

On this page