Sign in Dashboard Get started
  1. Registry
  2. Packages
  3. Vsphere Provider
  4. API Docs
  5. getSsoGroup
Viewing docs for vSphere v4.18.0
published on Wednesday, Sep 2, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-vsphere

vsphere.getSsoGroup

vsphere logo vsphere logo
Viewing docs for vSphere v4.18.0
published on Wednesday, Sep 2, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-vsphere

    The vsphere.SsoGroup data source can be used to look up a vCenter Single Sign-On group by its name and domain, along with its user and nested-group members.

    Example Usage

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

const example = vsphere.getSsoGroup({
    name: "engineering",
});

    import pulumi
import pulumi_vsphere as vsphere

example = vsphere.get_sso_group(name="engineering")

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vsphere.GetSsoGroup(ctx, &vsphere.LookupSsoGroupArgs{
			Name: "engineering",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var example = VSphere.GetSsoGroup.Invoke(new()
    {
        Name = "engineering",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vsphere.VsphereFunctions;
import com.pulumi.vsphere.inputs.GetSsoGroupArgs;
import java.util.ArrayList;
import java.util.Arrays;
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 = VsphereFunctions.getSsoGroup(GetSsoGroupArgs.builder()
            .name("engineering")
            .build());

    }
}

    variables:
  example:
    fn::invoke:
      function: vsphere:getSsoGroup
      arguments:
        name: engineering

    pulumi {
  required_providers {
    vsphere = {
      source = "pulumi/vsphere"
    }
  }
}

data "vsphere_getssogroup" "example" {
  name = "engineering"
}

    Using getSsoGroup

    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 getSsoGroup(args: GetSsoGroupArgs, opts?: InvokeOptions): Promise<GetSsoGroupResult>
function getSsoGroupOutput(args: GetSsoGroupOutputArgs, opts?: InvokeOutputOptions): Output<GetSsoGroupResult>
    def get_sso_group(domain: Optional[str] = None,
                  name: Optional[str] = None,
                  opts: Optional[InvokeOptions] = None) -> GetSsoGroupResult
def get_sso_group_output(domain: pulumi.Input[Optional[str]] = None,
                  name: pulumi.Input[Optional[str]] = None,
                  opts: Optional[InvokeOutputOptions] = None) -> Output[GetSsoGroupResult]
    func LookupSsoGroup(ctx *Context, args *LookupSsoGroupArgs, opts ...InvokeOption) (*LookupSsoGroupResult, error)
func LookupSsoGroupOutput(ctx *Context, args *LookupSsoGroupOutputArgs, opts ...InvokeOption) LookupSsoGroupResultOutput

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

    public static class GetSsoGroup 
{
    public static Task<GetSsoGroupResult> InvokeAsync(GetSsoGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetSsoGroupResult> Invoke(GetSsoGroupInvokeArgs args, InvokeOptions? opts = null)
    public static Output<GetSsoGroupResult> Invoke(GetSsoGroupInvokeArgs args, InvokeOutputOptions opts)
}
    public static CompletableFuture<GetSsoGroupResult> getSsoGroup(GetSsoGroupArgs args, InvokeOptions options)
public static Output<GetSsoGroupResult> getSsoGroup(GetSsoGroupArgs args, InvokeOptions options)
public static Output<GetSsoGroupResult> getSsoGroup(GetSsoGroupArgs args, InvokeOutputOptions options)

    fn::invoke:
  function: vsphere:index/getSsoGroup:getSsoGroup
  arguments:
    # arguments dictionary
    data "vsphere_get_sso_group" "name" {
    # arguments
}

    The following arguments are supported:

    Name string
    The name of the group to look up.
    Domain string
    The identity source domain the group belongs to. Defaults to the local (system) domain.
    Name string
    The name of the group to look up.
    Domain string
    The identity source domain the group belongs to. Defaults to the local (system) domain.
    name string
    The name of the group to look up.
    domain string
    The identity source domain the group belongs to. Defaults to the local (system) domain.
    name String
    The name of the group to look up.
    domain String
    The identity source domain the group belongs to. Defaults to the local (system) domain.
    name string
    The name of the group to look up.
    domain string
    The identity source domain the group belongs to. Defaults to the local (system) domain.
    name str
    The name of the group to look up.
    domain str
    The identity source domain the group belongs to. Defaults to the local (system) domain.
    name String
    The name of the group to look up.
    domain String
    The identity source domain the group belongs to. Defaults to the local (system) domain.

    getSsoGroup Result

    The following output properties are available:

    Description string
    The description of the group.
    Domain string
    The identity source domain the nested group belongs to.
    Id string
    The provider-assigned unique ID for this managed resource.
    MemberGroups List<Pulumi.VSphere.Outputs.GetSsoGroupMemberGroup>
    The nested group members of the group. Each entry exports:
    MemberUsers List<Pulumi.VSphere.Outputs.GetSsoGroupMemberUser>
    The user members of the group. Each entry exports:
    Name string
    The name of the nested group.
    Description string
    The description of the group.
    Domain string
    The identity source domain the nested group belongs to.
    Id string
    The provider-assigned unique ID for this managed resource.
    MemberGroups []GetSsoGroupMemberGroup
    The nested group members of the group. Each entry exports:
    MemberUsers []GetSsoGroupMemberUser
    The user members of the group. Each entry exports:
    Name string
    The name of the nested group.
    description string
    The description of the group.
    domain string
    The identity source domain the nested group belongs to.
    id string
    The provider-assigned unique ID for this managed resource.
    member_groups list(object)
    The nested group members of the group. Each entry exports:
    member_users list(object)
    The user members of the group. Each entry exports:
    name string
    The name of the nested group.
    description String
    The description of the group.
    domain String
    The identity source domain the nested group belongs to.
    id String
    The provider-assigned unique ID for this managed resource.
    memberGroups List<GetSsoGroupMemberGroup>
    The nested group members of the group. Each entry exports:
    memberUsers List<GetSsoGroupMemberUser>
    The user members of the group. Each entry exports:
    name String
    The name of the nested group.
    description string
    The description of the group.
    domain string
    The identity source domain the nested group belongs to.
    id string
    The provider-assigned unique ID for this managed resource.
    memberGroups GetSsoGroupMemberGroup[]
    The nested group members of the group. Each entry exports:
    memberUsers GetSsoGroupMemberUser[]
    The user members of the group. Each entry exports:
    name string
    The name of the nested group.
    description str
    The description of the group.
    domain str
    The identity source domain the nested group belongs to.
    id str
    The provider-assigned unique ID for this managed resource.
    member_groups Sequence[GetSsoGroupMemberGroup]
    The nested group members of the group. Each entry exports:
    member_users Sequence[GetSsoGroupMemberUser]
    The user members of the group. Each entry exports:
    name str
    The name of the nested group.
    description String
    The description of the group.
    domain String
    The identity source domain the nested group belongs to.
    id String
    The provider-assigned unique ID for this managed resource.
    memberGroups List<Property Map>
    The nested group members of the group. Each entry exports:
    memberUsers List<Property Map>
    The user members of the group. Each entry exports:
    name String
    The name of the nested group.

    Supporting Types

    GetSsoGroupMemberGroup

    Domain string
    The identity source domain the group belongs to. Defaults to the local (system) domain.
    Name string
    The name of the group to look up.
    Domain string
    The identity source domain the group belongs to. Defaults to the local (system) domain.
    Name string
    The name of the group to look up.
    domain string
    The identity source domain the group belongs to. Defaults to the local (system) domain.
    name string
    The name of the group to look up.
    domain String
    The identity source domain the group belongs to. Defaults to the local (system) domain.
    name String
    The name of the group to look up.
    domain string
    The identity source domain the group belongs to. Defaults to the local (system) domain.
    name string
    The name of the group to look up.
    domain str
    The identity source domain the group belongs to. Defaults to the local (system) domain.
    name str
    The name of the group to look up.
    domain String
    The identity source domain the group belongs to. Defaults to the local (system) domain.
    name String
    The name of the group to look up.

    GetSsoGroupMemberUser

    Domain string
    The identity source domain the group belongs to. Defaults to the local (system) domain.
    Name string
    The name of the group to look up.
    Domain string
    The identity source domain the group belongs to. Defaults to the local (system) domain.
    Name string
    The name of the group to look up.
    domain string
    The identity source domain the group belongs to. Defaults to the local (system) domain.
    name string
    The name of the group to look up.
    domain String
    The identity source domain the group belongs to. Defaults to the local (system) domain.
    name String
    The name of the group to look up.
    domain string
    The identity source domain the group belongs to. Defaults to the local (system) domain.
    name string
    The name of the group to look up.
    domain str
    The identity source domain the group belongs to. Defaults to the local (system) domain.
    name str
    The name of the group to look up.
    domain String
    The identity source domain the group belongs to. Defaults to the local (system) domain.
    name String
    The name of the group to look up.

    Package Details

    Repository
    vSphere pulumi/pulumi-vsphere
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the vsphere Terraform Provider.
    vsphere logo vsphere logo
    Viewing docs for vSphere v4.18.0
    published on Wednesday, Sep 2, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-vsphere

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial