Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Cyral Provider
  3. API Docs
  4. IntegrationIdpSaml
cyral 4.16.3 published on Monday, Apr 14, 2025 by cyralinc
cyralinc/terraform-provider-cyral

cyral.IntegrationIdpSaml

Explore with Pulumi AI

cyral logo
cyral 4.16.3 published on Monday, Apr 14, 2025 by cyralinc
cyralinc/terraform-provider-cyral

    Example Usage

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

const exampleDraft = new cyral.IntegrationIdpSamlDraft("exampleDraft", {
    displayName: "example-okta-integration",
    idpType: "okta",
});
// Here goes IdP provider configuration to obtain SAML
// metadata. Use the attribute `sp_metadata` of the SAML
// draft above to obtain the Cyral SP SAML metadata you will
// need to provide your IdP with.
//
// ...
//#
const exampleIntegration = new cyral.IntegrationIdpSaml("exampleIntegration", {
    samlDraftId: exampleDraft.id,
    idpMetadataUrl: "https://dev-123456.okta.com/app/1234567890/sso/saml/metadata",
});

    import pulumi
import pulumi_cyral as cyral

example_draft = cyral.IntegrationIdpSamlDraft("exampleDraft",
    display_name="example-okta-integration",
    idp_type="okta")
# Here goes IdP provider configuration to obtain SAML
# metadata. Use the attribute `sp_metadata` of the SAML
# draft above to obtain the Cyral SP SAML metadata you will
# need to provide your IdP with.
#
# ...
##
example_integration = cyral.IntegrationIdpSaml("exampleIntegration",
    saml_draft_id=example_draft.id,
    idp_metadata_url="https://dev-123456.okta.com/app/1234567890/sso/saml/metadata")

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/cyral/v4/cyral"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		exampleDraft, err := cyral.NewIntegrationIdpSamlDraft(ctx, "exampleDraft", &cyral.IntegrationIdpSamlDraftArgs{
			DisplayName: pulumi.String("example-okta-integration"),
			IdpType:     pulumi.String("okta"),
		})
		if err != nil {
			return err
		}
		_, err = cyral.NewIntegrationIdpSaml(ctx, "exampleIntegration", &cyral.IntegrationIdpSamlArgs{
			SamlDraftId:    exampleDraft.ID(),
			IdpMetadataUrl: pulumi.String("https://dev-123456.okta.com/app/1234567890/sso/saml/metadata"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var exampleDraft = new Cyral.IntegrationIdpSamlDraft("exampleDraft", new()
    {
        DisplayName = "example-okta-integration",
        IdpType = "okta",
    });

    // Here goes IdP provider configuration to obtain SAML
    // metadata. Use the attribute `sp_metadata` of the SAML
    // draft above to obtain the Cyral SP SAML metadata you will
    // need to provide your IdP with.
    //
    // ...
    //#
    var exampleIntegration = new Cyral.IntegrationIdpSaml("exampleIntegration", new()
    {
        SamlDraftId = exampleDraft.Id,
        IdpMetadataUrl = "https://dev-123456.okta.com/app/1234567890/sso/saml/metadata",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.cyral.IntegrationIdpSamlDraft;
import com.pulumi.cyral.IntegrationIdpSamlDraftArgs;
import com.pulumi.cyral.IntegrationIdpSaml;
import com.pulumi.cyral.IntegrationIdpSamlArgs;
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 exampleDraft = new IntegrationIdpSamlDraft("exampleDraft", IntegrationIdpSamlDraftArgs.builder()
            .displayName("example-okta-integration")
            .idpType("okta")
            .build());

        // Here goes IdP provider configuration to obtain SAML
        // metadata. Use the attribute `sp_metadata` of the SAML
        // draft above to obtain the Cyral SP SAML metadata you will
        // need to provide your IdP with.
        //
        // ...
        //#
        var exampleIntegration = new IntegrationIdpSaml("exampleIntegration", IntegrationIdpSamlArgs.builder()
            .samlDraftId(exampleDraft.id())
            .idpMetadataUrl("https://dev-123456.okta.com/app/1234567890/sso/saml/metadata")
            .build());

    }
}

    resources:
  exampleDraft: # Here goes IdP provider configuration to obtain SAML
  # metadata. Use the attribute `sp_metadata` of the SAML
  # draft above to obtain the Cyral SP SAML metadata you will
  # need to provide your IdP with.
  #
  # ...
  ##
    type: cyral:IntegrationIdpSamlDraft
    properties:
      displayName: example-okta-integration
      idpType: okta
  exampleIntegration:
    type: cyral:IntegrationIdpSaml
    properties:
      samlDraftId: ${exampleDraft.id}
      # This is the IdP metadata URL. You may choose instead to
      #   # provide the base64-encoded metadata XML document using
      #   # the argument `idp_metadata_document`.
      idpMetadataUrl: https://dev-123456.okta.com/app/1234567890/sso/saml/metadata

    Create IntegrationIdpSaml Resource

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

    Constructor syntax

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

@overload
def IntegrationIdpSaml(resource_name: str,
                       opts: Optional[ResourceOptions] = None,
                       saml_draft_id: Optional[str] = None,
                       idp_metadata_url: Optional[str] = None,
                       idp_metadata_xml: Optional[str] = None)
    func NewIntegrationIdpSaml(ctx *Context, name string, args IntegrationIdpSamlArgs, opts ...ResourceOption) (*IntegrationIdpSaml, error)
    public IntegrationIdpSaml(string name, IntegrationIdpSamlArgs args, CustomResourceOptions? opts = null)
    public IntegrationIdpSaml(String name, IntegrationIdpSamlArgs args)
public IntegrationIdpSaml(String name, IntegrationIdpSamlArgs args, CustomResourceOptions options)

    type: cyral:IntegrationIdpSaml
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 IntegrationIdpSamlArgs
    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 IntegrationIdpSamlArgs
    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 IntegrationIdpSamlArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IntegrationIdpSamlArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IntegrationIdpSamlArgs
    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 integrationIdpSamlResource = new Cyral.IntegrationIdpSaml("integrationIdpSamlResource", new()
{
    SamlDraftId = "string",
    IdpMetadataUrl = "string",
    IdpMetadataXml = "string",
});

    example, err := cyral.NewIntegrationIdpSaml(ctx, "integrationIdpSamlResource", &cyral.IntegrationIdpSamlArgs{
	SamlDraftId:    pulumi.String("string"),
	IdpMetadataUrl: pulumi.String("string"),
	IdpMetadataXml: pulumi.String("string"),
})

    var integrationIdpSamlResource = new IntegrationIdpSaml("integrationIdpSamlResource", IntegrationIdpSamlArgs.builder()
    .samlDraftId("string")
    .idpMetadataUrl("string")
    .idpMetadataXml("string")
    .build());

    integration_idp_saml_resource = cyral.IntegrationIdpSaml("integrationIdpSamlResource",
    saml_draft_id="string",
    idp_metadata_url="string",
    idp_metadata_xml="string")

    const integrationIdpSamlResource = new cyral.IntegrationIdpSaml("integrationIdpSamlResource", {
    samlDraftId: "string",
    idpMetadataUrl: "string",
    idpMetadataXml: "string",
});

    type: cyral:IntegrationIdpSaml
properties:
    idpMetadataUrl: string
    idpMetadataXml: string
    samlDraftId: string

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

    SamlDraftId string
    A valid id for a SAML Draft. Must be at least 5 character long. See attribute id in resource cyral.IntegrationIdpSamlDraft.
    IdpMetadataUrl string
    The web address of an IdP SAML Metadata XML document. Conflicts with idp_metadata_xml.
    IdpMetadataXml string
    Full SAML metadata XML document. Must be base64 encoded. Conflicts with idp_metadata_url.
    SamlDraftId string
    A valid id for a SAML Draft. Must be at least 5 character long. See attribute id in resource cyral.IntegrationIdpSamlDraft.
    IdpMetadataUrl string
    The web address of an IdP SAML Metadata XML document. Conflicts with idp_metadata_xml.
    IdpMetadataXml string
    Full SAML metadata XML document. Must be base64 encoded. Conflicts with idp_metadata_url.
    samlDraftId String
    A valid id for a SAML Draft. Must be at least 5 character long. See attribute id in resource cyral.IntegrationIdpSamlDraft.
    idpMetadataUrl String
    The web address of an IdP SAML Metadata XML document. Conflicts with idp_metadata_xml.
    idpMetadataXml String
    Full SAML metadata XML document. Must be base64 encoded. Conflicts with idp_metadata_url.
    samlDraftId string
    A valid id for a SAML Draft. Must be at least 5 character long. See attribute id in resource cyral.IntegrationIdpSamlDraft.
    idpMetadataUrl string
    The web address of an IdP SAML Metadata XML document. Conflicts with idp_metadata_xml.
    idpMetadataXml string
    Full SAML metadata XML document. Must be base64 encoded. Conflicts with idp_metadata_url.
    saml_draft_id str
    A valid id for a SAML Draft. Must be at least 5 character long. See attribute id in resource cyral.IntegrationIdpSamlDraft.
    idp_metadata_url str
    The web address of an IdP SAML Metadata XML document. Conflicts with idp_metadata_xml.
    idp_metadata_xml str
    Full SAML metadata XML document. Must be base64 encoded. Conflicts with idp_metadata_url.
    samlDraftId String
    A valid id for a SAML Draft. Must be at least 5 character long. See attribute id in resource cyral.IntegrationIdpSamlDraft.
    idpMetadataUrl String
    The web address of an IdP SAML Metadata XML document. Conflicts with idp_metadata_xml.
    idpMetadataXml String
    Full SAML metadata XML document. Must be base64 encoded. Conflicts with idp_metadata_url.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    SingleSignOnServiceUrl string
    The IdP’s Single Sign-on Service (SSO) URL, where Cyral SP will send SAML AuthnRequests via SAML-POST binding.
    Id string
    The provider-assigned unique ID for this managed resource.
    SingleSignOnServiceUrl string
    The IdP’s Single Sign-on Service (SSO) URL, where Cyral SP will send SAML AuthnRequests via SAML-POST binding.
    id String
    The provider-assigned unique ID for this managed resource.
    singleSignOnServiceUrl String
    The IdP’s Single Sign-on Service (SSO) URL, where Cyral SP will send SAML AuthnRequests via SAML-POST binding.
    id string
    The provider-assigned unique ID for this managed resource.
    singleSignOnServiceUrl string
    The IdP’s Single Sign-on Service (SSO) URL, where Cyral SP will send SAML AuthnRequests via SAML-POST binding.
    id str
    The provider-assigned unique ID for this managed resource.
    single_sign_on_service_url str
    The IdP’s Single Sign-on Service (SSO) URL, where Cyral SP will send SAML AuthnRequests via SAML-POST binding.
    id String
    The provider-assigned unique ID for this managed resource.
    singleSignOnServiceUrl String
    The IdP’s Single Sign-on Service (SSO) URL, where Cyral SP will send SAML AuthnRequests via SAML-POST binding.

    Look up Existing IntegrationIdpSaml Resource

    Get an existing IntegrationIdpSaml 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?: IntegrationIdpSamlState, opts?: CustomResourceOptions): IntegrationIdpSaml
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        idp_metadata_url: Optional[str] = None,
        idp_metadata_xml: Optional[str] = None,
        saml_draft_id: Optional[str] = None,
        single_sign_on_service_url: Optional[str] = None) -> IntegrationIdpSaml
    func GetIntegrationIdpSaml(ctx *Context, name string, id IDInput, state *IntegrationIdpSamlState, opts ...ResourceOption) (*IntegrationIdpSaml, error)
    public static IntegrationIdpSaml Get(string name, Input<string> id, IntegrationIdpSamlState? state, CustomResourceOptions? opts = null)
    public static IntegrationIdpSaml get(String name, Output<String> id, IntegrationIdpSamlState state, CustomResourceOptions options)
    resources:  _:    type: cyral:IntegrationIdpSaml    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:
    IdpMetadataUrl string
    The web address of an IdP SAML Metadata XML document. Conflicts with idp_metadata_xml.
    IdpMetadataXml string
    Full SAML metadata XML document. Must be base64 encoded. Conflicts with idp_metadata_url.
    SamlDraftId string
    A valid id for a SAML Draft. Must be at least 5 character long. See attribute id in resource cyral.IntegrationIdpSamlDraft.
    SingleSignOnServiceUrl string
    The IdP’s Single Sign-on Service (SSO) URL, where Cyral SP will send SAML AuthnRequests via SAML-POST binding.
    IdpMetadataUrl string
    The web address of an IdP SAML Metadata XML document. Conflicts with idp_metadata_xml.
    IdpMetadataXml string
    Full SAML metadata XML document. Must be base64 encoded. Conflicts with idp_metadata_url.
    SamlDraftId string
    A valid id for a SAML Draft. Must be at least 5 character long. See attribute id in resource cyral.IntegrationIdpSamlDraft.
    SingleSignOnServiceUrl string
    The IdP’s Single Sign-on Service (SSO) URL, where Cyral SP will send SAML AuthnRequests via SAML-POST binding.
    idpMetadataUrl String
    The web address of an IdP SAML Metadata XML document. Conflicts with idp_metadata_xml.
    idpMetadataXml String
    Full SAML metadata XML document. Must be base64 encoded. Conflicts with idp_metadata_url.
    samlDraftId String
    A valid id for a SAML Draft. Must be at least 5 character long. See attribute id in resource cyral.IntegrationIdpSamlDraft.
    singleSignOnServiceUrl String
    The IdP’s Single Sign-on Service (SSO) URL, where Cyral SP will send SAML AuthnRequests via SAML-POST binding.
    idpMetadataUrl string
    The web address of an IdP SAML Metadata XML document. Conflicts with idp_metadata_xml.
    idpMetadataXml string
    Full SAML metadata XML document. Must be base64 encoded. Conflicts with idp_metadata_url.
    samlDraftId string
    A valid id for a SAML Draft. Must be at least 5 character long. See attribute id in resource cyral.IntegrationIdpSamlDraft.
    singleSignOnServiceUrl string
    The IdP’s Single Sign-on Service (SSO) URL, where Cyral SP will send SAML AuthnRequests via SAML-POST binding.
    idp_metadata_url str
    The web address of an IdP SAML Metadata XML document. Conflicts with idp_metadata_xml.
    idp_metadata_xml str
    Full SAML metadata XML document. Must be base64 encoded. Conflicts with idp_metadata_url.
    saml_draft_id str
    A valid id for a SAML Draft. Must be at least 5 character long. See attribute id in resource cyral.IntegrationIdpSamlDraft.
    single_sign_on_service_url str
    The IdP’s Single Sign-on Service (SSO) URL, where Cyral SP will send SAML AuthnRequests via SAML-POST binding.
    idpMetadataUrl String
    The web address of an IdP SAML Metadata XML document. Conflicts with idp_metadata_xml.
    idpMetadataXml String
    Full SAML metadata XML document. Must be base64 encoded. Conflicts with idp_metadata_url.
    samlDraftId String
    A valid id for a SAML Draft. Must be at least 5 character long. See attribute id in resource cyral.IntegrationIdpSamlDraft.
    singleSignOnServiceUrl String
    The IdP’s Single Sign-on Service (SSO) URL, where Cyral SP will send SAML AuthnRequests via SAML-POST binding.

    Package Details

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