Sign in Dashboard Get started
  1. Packages
  2. Packages
  3. Pulumi Cloud (Pulumi Service provider)
  4. API Docs
  5. api
  6. api/auth
  7. SAML

This provider is currently in preview.

Viewing docs for Pulumi Cloud v1.1.0
published on Thursday, May 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-pulumiservice

pulumiservice.api/auth.SAML

pulumiservice logo

This provider is currently in preview.

Viewing docs for Pulumi Cloud v1.1.0
published on Thursday, May 21, 2026 by Pulumi
Schema (JSON)
pulumi/pulumi-pulumiservice

    Updates the SAML configuration for a SAML-backed organization, including the identity provider SSO descriptor, attribute mappings, and other SAML settings. The new IDP SSO descriptor is required in the update request.

    Create SAML Resource

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

    Constructor syntax

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

@overload
def SAML(resource_name: str,
         opts: Optional[ResourceOptions] = None,
         org_name: Optional[str] = None,
         new_idp_sso_descriptor: Optional[str] = None)
    func NewSAML(ctx *Context, name string, args SAMLArgs, opts ...ResourceOption) (*SAML, error)
    public SAML(string name, SAMLArgs args, CustomResourceOptions? opts = null)
    public SAML(String name, SAMLArgs args)
public SAML(String name, SAMLArgs args, CustomResourceOptions options)

    type: pulumiservice:api/auth:SAML
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.


    resource "pulumiservice_api_auth_saml" "name" {
    # resource properties
}

    Parameters

    name string
    The unique name of the resource.
    args SAMLArgs
    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 SAMLArgs
    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 SAMLArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SAMLArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SAMLArgs
    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 samlResource = new PulumiService.Api.Auth.SAML("samlResource", new()
{
    OrgName = "string",
    NewIdpSsoDescriptor = "string",
});

    example, err := auth.NewSAML(ctx, "samlResource", &auth.SAMLArgs{
	OrgName:             pulumi.String("string"),
	NewIdpSsoDescriptor: pulumi.String("string"),
})

    resource "pulumiservice_api_auth_saml" "samlResource" {
  org_name               = "string"
  new_idp_sso_descriptor = "string"
}

    var samlResource = new SAML("samlResource", SAMLArgs.builder()
    .orgName("string")
    .newIdpSsoDescriptor("string")
    .build());

    saml_resource = pulumiservice.api.auth.SAML("samlResource",
    org_name="string",
    new_idp_sso_descriptor="string")

    const samlResource = new pulumiservice.api.auth.SAML("samlResource", {
    orgName: "string",
    newIdpSsoDescriptor: "string",
});

    type: pulumiservice:api/auth:SAML
properties:
    newIdpSsoDescriptor: string
    orgName: string

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

    OrgName string
    The organization name
    NewIdpSsoDescriptor string
    The new IDP SSO descriptor XML for the SAML configuration.
    OrgName string
    The organization name
    NewIdpSsoDescriptor string
    The new IDP SSO descriptor XML for the SAML configuration.
    org_name string
    The organization name
    new_idp_sso_descriptor string
    The new IDP SSO descriptor XML for the SAML configuration.
    orgName String
    The organization name
    newIdpSsoDescriptor String
    The new IDP SSO descriptor XML for the SAML configuration.
    orgName string
    The organization name
    newIdpSsoDescriptor string
    The new IDP SSO descriptor XML for the SAML configuration.
    org_name str
    The organization name
    new_idp_sso_descriptor str
    The new IDP SSO descriptor XML for the SAML configuration.
    orgName String
    The organization name
    newIdpSsoDescriptor String
    The new IDP SSO descriptor XML for the SAML configuration.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    IdpSsoDescriptor string
    The SAML Identity Provider SSO descriptor XML.
    Organization object
    The Pulumi organization.
    EntityId string
    The following fields can be empty if the metadata (IDPSSODescriptor) itself is empty for the organization.
    NameIdFormat string
    The SAML NameID format used by the identity provider.
    SsoUrl string
    The SSO URL for the identity provider.
    ValidUntil string
    ValidUntil is the date until which the X.509 Certificate issued to the organization by the identity provider is valid.
    ValidationError string
    ValidationError will be set only if there is an error validating the SAML org's metadata XML.
    Id string
    The provider-assigned unique ID for this managed resource.
    IdpSsoDescriptor string
    The SAML Identity Provider SSO descriptor XML.
    Organization interface{}
    The Pulumi organization.
    EntityId string
    The following fields can be empty if the metadata (IDPSSODescriptor) itself is empty for the organization.
    NameIdFormat string
    The SAML NameID format used by the identity provider.
    SsoUrl string
    The SSO URL for the identity provider.
    ValidUntil string
    ValidUntil is the date until which the X.509 Certificate issued to the organization by the identity provider is valid.
    ValidationError string
    ValidationError will be set only if there is an error validating the SAML org's metadata XML.
    id string
    The provider-assigned unique ID for this managed resource.
    idp_sso_descriptor string
    The SAML Identity Provider SSO descriptor XML.
    organization any
    The Pulumi organization.
    entity_id string
    The following fields can be empty if the metadata (IDPSSODescriptor) itself is empty for the organization.
    name_id_format string
    The SAML NameID format used by the identity provider.
    sso_url string
    The SSO URL for the identity provider.
    valid_until string
    ValidUntil is the date until which the X.509 Certificate issued to the organization by the identity provider is valid.
    validation_error string
    ValidationError will be set only if there is an error validating the SAML org's metadata XML.
    id String
    The provider-assigned unique ID for this managed resource.
    idpSsoDescriptor String
    The SAML Identity Provider SSO descriptor XML.
    organization Object
    The Pulumi organization.
    entityId String
    The following fields can be empty if the metadata (IDPSSODescriptor) itself is empty for the organization.
    nameIdFormat String
    The SAML NameID format used by the identity provider.
    ssoUrl String
    The SSO URL for the identity provider.
    validUntil String
    ValidUntil is the date until which the X.509 Certificate issued to the organization by the identity provider is valid.
    validationError String
    ValidationError will be set only if there is an error validating the SAML org's metadata XML.
    id string
    The provider-assigned unique ID for this managed resource.
    idpSsoDescriptor string
    The SAML Identity Provider SSO descriptor XML.
    organization any
    The Pulumi organization.
    entityId string
    The following fields can be empty if the metadata (IDPSSODescriptor) itself is empty for the organization.
    nameIdFormat string
    The SAML NameID format used by the identity provider.
    ssoUrl string
    The SSO URL for the identity provider.
    validUntil string
    ValidUntil is the date until which the X.509 Certificate issued to the organization by the identity provider is valid.
    validationError string
    ValidationError will be set only if there is an error validating the SAML org's metadata XML.
    id str
    The provider-assigned unique ID for this managed resource.
    idp_sso_descriptor str
    The SAML Identity Provider SSO descriptor XML.
    organization Any
    The Pulumi organization.
    entity_id str
    The following fields can be empty if the metadata (IDPSSODescriptor) itself is empty for the organization.
    name_id_format str
    The SAML NameID format used by the identity provider.
    sso_url str
    The SSO URL for the identity provider.
    valid_until str
    ValidUntil is the date until which the X.509 Certificate issued to the organization by the identity provider is valid.
    validation_error str
    ValidationError will be set only if there is an error validating the SAML org's metadata XML.
    id String
    The provider-assigned unique ID for this managed resource.
    idpSsoDescriptor String
    The SAML Identity Provider SSO descriptor XML.
    organization Any
    The Pulumi organization.
    entityId String
    The following fields can be empty if the metadata (IDPSSODescriptor) itself is empty for the organization.
    nameIdFormat String
    The SAML NameID format used by the identity provider.
    ssoUrl String
    The SSO URL for the identity provider.
    validUntil String
    ValidUntil is the date until which the X.509 Certificate issued to the organization by the identity provider is valid.
    validationError String
    ValidationError will be set only if there is an error validating the SAML org's metadata XML.

    Package Details

    Repository
    pulumiservice pulumi/pulumi-pulumiservice
    License
    Apache-2.0
    pulumiservice logo

    This provider is currently in preview.

    Viewing docs for Pulumi Cloud v1.1.0
    published on Thursday, May 21, 2026 by Pulumi
    Schema (JSON)
    pulumi/pulumi-pulumiservice

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial