1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. iam
  6. SamlProvider
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine

    SAML identity provider is a user authentication service provider responsible for collecting and storing user identity data such as usernames and passwords. In access control (IAM), it is an entity that contains external identity provider metadata and provides identity management services.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcenginecc from "@volcengine/pulumi-volcenginecc";
    
    const iAMSamlProviderDemo = new volcenginecc.iam.SamlProvider("IAMSamlProviderDemo", {
        samlProviderName: "ccapi-test",
        description: "ccapi-test",
        encodedSamlMetadataDocument: "PD94bWwgdmVyc2lvbxxxxxx==",
        ssoType: 1,
        status: 1,
    });
    
    import pulumi
    import pulumi_volcenginecc as volcenginecc
    
    i_am_saml_provider_demo = volcenginecc.iam.SamlProvider("IAMSamlProviderDemo",
        saml_provider_name="ccapi-test",
        description="ccapi-test",
        encoded_saml_metadata_document="PD94bWwgdmVyc2lvbxxxxxx==",
        sso_type=1,
        status=1)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/iam"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := iam.NewSamlProvider(ctx, "IAMSamlProviderDemo", &iam.SamlProviderArgs{
    			SamlProviderName:            pulumi.String("ccapi-test"),
    			Description:                 pulumi.String("ccapi-test"),
    			EncodedSamlMetadataDocument: pulumi.String("PD94bWwgdmVyc2lvbxxxxxx=="),
    			SsoType:                     pulumi.Int(1),
    			Status:                      pulumi.Int(1),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcenginecc = Volcengine.Pulumi.Volcenginecc;
    
    return await Deployment.RunAsync(() => 
    {
        var iAMSamlProviderDemo = new Volcenginecc.Iam.SamlProvider("IAMSamlProviderDemo", new()
        {
            SamlProviderName = "ccapi-test",
            Description = "ccapi-test",
            EncodedSamlMetadataDocument = "PD94bWwgdmVyc2lvbxxxxxx==",
            SsoType = 1,
            Status = 1,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.volcengine.volcenginecc.iam.SamlProvider;
    import com.volcengine.volcenginecc.iam.SamlProviderArgs;
    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) {
            var iAMSamlProviderDemo = new SamlProvider("iAMSamlProviderDemo", SamlProviderArgs.builder()
                .samlProviderName("ccapi-test")
                .description("ccapi-test")
                .encodedSamlMetadataDocument("PD94bWwgdmVyc2lvbxxxxxx==")
                .ssoType(1)
                .status(1)
                .build());
    
        }
    }
    
    resources:
      iAMSamlProviderDemo:
        type: volcenginecc:iam:SamlProvider
        name: IAMSamlProviderDemo
        properties:
          samlProviderName: ccapi-test
          description: ccapi-test
          encodedSamlMetadataDocument: PD94bWwgdmVyc2lvbxxxxxx==
          ssoType: 1
          status: 1
    

    Create SamlProvider Resource

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

    Constructor syntax

    new SamlProvider(name: string, args: SamlProviderArgs, opts?: CustomResourceOptions);
    @overload
    def SamlProvider(resource_name: str,
                     args: SamlProviderArgs,
                     opts: Optional[ResourceOptions] = None)
    
    @overload
    def SamlProvider(resource_name: str,
                     opts: Optional[ResourceOptions] = None,
                     encoded_saml_metadata_document: Optional[str] = None,
                     saml_provider_name: Optional[str] = None,
                     sso_type: Optional[int] = None,
                     description: Optional[str] = None,
                     status: Optional[int] = None)
    func NewSamlProvider(ctx *Context, name string, args SamlProviderArgs, opts ...ResourceOption) (*SamlProvider, error)
    public SamlProvider(string name, SamlProviderArgs args, CustomResourceOptions? opts = null)
    public SamlProvider(String name, SamlProviderArgs args)
    public SamlProvider(String name, SamlProviderArgs args, CustomResourceOptions options)
    
    type: volcenginecc:iam:SamlProvider
    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 SamlProviderArgs
    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 SamlProviderArgs
    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 SamlProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SamlProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SamlProviderArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    EncodedSamlMetadataDocument string
    Base64 Encoded SAML Identity Provider Metadata File
    SamlProviderName string
    SAML Identity Provider Name
    SsoType int
    Identity Provider SSO Type 1. Role SSO 2. User SSO
    Description string
    SAML Identity Provider Description
    Status int
    Identity Provider Status (User SSO Only) 1. Enabled 2. Enabled and other login methods disabled 3. Disabled
    EncodedSamlMetadataDocument string
    Base64 Encoded SAML Identity Provider Metadata File
    SamlProviderName string
    SAML Identity Provider Name
    SsoType int
    Identity Provider SSO Type 1. Role SSO 2. User SSO
    Description string
    SAML Identity Provider Description
    Status int
    Identity Provider Status (User SSO Only) 1. Enabled 2. Enabled and other login methods disabled 3. Disabled
    encodedSamlMetadataDocument String
    Base64 Encoded SAML Identity Provider Metadata File
    samlProviderName String
    SAML Identity Provider Name
    ssoType Integer
    Identity Provider SSO Type 1. Role SSO 2. User SSO
    description String
    SAML Identity Provider Description
    status Integer
    Identity Provider Status (User SSO Only) 1. Enabled 2. Enabled and other login methods disabled 3. Disabled
    encodedSamlMetadataDocument string
    Base64 Encoded SAML Identity Provider Metadata File
    samlProviderName string
    SAML Identity Provider Name
    ssoType number
    Identity Provider SSO Type 1. Role SSO 2. User SSO
    description string
    SAML Identity Provider Description
    status number
    Identity Provider Status (User SSO Only) 1. Enabled 2. Enabled and other login methods disabled 3. Disabled
    encoded_saml_metadata_document str
    Base64 Encoded SAML Identity Provider Metadata File
    saml_provider_name str
    SAML Identity Provider Name
    sso_type int
    Identity Provider SSO Type 1. Role SSO 2. User SSO
    description str
    SAML Identity Provider Description
    status int
    Identity Provider Status (User SSO Only) 1. Enabled 2. Enabled and other login methods disabled 3. Disabled
    encodedSamlMetadataDocument String
    Base64 Encoded SAML Identity Provider Metadata File
    samlProviderName String
    SAML Identity Provider Name
    ssoType Number
    Identity Provider SSO Type 1. Role SSO 2. User SSO
    description String
    SAML Identity Provider Description
    status Number
    Identity Provider Status (User SSO Only) 1. Enabled 2. Enabled and other login methods disabled 3. Disabled

    Outputs

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

    CertificateExpireTime string
    SAML Certificate Expiration Reminder Time
    Certificates List<Volcengine.SamlProviderCertificate>
    CreateDate string
    Creation Time
    Id string
    The provider-assigned unique ID for this managed resource.
    Trn string
    Identity Provider Trn
    UpdateDate string
    Update Time
    CertificateExpireTime string
    SAML Certificate Expiration Reminder Time
    Certificates []SamlProviderCertificate
    CreateDate string
    Creation Time
    Id string
    The provider-assigned unique ID for this managed resource.
    Trn string
    Identity Provider Trn
    UpdateDate string
    Update Time
    certificateExpireTime String
    SAML Certificate Expiration Reminder Time
    certificates List<SamlProviderCertificate>
    createDate String
    Creation Time
    id String
    The provider-assigned unique ID for this managed resource.
    trn String
    Identity Provider Trn
    updateDate String
    Update Time
    certificateExpireTime string
    SAML Certificate Expiration Reminder Time
    certificates SamlProviderCertificate[]
    createDate string
    Creation Time
    id string
    The provider-assigned unique ID for this managed resource.
    trn string
    Identity Provider Trn
    updateDate string
    Update Time
    certificate_expire_time str
    SAML Certificate Expiration Reminder Time
    certificates Sequence[SamlProviderCertificate]
    create_date str
    Creation Time
    id str
    The provider-assigned unique ID for this managed resource.
    trn str
    Identity Provider Trn
    update_date str
    Update Time
    certificateExpireTime String
    SAML Certificate Expiration Reminder Time
    certificates List<Property Map>
    createDate String
    Creation Time
    id String
    The provider-assigned unique ID for this managed resource.
    trn String
    Identity Provider Trn
    updateDate String
    Update Time

    Look up Existing SamlProvider Resource

    Get an existing SamlProvider 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?: SamlProviderState, opts?: CustomResourceOptions): SamlProvider
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            certificate_expire_time: Optional[str] = None,
            certificates: Optional[Sequence[SamlProviderCertificateArgs]] = None,
            create_date: Optional[str] = None,
            description: Optional[str] = None,
            encoded_saml_metadata_document: Optional[str] = None,
            saml_provider_name: Optional[str] = None,
            sso_type: Optional[int] = None,
            status: Optional[int] = None,
            trn: Optional[str] = None,
            update_date: Optional[str] = None) -> SamlProvider
    func GetSamlProvider(ctx *Context, name string, id IDInput, state *SamlProviderState, opts ...ResourceOption) (*SamlProvider, error)
    public static SamlProvider Get(string name, Input<string> id, SamlProviderState? state, CustomResourceOptions? opts = null)
    public static SamlProvider get(String name, Output<String> id, SamlProviderState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:iam:SamlProvider    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:
    CertificateExpireTime string
    SAML Certificate Expiration Reminder Time
    Certificates List<Volcengine.SamlProviderCertificate>
    CreateDate string
    Creation Time
    Description string
    SAML Identity Provider Description
    EncodedSamlMetadataDocument string
    Base64 Encoded SAML Identity Provider Metadata File
    SamlProviderName string
    SAML Identity Provider Name
    SsoType int
    Identity Provider SSO Type 1. Role SSO 2. User SSO
    Status int
    Identity Provider Status (User SSO Only) 1. Enabled 2. Enabled and other login methods disabled 3. Disabled
    Trn string
    Identity Provider Trn
    UpdateDate string
    Update Time
    CertificateExpireTime string
    SAML Certificate Expiration Reminder Time
    Certificates []SamlProviderCertificateArgs
    CreateDate string
    Creation Time
    Description string
    SAML Identity Provider Description
    EncodedSamlMetadataDocument string
    Base64 Encoded SAML Identity Provider Metadata File
    SamlProviderName string
    SAML Identity Provider Name
    SsoType int
    Identity Provider SSO Type 1. Role SSO 2. User SSO
    Status int
    Identity Provider Status (User SSO Only) 1. Enabled 2. Enabled and other login methods disabled 3. Disabled
    Trn string
    Identity Provider Trn
    UpdateDate string
    Update Time
    certificateExpireTime String
    SAML Certificate Expiration Reminder Time
    certificates List<SamlProviderCertificate>
    createDate String
    Creation Time
    description String
    SAML Identity Provider Description
    encodedSamlMetadataDocument String
    Base64 Encoded SAML Identity Provider Metadata File
    samlProviderName String
    SAML Identity Provider Name
    ssoType Integer
    Identity Provider SSO Type 1. Role SSO 2. User SSO
    status Integer
    Identity Provider Status (User SSO Only) 1. Enabled 2. Enabled and other login methods disabled 3. Disabled
    trn String
    Identity Provider Trn
    updateDate String
    Update Time
    certificateExpireTime string
    SAML Certificate Expiration Reminder Time
    certificates SamlProviderCertificate[]
    createDate string
    Creation Time
    description string
    SAML Identity Provider Description
    encodedSamlMetadataDocument string
    Base64 Encoded SAML Identity Provider Metadata File
    samlProviderName string
    SAML Identity Provider Name
    ssoType number
    Identity Provider SSO Type 1. Role SSO 2. User SSO
    status number
    Identity Provider Status (User SSO Only) 1. Enabled 2. Enabled and other login methods disabled 3. Disabled
    trn string
    Identity Provider Trn
    updateDate string
    Update Time
    certificate_expire_time str
    SAML Certificate Expiration Reminder Time
    certificates Sequence[SamlProviderCertificateArgs]
    create_date str
    Creation Time
    description str
    SAML Identity Provider Description
    encoded_saml_metadata_document str
    Base64 Encoded SAML Identity Provider Metadata File
    saml_provider_name str
    SAML Identity Provider Name
    sso_type int
    Identity Provider SSO Type 1. Role SSO 2. User SSO
    status int
    Identity Provider Status (User SSO Only) 1. Enabled 2. Enabled and other login methods disabled 3. Disabled
    trn str
    Identity Provider Trn
    update_date str
    Update Time
    certificateExpireTime String
    SAML Certificate Expiration Reminder Time
    certificates List<Property Map>
    createDate String
    Creation Time
    description String
    SAML Identity Provider Description
    encodedSamlMetadataDocument String
    Base64 Encoded SAML Identity Provider Metadata File
    samlProviderName String
    SAML Identity Provider Name
    ssoType Number
    Identity Provider SSO Type 1. Role SSO 2. User SSO
    status Number
    Identity Provider Status (User SSO Only) 1. Enabled 2. Enabled and other login methods disabled 3. Disabled
    trn String
    Identity Provider Trn
    updateDate String
    Update Time

    Supporting Types

    SamlProviderCertificate, SamlProviderCertificateArgs

    CertificateId string
    Certificate ID
    CreateDate string
    Certificate Upload Time
    Issuer string
    Certificate Authority
    NotAfter string
    Certificate Expiration Time
    NotBefore string
    Certificate Validity Period
    SerialNumber string
    Certificate Serial Number
    SignatureAlgorithm string
    Certificate Signature Algorithm
    Subject string
    Certificate Subject
    UpdateDate string
    Certificate Update Time
    Version string
    Certificate Version
    CertificateId string
    Certificate ID
    CreateDate string
    Certificate Upload Time
    Issuer string
    Certificate Authority
    NotAfter string
    Certificate Expiration Time
    NotBefore string
    Certificate Validity Period
    SerialNumber string
    Certificate Serial Number
    SignatureAlgorithm string
    Certificate Signature Algorithm
    Subject string
    Certificate Subject
    UpdateDate string
    Certificate Update Time
    Version string
    Certificate Version
    certificateId String
    Certificate ID
    createDate String
    Certificate Upload Time
    issuer String
    Certificate Authority
    notAfter String
    Certificate Expiration Time
    notBefore String
    Certificate Validity Period
    serialNumber String
    Certificate Serial Number
    signatureAlgorithm String
    Certificate Signature Algorithm
    subject String
    Certificate Subject
    updateDate String
    Certificate Update Time
    version String
    Certificate Version
    certificateId string
    Certificate ID
    createDate string
    Certificate Upload Time
    issuer string
    Certificate Authority
    notAfter string
    Certificate Expiration Time
    notBefore string
    Certificate Validity Period
    serialNumber string
    Certificate Serial Number
    signatureAlgorithm string
    Certificate Signature Algorithm
    subject string
    Certificate Subject
    updateDate string
    Certificate Update Time
    version string
    Certificate Version
    certificate_id str
    Certificate ID
    create_date str
    Certificate Upload Time
    issuer str
    Certificate Authority
    not_after str
    Certificate Expiration Time
    not_before str
    Certificate Validity Period
    serial_number str
    Certificate Serial Number
    signature_algorithm str
    Certificate Signature Algorithm
    subject str
    Certificate Subject
    update_date str
    Certificate Update Time
    version str
    Certificate Version
    certificateId String
    Certificate ID
    createDate String
    Certificate Upload Time
    issuer String
    Certificate Authority
    notAfter String
    Certificate Expiration Time
    notBefore String
    Certificate Validity Period
    serialNumber String
    Certificate Serial Number
    signatureAlgorithm String
    Certificate Signature Algorithm
    subject String
    Certificate Subject
    updateDate String
    Certificate Update Time
    version String
    Certificate Version

    Import

    $ pulumi import volcenginecc:iam/samlProvider:SamlProvider example "saml_provider_name"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
      Try Pulumi Cloud free. Your team will thank you.