Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vcd Provider
  3. API Docs
  4. getOrgSaml
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

vcd.getOrgSaml

Explore with Pulumi AI

vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

Supported in provider v3.10+.

Provides a data source to read SAML configuration for an organization.

Note: This data source requires system administrator privileges.

Example Usage

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

const my_org = vcd.getOrg({
    name: "my-org",
});
const first = my_org.then(my_org => vcd.getOrgSaml({
    orgId: my_org.id,
}));
Copy
import pulumi
import pulumi_vcd as vcd

my_org = vcd.get_org(name="my-org")
first = vcd.get_org_saml(org_id=my_org.id)
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vcd/v3/vcd"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		my_org, err := vcd.LookupOrg(ctx, &vcd.LookupOrgArgs{
			Name: "my-org",
		}, nil)
		if err != nil {
			return err
		}
		_, err = vcd.LookupOrgSaml(ctx, &vcd.LookupOrgSamlArgs{
			OrgId: my_org.Id,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vcd = Pulumi.Vcd;

return await Deployment.RunAsync(() => 
{
    var my_org = Vcd.GetOrg.Invoke(new()
    {
        Name = "my-org",
    });

    var first = Vcd.GetOrgSaml.Invoke(new()
    {
        OrgId = my_org.Apply(getOrgResult => getOrgResult.Id),
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vcd.VcdFunctions;
import com.pulumi.vcd.inputs.GetOrgArgs;
import com.pulumi.vcd.inputs.GetOrgSamlArgs;
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 my-org = VcdFunctions.getOrg(GetOrgArgs.builder()
            .name("my-org")
            .build());

        final var first = VcdFunctions.getOrgSaml(GetOrgSamlArgs.builder()
            .orgId(my_org.id())
            .build());

    }
}
Copy
variables:
  my-org:
    fn::invoke:
      function: vcd:getOrg
      arguments:
        name: my-org
  first:
    fn::invoke:
      function: vcd:getOrgSaml
      arguments:
        orgId: ${["my-org"].id}
Copy

Using getOrgSaml

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 getOrgSaml(args: GetOrgSamlArgs, opts?: InvokeOptions): Promise<GetOrgSamlResult>
function getOrgSamlOutput(args: GetOrgSamlOutputArgs, opts?: InvokeOptions): Output<GetOrgSamlResult>
Copy
def get_org_saml(id: Optional[str] = None,
                 org_id: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetOrgSamlResult
def get_org_saml_output(id: Optional[pulumi.Input[str]] = None,
                 org_id: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetOrgSamlResult]
Copy
func LookupOrgSaml(ctx *Context, args *LookupOrgSamlArgs, opts ...InvokeOption) (*LookupOrgSamlResult, error)
func LookupOrgSamlOutput(ctx *Context, args *LookupOrgSamlOutputArgs, opts ...InvokeOption) LookupOrgSamlResultOutput
Copy

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

public static class GetOrgSaml 
{
    public static Task<GetOrgSamlResult> InvokeAsync(GetOrgSamlArgs args, InvokeOptions? opts = null)
    public static Output<GetOrgSamlResult> Invoke(GetOrgSamlInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetOrgSamlResult> getOrgSaml(GetOrgSamlArgs args, InvokeOptions options)
public static Output<GetOrgSamlResult> getOrgSaml(GetOrgSamlArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: vcd:index/getOrgSaml:getOrgSaml
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

OrgId This property is required. string
ID of the organization containing the SAML settings
Id string
OrgId This property is required. string
ID of the organization containing the SAML settings
Id string
orgId This property is required. String
ID of the organization containing the SAML settings
id String
orgId This property is required. string
ID of the organization containing the SAML settings
id string
org_id This property is required. str
ID of the organization containing the SAML settings
id str
orgId This property is required. String
ID of the organization containing the SAML settings
id String

getOrgSaml Result

The following output properties are available:

Email string
The name of the SAML attribute that returns the email address of the user
Enabled bool
Shows whether the SAML identity service is used for authentication
EntityId string
Your service provider entity ID
FirstName string
The name of the SAML attribute that returns the first name of the user
FullName string
The name of the SAML attribute that returns the full name of the user
Group string
The name of the SAML attribute that returns the identifiers of all the groups of which the user is a member
Id string
OrgId string
Role string
The name of the SAML attribute that returns the identifiers of all roles of the user
Surname string
The name of the SAML attribute that returns the surname of the user
UserName string
The name of the SAML attribute that returns the username of the user
Email string
The name of the SAML attribute that returns the email address of the user
Enabled bool
Shows whether the SAML identity service is used for authentication
EntityId string
Your service provider entity ID
FirstName string
The name of the SAML attribute that returns the first name of the user
FullName string
The name of the SAML attribute that returns the full name of the user
Group string
The name of the SAML attribute that returns the identifiers of all the groups of which the user is a member
Id string
OrgId string
Role string
The name of the SAML attribute that returns the identifiers of all roles of the user
Surname string
The name of the SAML attribute that returns the surname of the user
UserName string
The name of the SAML attribute that returns the username of the user
email String
The name of the SAML attribute that returns the email address of the user
enabled Boolean
Shows whether the SAML identity service is used for authentication
entityId String
Your service provider entity ID
firstName String
The name of the SAML attribute that returns the first name of the user
fullName String
The name of the SAML attribute that returns the full name of the user
group String
The name of the SAML attribute that returns the identifiers of all the groups of which the user is a member
id String
orgId String
role String
The name of the SAML attribute that returns the identifiers of all roles of the user
surname String
The name of the SAML attribute that returns the surname of the user
userName String
The name of the SAML attribute that returns the username of the user
email string
The name of the SAML attribute that returns the email address of the user
enabled boolean
Shows whether the SAML identity service is used for authentication
entityId string
Your service provider entity ID
firstName string
The name of the SAML attribute that returns the first name of the user
fullName string
The name of the SAML attribute that returns the full name of the user
group string
The name of the SAML attribute that returns the identifiers of all the groups of which the user is a member
id string
orgId string
role string
The name of the SAML attribute that returns the identifiers of all roles of the user
surname string
The name of the SAML attribute that returns the surname of the user
userName string
The name of the SAML attribute that returns the username of the user
email str
The name of the SAML attribute that returns the email address of the user
enabled bool
Shows whether the SAML identity service is used for authentication
entity_id str
Your service provider entity ID
first_name str
The name of the SAML attribute that returns the first name of the user
full_name str
The name of the SAML attribute that returns the full name of the user
group str
The name of the SAML attribute that returns the identifiers of all the groups of which the user is a member
id str
org_id str
role str
The name of the SAML attribute that returns the identifiers of all roles of the user
surname str
The name of the SAML attribute that returns the surname of the user
user_name str
The name of the SAML attribute that returns the username of the user
email String
The name of the SAML attribute that returns the email address of the user
enabled Boolean
Shows whether the SAML identity service is used for authentication
entityId String
Your service provider entity ID
firstName String
The name of the SAML attribute that returns the first name of the user
fullName String
The name of the SAML attribute that returns the full name of the user
group String
The name of the SAML attribute that returns the identifiers of all the groups of which the user is a member
id String
orgId String
role String
The name of the SAML attribute that returns the identifiers of all roles of the user
surname String
The name of the SAML attribute that returns the surname of the user
userName String
The name of the SAML attribute that returns the username of the user

Package Details

Repository
vcd vmware/terraform-provider-vcd
License
Notes
This Pulumi package is based on the vcd Terraform Provider.
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd