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

vcd.OrgSaml

Explore with Pulumi AI

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

    Create OrgSaml Resource

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

    Constructor syntax

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

@overload
def OrgSaml(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            org_id: Optional[str] = None,
            enabled: Optional[bool] = None,
            identity_provider_metadata_file: Optional[str] = None,
            first_name: Optional[str] = None,
            full_name: Optional[str] = None,
            group: Optional[str] = None,
            email: Optional[str] = None,
            identity_provider_metadata_text: Optional[str] = None,
            entity_id: Optional[str] = None,
            org_saml_id: Optional[str] = None,
            role: Optional[str] = None,
            surname: Optional[str] = None,
            user_name: Optional[str] = None)
    func NewOrgSaml(ctx *Context, name string, args OrgSamlArgs, opts ...ResourceOption) (*OrgSaml, error)
    public OrgSaml(string name, OrgSamlArgs args, CustomResourceOptions? opts = null)
    public OrgSaml(String name, OrgSamlArgs args)
public OrgSaml(String name, OrgSamlArgs args, CustomResourceOptions options)

    type: vcd:OrgSaml
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 OrgSamlArgs
    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 OrgSamlArgs
    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 OrgSamlArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args OrgSamlArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args OrgSamlArgs
    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 orgSamlResource = new Vcd.OrgSaml("orgSamlResource", new()
{
    OrgId = "string",
    Enabled = false,
    IdentityProviderMetadataFile = "string",
    FirstName = "string",
    FullName = "string",
    Group = "string",
    Email = "string",
    IdentityProviderMetadataText = "string",
    EntityId = "string",
    OrgSamlId = "string",
    Role = "string",
    Surname = "string",
    UserName = "string",
});

    example, err := vcd.NewOrgSaml(ctx, "orgSamlResource", &vcd.OrgSamlArgs{
	OrgId:                        pulumi.String("string"),
	Enabled:                      pulumi.Bool(false),
	IdentityProviderMetadataFile: pulumi.String("string"),
	FirstName:                    pulumi.String("string"),
	FullName:                     pulumi.String("string"),
	Group:                        pulumi.String("string"),
	Email:                        pulumi.String("string"),
	IdentityProviderMetadataText: pulumi.String("string"),
	EntityId:                     pulumi.String("string"),
	OrgSamlId:                    pulumi.String("string"),
	Role:                         pulumi.String("string"),
	Surname:                      pulumi.String("string"),
	UserName:                     pulumi.String("string"),
})

    var orgSamlResource = new OrgSaml("orgSamlResource", OrgSamlArgs.builder()
    .orgId("string")
    .enabled(false)
    .identityProviderMetadataFile("string")
    .firstName("string")
    .fullName("string")
    .group("string")
    .email("string")
    .identityProviderMetadataText("string")
    .entityId("string")
    .orgSamlId("string")
    .role("string")
    .surname("string")
    .userName("string")
    .build());

    org_saml_resource = vcd.OrgSaml("orgSamlResource",
    org_id="string",
    enabled=False,
    identity_provider_metadata_file="string",
    first_name="string",
    full_name="string",
    group="string",
    email="string",
    identity_provider_metadata_text="string",
    entity_id="string",
    org_saml_id="string",
    role="string",
    surname="string",
    user_name="string")

    const orgSamlResource = new vcd.OrgSaml("orgSamlResource", {
    orgId: "string",
    enabled: false,
    identityProviderMetadataFile: "string",
    firstName: "string",
    fullName: "string",
    group: "string",
    email: "string",
    identityProviderMetadataText: "string",
    entityId: "string",
    orgSamlId: "string",
    role: "string",
    surname: "string",
    userName: "string",
});

    type: vcd:OrgSaml
properties:
    email: string
    enabled: false
    entityId: string
    firstName: string
    fullName: string
    group: string
    identityProviderMetadataFile: string
    identityProviderMetadataText: string
    orgId: string
    orgSamlId: string
    role: string
    surname: string
    userName: string

    OrgSaml 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 OrgSaml resource accepts the following input properties:

    Enabled bool
    If true, the organization will use SAML for authentication
    OrgId string
    Since there is only one SAML configuration available for an organization, the resource can be identified by the Org itself
    Email string
    The name of the SAML attribute that returns the email address of the user
    EntityId string
    Your service provider entity ID. Once you set this field, it cannot be changed back to empty
    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
    IdentityProviderMetadataFile string
    Name of a file containing the metadata text from a SAML Identity Provider. Required if identity_provider_metadata_text is not defined
    IdentityProviderMetadataText string
    Text of the metadata text from a SAML Identity Provider. Required if identity_provider_metadata_file is not defined
    OrgSamlId 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
    Enabled bool
    If true, the organization will use SAML for authentication
    OrgId string
    Since there is only one SAML configuration available for an organization, the resource can be identified by the Org itself
    Email string
    The name of the SAML attribute that returns the email address of the user
    EntityId string
    Your service provider entity ID. Once you set this field, it cannot be changed back to empty
    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
    IdentityProviderMetadataFile string
    Name of a file containing the metadata text from a SAML Identity Provider. Required if identity_provider_metadata_text is not defined
    IdentityProviderMetadataText string
    Text of the metadata text from a SAML Identity Provider. Required if identity_provider_metadata_file is not defined
    OrgSamlId 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
    enabled Boolean
    If true, the organization will use SAML for authentication
    orgId String
    Since there is only one SAML configuration available for an organization, the resource can be identified by the Org itself
    email String
    The name of the SAML attribute that returns the email address of the user
    entityId String
    Your service provider entity ID. Once you set this field, it cannot be changed back to empty
    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
    identityProviderMetadataFile String
    Name of a file containing the metadata text from a SAML Identity Provider. Required if identity_provider_metadata_text is not defined
    identityProviderMetadataText String
    Text of the metadata text from a SAML Identity Provider. Required if identity_provider_metadata_file is not defined
    orgSamlId 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
    enabled boolean
    If true, the organization will use SAML for authentication
    orgId string
    Since there is only one SAML configuration available for an organization, the resource can be identified by the Org itself
    email string
    The name of the SAML attribute that returns the email address of the user
    entityId string
    Your service provider entity ID. Once you set this field, it cannot be changed back to empty
    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
    identityProviderMetadataFile string
    Name of a file containing the metadata text from a SAML Identity Provider. Required if identity_provider_metadata_text is not defined
    identityProviderMetadataText string
    Text of the metadata text from a SAML Identity Provider. Required if identity_provider_metadata_file is not defined
    orgSamlId 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
    enabled bool
    If true, the organization will use SAML for authentication
    org_id str
    Since there is only one SAML configuration available for an organization, the resource can be identified by the Org itself
    email str
    The name of the SAML attribute that returns the email address of the user
    entity_id str
    Your service provider entity ID. Once you set this field, it cannot be changed back to empty
    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
    identity_provider_metadata_file str
    Name of a file containing the metadata text from a SAML Identity Provider. Required if identity_provider_metadata_text is not defined
    identity_provider_metadata_text str
    Text of the metadata text from a SAML Identity Provider. Required if identity_provider_metadata_file is not defined
    org_saml_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
    enabled Boolean
    If true, the organization will use SAML for authentication
    orgId String
    Since there is only one SAML configuration available for an organization, the resource can be identified by the Org itself
    email String
    The name of the SAML attribute that returns the email address of the user
    entityId String
    Your service provider entity ID. Once you set this field, it cannot be changed back to empty
    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
    identityProviderMetadataFile String
    Name of a file containing the metadata text from a SAML Identity Provider. Required if identity_provider_metadata_text is not defined
    identityProviderMetadataText String
    Text of the metadata text from a SAML Identity Provider. Required if identity_provider_metadata_file is not defined
    orgSamlId 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

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing OrgSaml Resource

    Get an existing OrgSaml 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?: OrgSamlState, opts?: CustomResourceOptions): OrgSaml
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        email: Optional[str] = None,
        enabled: Optional[bool] = None,
        entity_id: Optional[str] = None,
        first_name: Optional[str] = None,
        full_name: Optional[str] = None,
        group: Optional[str] = None,
        identity_provider_metadata_file: Optional[str] = None,
        identity_provider_metadata_text: Optional[str] = None,
        org_id: Optional[str] = None,
        org_saml_id: Optional[str] = None,
        role: Optional[str] = None,
        surname: Optional[str] = None,
        user_name: Optional[str] = None) -> OrgSaml
    func GetOrgSaml(ctx *Context, name string, id IDInput, state *OrgSamlState, opts ...ResourceOption) (*OrgSaml, error)
    public static OrgSaml Get(string name, Input<string> id, OrgSamlState? state, CustomResourceOptions? opts = null)
    public static OrgSaml get(String name, Output<String> id, OrgSamlState state, CustomResourceOptions options)
    resources:  _:    type: vcd:OrgSaml    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:
    Email string
    The name of the SAML attribute that returns the email address of the user
    Enabled bool
    If true, the organization will use SAML for authentication
    EntityId string
    Your service provider entity ID. Once you set this field, it cannot be changed back to empty
    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
    IdentityProviderMetadataFile string
    Name of a file containing the metadata text from a SAML Identity Provider. Required if identity_provider_metadata_text is not defined
    IdentityProviderMetadataText string
    Text of the metadata text from a SAML Identity Provider. Required if identity_provider_metadata_file is not defined
    OrgId string
    Since there is only one SAML configuration available for an organization, the resource can be identified by the Org itself
    OrgSamlId 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
    If true, the organization will use SAML for authentication
    EntityId string
    Your service provider entity ID. Once you set this field, it cannot be changed back to empty
    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
    IdentityProviderMetadataFile string
    Name of a file containing the metadata text from a SAML Identity Provider. Required if identity_provider_metadata_text is not defined
    IdentityProviderMetadataText string
    Text of the metadata text from a SAML Identity Provider. Required if identity_provider_metadata_file is not defined
    OrgId string
    Since there is only one SAML configuration available for an organization, the resource can be identified by the Org itself
    OrgSamlId 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
    If true, the organization will use SAML for authentication
    entityId String
    Your service provider entity ID. Once you set this field, it cannot be changed back to empty
    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
    identityProviderMetadataFile String
    Name of a file containing the metadata text from a SAML Identity Provider. Required if identity_provider_metadata_text is not defined
    identityProviderMetadataText String
    Text of the metadata text from a SAML Identity Provider. Required if identity_provider_metadata_file is not defined
    orgId String
    Since there is only one SAML configuration available for an organization, the resource can be identified by the Org itself
    orgSamlId 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
    If true, the organization will use SAML for authentication
    entityId string
    Your service provider entity ID. Once you set this field, it cannot be changed back to empty
    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
    identityProviderMetadataFile string
    Name of a file containing the metadata text from a SAML Identity Provider. Required if identity_provider_metadata_text is not defined
    identityProviderMetadataText string
    Text of the metadata text from a SAML Identity Provider. Required if identity_provider_metadata_file is not defined
    orgId string
    Since there is only one SAML configuration available for an organization, the resource can be identified by the Org itself
    orgSamlId 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
    If true, the organization will use SAML for authentication
    entity_id str
    Your service provider entity ID. Once you set this field, it cannot be changed back to empty
    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
    identity_provider_metadata_file str
    Name of a file containing the metadata text from a SAML Identity Provider. Required if identity_provider_metadata_text is not defined
    identity_provider_metadata_text str
    Text of the metadata text from a SAML Identity Provider. Required if identity_provider_metadata_file is not defined
    org_id str
    Since there is only one SAML configuration available for an organization, the resource can be identified by the Org itself
    org_saml_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
    If true, the organization will use SAML for authentication
    entityId String
    Your service provider entity ID. Once you set this field, it cannot be changed back to empty
    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
    identityProviderMetadataFile String
    Name of a file containing the metadata text from a SAML Identity Provider. Required if identity_provider_metadata_text is not defined
    identityProviderMetadataText String
    Text of the metadata text from a SAML Identity Provider. Required if identity_provider_metadata_file is not defined
    orgId String
    Since there is only one SAML configuration available for an organization, the resource can be identified by the Org itself
    orgSamlId 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 logo
    vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
    vmware/terraform-provider-vcd