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

vcd.OrgGroup

Explore with Pulumi AI

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

    Create OrgGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new OrgGroup(name: string, args: OrgGroupArgs, opts?: CustomResourceOptions);
    @overload
def OrgGroup(resource_name: str,
             args: OrgGroupArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def OrgGroup(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             provider_type: Optional[str] = None,
             role: Optional[str] = None,
             description: Optional[str] = None,
             name: Optional[str] = None,
             org: Optional[str] = None,
             org_group_id: Optional[str] = None)
    func NewOrgGroup(ctx *Context, name string, args OrgGroupArgs, opts ...ResourceOption) (*OrgGroup, error)
    public OrgGroup(string name, OrgGroupArgs args, CustomResourceOptions? opts = null)
    public OrgGroup(String name, OrgGroupArgs args)
public OrgGroup(String name, OrgGroupArgs args, CustomResourceOptions options)

    type: vcd:OrgGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args OrgGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args OrgGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args OrgGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OrgGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OrgGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var orgGroupResource = new Vcd.OrgGroup("orgGroupResource", new()
{
    ProviderType = "string",
    Role = "string",
    Description = "string",
    Name = "string",
    Org = "string",
    OrgGroupId = "string",
});

    example, err := vcd.NewOrgGroup(ctx, "orgGroupResource", &vcd.OrgGroupArgs{
	ProviderType: pulumi.String("string"),
	Role:         pulumi.String("string"),
	Description:  pulumi.String("string"),
	Name:         pulumi.String("string"),
	Org:          pulumi.String("string"),
	OrgGroupId:   pulumi.String("string"),
})

    var orgGroupResource = new OrgGroup("orgGroupResource", OrgGroupArgs.builder()
    .providerType("string")
    .role("string")
    .description("string")
    .name("string")
    .org("string")
    .orgGroupId("string")
    .build());

    org_group_resource = vcd.OrgGroup("orgGroupResource",
    provider_type="string",
    role="string",
    description="string",
    name="string",
    org="string",
    org_group_id="string")

    const orgGroupResource = new vcd.OrgGroup("orgGroupResource", {
    providerType: "string",
    role: "string",
    description: "string",
    name: "string",
    org: "string",
    orgGroupId: "string",
});

    type: vcd:OrgGroup
properties:
    description: string
    name: string
    org: string
    orgGroupId: string
    providerType: string
    role: string

    OrgGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The OrgGroup resource accepts the following input properties:

    ProviderType string
    Identity provider type for this this group. One of SAML, OAUTH or INTEGRATED. Note LDAP must be configured to create INTEGRATED groups and names must match LDAP group names. If LDAP is not configured - it will return 403 errors.
    Role string
    The role of the group. Role names can be retrieved from the organization. Both built-in roles and custom built can be used. The roles normally available are:

    • Organization Administrator
    • Catalog Author
    • vApp Author
    • vApp User
    • Console Access Only
    • Defer to Identity Provider
    Description string
    The description of Organization group
    Name string
    A unique name for the group.
    Org string
    The name of organization to which the VDC belongs. Optional if defined at provider level.
    OrgGroupId string
    The ID of the Organization group
    ProviderType string
    Identity provider type for this this group. One of SAML, OAUTH or INTEGRATED. Note LDAP must be configured to create INTEGRATED groups and names must match LDAP group names. If LDAP is not configured - it will return 403 errors.
    Role string
    The role of the group. Role names can be retrieved from the organization. Both built-in roles and custom built can be used. The roles normally available are:

    • Organization Administrator
    • Catalog Author
    • vApp Author
    • vApp User
    • Console Access Only
    • Defer to Identity Provider
    Description string
    The description of Organization group
    Name string
    A unique name for the group.
    Org string
    The name of organization to which the VDC belongs. Optional if defined at provider level.
    OrgGroupId string
    The ID of the Organization group
    providerType String
    Identity provider type for this this group. One of SAML, OAUTH or INTEGRATED. Note LDAP must be configured to create INTEGRATED groups and names must match LDAP group names. If LDAP is not configured - it will return 403 errors.
    role String
    The role of the group. Role names can be retrieved from the organization. Both built-in roles and custom built can be used. The roles normally available are:

    • Organization Administrator
    • Catalog Author
    • vApp Author
    • vApp User
    • Console Access Only
    • Defer to Identity Provider
    description String
    The description of Organization group
    name String
    A unique name for the group.
    org String
    The name of organization to which the VDC belongs. Optional if defined at provider level.
    orgGroupId String
    The ID of the Organization group
    providerType string
    Identity provider type for this this group. One of SAML, OAUTH or INTEGRATED. Note LDAP must be configured to create INTEGRATED groups and names must match LDAP group names. If LDAP is not configured - it will return 403 errors.
    role string
    The role of the group. Role names can be retrieved from the organization. Both built-in roles and custom built can be used. The roles normally available are:

    • Organization Administrator
    • Catalog Author
    • vApp Author
    • vApp User
    • Console Access Only
    • Defer to Identity Provider
    description string
    The description of Organization group
    name string
    A unique name for the group.
    org string
    The name of organization to which the VDC belongs. Optional if defined at provider level.
    orgGroupId string
    The ID of the Organization group
    provider_type str
    Identity provider type for this this group. One of SAML, OAUTH or INTEGRATED. Note LDAP must be configured to create INTEGRATED groups and names must match LDAP group names. If LDAP is not configured - it will return 403 errors.
    role str
    The role of the group. Role names can be retrieved from the organization. Both built-in roles and custom built can be used. The roles normally available are:

    • Organization Administrator
    • Catalog Author
    • vApp Author
    • vApp User
    • Console Access Only
    • Defer to Identity Provider
    description str
    The description of Organization group
    name str
    A unique name for the group.
    org str
    The name of organization to which the VDC belongs. Optional if defined at provider level.
    org_group_id str
    The ID of the Organization group
    providerType String
    Identity provider type for this this group. One of SAML, OAUTH or INTEGRATED. Note LDAP must be configured to create INTEGRATED groups and names must match LDAP group names. If LDAP is not configured - it will return 403 errors.
    role String
    The role of the group. Role names can be retrieved from the organization. Both built-in roles and custom built can be used. The roles normally available are:

    • Organization Administrator
    • Catalog Author
    • vApp Author
    • vApp User
    • Console Access Only
    • Defer to Identity Provider
    description String
    The description of Organization group
    name String
    A unique name for the group.
    org String
    The name of organization to which the VDC belongs. Optional if defined at provider level.
    orgGroupId String
    The ID of the Organization group

    Outputs

    All input properties are implicitly available as output properties. Additionally, the OrgGroup resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    UserNames List<string>
    The set of user names that belong to this group. It's only populated if the users are created after the group (with depends_on the given group).
    Id string
    The provider-assigned unique ID for this managed resource.
    UserNames []string
    The set of user names that belong to this group. It's only populated if the users are created after the group (with depends_on the given group).
    id String
    The provider-assigned unique ID for this managed resource.
    userNames List<String>
    The set of user names that belong to this group. It's only populated if the users are created after the group (with depends_on the given group).
    id string
    The provider-assigned unique ID for this managed resource.
    userNames string[]
    The set of user names that belong to this group. It's only populated if the users are created after the group (with depends_on the given group).
    id str
    The provider-assigned unique ID for this managed resource.
    user_names Sequence[str]
    The set of user names that belong to this group. It's only populated if the users are created after the group (with depends_on the given group).
    id String
    The provider-assigned unique ID for this managed resource.
    userNames List<String>
    The set of user names that belong to this group. It's only populated if the users are created after the group (with depends_on the given group).

    Look up Existing OrgGroup Resource

    Get an existing OrgGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: OrgGroupState, opts?: CustomResourceOptions): OrgGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        name: Optional[str] = None,
        org: Optional[str] = None,
        org_group_id: Optional[str] = None,
        provider_type: Optional[str] = None,
        role: Optional[str] = None,
        user_names: Optional[Sequence[str]] = None) -> OrgGroup
    func GetOrgGroup(ctx *Context, name string, id IDInput, state *OrgGroupState, opts ...ResourceOption) (*OrgGroup, error)
    public static OrgGroup Get(string name, Input<string> id, OrgGroupState? state, CustomResourceOptions? opts = null)
    public static OrgGroup get(String name, Output<String> id, OrgGroupState state, CustomResourceOptions options)
    resources:  _:    type: vcd:OrgGroup    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Description string
    The description of Organization group
    Name string
    A unique name for the group.
    Org string
    The name of organization to which the VDC belongs. Optional if defined at provider level.
    OrgGroupId string
    The ID of the Organization group
    ProviderType string
    Identity provider type for this this group. One of SAML, OAUTH or INTEGRATED. Note LDAP must be configured to create INTEGRATED groups and names must match LDAP group names. If LDAP is not configured - it will return 403 errors.
    Role string
    The role of the group. Role names can be retrieved from the organization. Both built-in roles and custom built can be used. The roles normally available are:

    • Organization Administrator
    • Catalog Author
    • vApp Author
    • vApp User
    • Console Access Only
    • Defer to Identity Provider
    UserNames List<string>
    The set of user names that belong to this group. It's only populated if the users are created after the group (with depends_on the given group).
    Description string
    The description of Organization group
    Name string
    A unique name for the group.
    Org string
    The name of organization to which the VDC belongs. Optional if defined at provider level.
    OrgGroupId string
    The ID of the Organization group
    ProviderType string
    Identity provider type for this this group. One of SAML, OAUTH or INTEGRATED. Note LDAP must be configured to create INTEGRATED groups and names must match LDAP group names. If LDAP is not configured - it will return 403 errors.
    Role string
    The role of the group. Role names can be retrieved from the organization. Both built-in roles and custom built can be used. The roles normally available are:

    • Organization Administrator
    • Catalog Author
    • vApp Author
    • vApp User
    • Console Access Only
    • Defer to Identity Provider
    UserNames []string
    The set of user names that belong to this group. It's only populated if the users are created after the group (with depends_on the given group).
    description String
    The description of Organization group
    name String
    A unique name for the group.
    org String
    The name of organization to which the VDC belongs. Optional if defined at provider level.
    orgGroupId String
    The ID of the Organization group
    providerType String
    Identity provider type for this this group. One of SAML, OAUTH or INTEGRATED. Note LDAP must be configured to create INTEGRATED groups and names must match LDAP group names. If LDAP is not configured - it will return 403 errors.
    role String
    The role of the group. Role names can be retrieved from the organization. Both built-in roles and custom built can be used. The roles normally available are:

    • Organization Administrator
    • Catalog Author
    • vApp Author
    • vApp User
    • Console Access Only
    • Defer to Identity Provider
    userNames List<String>
    The set of user names that belong to this group. It's only populated if the users are created after the group (with depends_on the given group).
    description string
    The description of Organization group
    name string
    A unique name for the group.
    org string
    The name of organization to which the VDC belongs. Optional if defined at provider level.
    orgGroupId string
    The ID of the Organization group
    providerType string
    Identity provider type for this this group. One of SAML, OAUTH or INTEGRATED. Note LDAP must be configured to create INTEGRATED groups and names must match LDAP group names. If LDAP is not configured - it will return 403 errors.
    role string
    The role of the group. Role names can be retrieved from the organization. Both built-in roles and custom built can be used. The roles normally available are:

    • Organization Administrator
    • Catalog Author
    • vApp Author
    • vApp User
    • Console Access Only
    • Defer to Identity Provider
    userNames string[]
    The set of user names that belong to this group. It's only populated if the users are created after the group (with depends_on the given group).
    description str
    The description of Organization group
    name str
    A unique name for the group.
    org str
    The name of organization to which the VDC belongs. Optional if defined at provider level.
    org_group_id str
    The ID of the Organization group
    provider_type str
    Identity provider type for this this group. One of SAML, OAUTH or INTEGRATED. Note LDAP must be configured to create INTEGRATED groups and names must match LDAP group names. If LDAP is not configured - it will return 403 errors.
    role str
    The role of the group. Role names can be retrieved from the organization. Both built-in roles and custom built can be used. The roles normally available are:

    • Organization Administrator
    • Catalog Author
    • vApp Author
    • vApp User
    • Console Access Only
    • Defer to Identity Provider
    user_names Sequence[str]
    The set of user names that belong to this group. It's only populated if the users are created after the group (with depends_on the given group).
    description String
    The description of Organization group
    name String
    A unique name for the group.
    org String
    The name of organization to which the VDC belongs. Optional if defined at provider level.
    orgGroupId String
    The ID of the Organization group
    providerType String
    Identity provider type for this this group. One of SAML, OAUTH or INTEGRATED. Note LDAP must be configured to create INTEGRATED groups and names must match LDAP group names. If LDAP is not configured - it will return 403 errors.
    role String
    The role of the group. Role names can be retrieved from the organization. Both built-in roles and custom built can be used. The roles normally available are:

    • Organization Administrator
    • Catalog Author
    • vApp Author
    • vApp User
    • Console Access Only
    • Defer to Identity Provider
    userNames List<String>
    The set of user names that belong to this group. It's only populated if the users are created after the group (with depends_on the given group).

    Package Details

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