cyral.IntegrationIdpSamlDraft
Explore with Pulumi AI
# cyral.IntegrationIdpSamlDraft (Resource)
Manages SAML IdP integration drafts.
See also the remaining SAML-related resources and data sources.
If using this resource in conjunction with
cyral.IntegrationIdpSaml
, please see the note at the beginning of cyral_integration_idp_saml.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as cyral from "@pulumi/cyral";
const exampleDraft = new cyral.IntegrationIdpSamlDraft("exampleDraft", {
attributes: {
email: "some-email",
firstName: "some-first-name",
groups: "some-group",
lastName: "some-last-name",
},
disableIdpInitiatedLogin: false,
displayName: "example-okta-integration",
idpType: "okta",
});
import pulumi
import pulumi_cyral as cyral
example_draft = cyral.IntegrationIdpSamlDraft("exampleDraft",
attributes={
"email": "some-email",
"first_name": "some-first-name",
"groups": "some-group",
"last_name": "some-last-name",
},
disable_idp_initiated_login=False,
display_name="example-okta-integration",
idp_type="okta")
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 {
_, err := cyral.NewIntegrationIdpSamlDraft(ctx, "exampleDraft", &cyral.IntegrationIdpSamlDraftArgs{
Attributes: &cyral.IntegrationIdpSamlDraftAttributesArgs{
Email: pulumi.String("some-email"),
FirstName: pulumi.String("some-first-name"),
Groups: pulumi.String("some-group"),
LastName: pulumi.String("some-last-name"),
},
DisableIdpInitiatedLogin: pulumi.Bool(false),
DisplayName: pulumi.String("example-okta-integration"),
IdpType: pulumi.String("okta"),
})
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()
{
Attributes = new Cyral.Inputs.IntegrationIdpSamlDraftAttributesArgs
{
Email = "some-email",
FirstName = "some-first-name",
Groups = "some-group",
LastName = "some-last-name",
},
DisableIdpInitiatedLogin = false,
DisplayName = "example-okta-integration",
IdpType = "okta",
});
});
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.inputs.IntegrationIdpSamlDraftAttributesArgs;
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()
.attributes(IntegrationIdpSamlDraftAttributesArgs.builder()
.email("some-email")
.firstName("some-first-name")
.groups("some-group")
.lastName("some-last-name")
.build())
.disableIdpInitiatedLogin(false)
.displayName("example-okta-integration")
.idpType("okta")
.build());
}
}
resources:
exampleDraft:
type: cyral:IntegrationIdpSamlDraft
properties:
attributes:
email: some-email
firstName: some-first-name
groups: some-group
lastName: some-last-name
disableIdpInitiatedLogin: false
displayName: example-okta-integration
idpType: okta
Create IntegrationIdpSamlDraft Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new IntegrationIdpSamlDraft(name: string, args: IntegrationIdpSamlDraftArgs, opts?: CustomResourceOptions);
@overload
def IntegrationIdpSamlDraft(resource_name: str,
args: IntegrationIdpSamlDraftArgs,
opts: Optional[ResourceOptions] = None)
@overload
def IntegrationIdpSamlDraft(resource_name: str,
opts: Optional[ResourceOptions] = None,
display_name: Optional[str] = None,
attributes: Optional[IntegrationIdpSamlDraftAttributesArgs] = None,
disable_idp_initiated_login: Optional[bool] = None,
idp_type: Optional[str] = None)
func NewIntegrationIdpSamlDraft(ctx *Context, name string, args IntegrationIdpSamlDraftArgs, opts ...ResourceOption) (*IntegrationIdpSamlDraft, error)
public IntegrationIdpSamlDraft(string name, IntegrationIdpSamlDraftArgs args, CustomResourceOptions? opts = null)
public IntegrationIdpSamlDraft(String name, IntegrationIdpSamlDraftArgs args)
public IntegrationIdpSamlDraft(String name, IntegrationIdpSamlDraftArgs args, CustomResourceOptions options)
type: cyral:IntegrationIdpSamlDraft
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 IntegrationIdpSamlDraftArgs
- 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 IntegrationIdpSamlDraftArgs
- 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 IntegrationIdpSamlDraftArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args IntegrationIdpSamlDraftArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args IntegrationIdpSamlDraftArgs
- 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 integrationIdpSamlDraftResource = new Cyral.IntegrationIdpSamlDraft("integrationIdpSamlDraftResource", new()
{
DisplayName = "string",
Attributes = new Cyral.Inputs.IntegrationIdpSamlDraftAttributesArgs
{
Email = "string",
FirstName = "string",
Groups = "string",
LastName = "string",
},
DisableIdpInitiatedLogin = false,
IdpType = "string",
});
example, err := cyral.NewIntegrationIdpSamlDraft(ctx, "integrationIdpSamlDraftResource", &cyral.IntegrationIdpSamlDraftArgs{
DisplayName: pulumi.String("string"),
Attributes: &cyral.IntegrationIdpSamlDraftAttributesArgs{
Email: pulumi.String("string"),
FirstName: pulumi.String("string"),
Groups: pulumi.String("string"),
LastName: pulumi.String("string"),
},
DisableIdpInitiatedLogin: pulumi.Bool(false),
IdpType: pulumi.String("string"),
})
var integrationIdpSamlDraftResource = new IntegrationIdpSamlDraft("integrationIdpSamlDraftResource", IntegrationIdpSamlDraftArgs.builder()
.displayName("string")
.attributes(IntegrationIdpSamlDraftAttributesArgs.builder()
.email("string")
.firstName("string")
.groups("string")
.lastName("string")
.build())
.disableIdpInitiatedLogin(false)
.idpType("string")
.build());
integration_idp_saml_draft_resource = cyral.IntegrationIdpSamlDraft("integrationIdpSamlDraftResource",
display_name="string",
attributes={
"email": "string",
"first_name": "string",
"groups": "string",
"last_name": "string",
},
disable_idp_initiated_login=False,
idp_type="string")
const integrationIdpSamlDraftResource = new cyral.IntegrationIdpSamlDraft("integrationIdpSamlDraftResource", {
displayName: "string",
attributes: {
email: "string",
firstName: "string",
groups: "string",
lastName: "string",
},
disableIdpInitiatedLogin: false,
idpType: "string",
});
type: cyral:IntegrationIdpSamlDraft
properties:
attributes:
email: string
firstName: string
groups: string
lastName: string
disableIdpInitiatedLogin: false
displayName: string
idpType: string
IntegrationIdpSamlDraft 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 IntegrationIdpSamlDraft resource accepts the following input properties:
- Display
Name string - Display name used in the Cyral control plane.
- Attributes
Integration
Idp Saml Draft Attributes - SAML Attribute names for the identity attributes required by the Cyral SP. Each attribute name MUST be at least 3 characters long.
- Disable
Idp boolInitiated Login - Whether or not IdP-Initiated login should be disabled for this generic SAML integration draft. Defaults to
false
. - Idp
Type string - Identity provider type. The value provided can be used as a filter when retrieving SAML integrations. See data source
cyral.IntegrationIdpSaml
.
- Display
Name string - Display name used in the Cyral control plane.
- Attributes
Integration
Idp Saml Draft Attributes Args - SAML Attribute names for the identity attributes required by the Cyral SP. Each attribute name MUST be at least 3 characters long.
- Disable
Idp boolInitiated Login - Whether or not IdP-Initiated login should be disabled for this generic SAML integration draft. Defaults to
false
. - Idp
Type string - Identity provider type. The value provided can be used as a filter when retrieving SAML integrations. See data source
cyral.IntegrationIdpSaml
.
- display
Name String - Display name used in the Cyral control plane.
- attributes
Integration
Idp Saml Draft Attributes - SAML Attribute names for the identity attributes required by the Cyral SP. Each attribute name MUST be at least 3 characters long.
- disable
Idp BooleanInitiated Login - Whether or not IdP-Initiated login should be disabled for this generic SAML integration draft. Defaults to
false
. - idp
Type String - Identity provider type. The value provided can be used as a filter when retrieving SAML integrations. See data source
cyral.IntegrationIdpSaml
.
- display
Name string - Display name used in the Cyral control plane.
- attributes
Integration
Idp Saml Draft Attributes - SAML Attribute names for the identity attributes required by the Cyral SP. Each attribute name MUST be at least 3 characters long.
- disable
Idp booleanInitiated Login - Whether or not IdP-Initiated login should be disabled for this generic SAML integration draft. Defaults to
false
. - idp
Type string - Identity provider type. The value provided can be used as a filter when retrieving SAML integrations. See data source
cyral.IntegrationIdpSaml
.
- display_
name str - Display name used in the Cyral control plane.
- attributes
Integration
Idp Saml Draft Attributes Args - SAML Attribute names for the identity attributes required by the Cyral SP. Each attribute name MUST be at least 3 characters long.
- disable_
idp_ boolinitiated_ login - Whether or not IdP-Initiated login should be disabled for this generic SAML integration draft. Defaults to
false
. - idp_
type str - Identity provider type. The value provided can be used as a filter when retrieving SAML integrations. See data source
cyral.IntegrationIdpSaml
.
- display
Name String - Display name used in the Cyral control plane.
- attributes Property Map
- SAML Attribute names for the identity attributes required by the Cyral SP. Each attribute name MUST be at least 3 characters long.
- disable
Idp BooleanInitiated Login - Whether or not IdP-Initiated login should be disabled for this generic SAML integration draft. Defaults to
false
. - idp
Type String - Identity provider type. The value provided can be used as a filter when retrieving SAML integrations. See data source
cyral.IntegrationIdpSaml
.
Outputs
All input properties are implicitly available as output properties. Additionally, the IntegrationIdpSamlDraft resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Service
Provider List<IntegrationMetadatas Idp Saml Draft Service Provider Metadata> - The SP Metadata fields describing the Cyral service provider for this integration.
- Sp
Metadata string - The SP Metadata document describing the Cyral service provider for this integration.
- Id string
- The provider-assigned unique ID for this managed resource.
- Service
Provider []IntegrationMetadatas Idp Saml Draft Service Provider Metadata - The SP Metadata fields describing the Cyral service provider for this integration.
- Sp
Metadata string - The SP Metadata document describing the Cyral service provider for this integration.
- id String
- The provider-assigned unique ID for this managed resource.
- service
Provider List<IntegrationMetadatas Idp Saml Draft Service Provider Metadata> - The SP Metadata fields describing the Cyral service provider for this integration.
- sp
Metadata String - The SP Metadata document describing the Cyral service provider for this integration.
- id string
- The provider-assigned unique ID for this managed resource.
- service
Provider IntegrationMetadatas Idp Saml Draft Service Provider Metadata[] - The SP Metadata fields describing the Cyral service provider for this integration.
- sp
Metadata string - The SP Metadata document describing the Cyral service provider for this integration.
- id str
- The provider-assigned unique ID for this managed resource.
- service_
provider_ Sequence[Integrationmetadatas Idp Saml Draft Service Provider Metadata] - The SP Metadata fields describing the Cyral service provider for this integration.
- sp_
metadata str - The SP Metadata document describing the Cyral service provider for this integration.
- id String
- The provider-assigned unique ID for this managed resource.
- service
Provider List<Property Map>Metadatas - The SP Metadata fields describing the Cyral service provider for this integration.
- sp
Metadata String - The SP Metadata document describing the Cyral service provider for this integration.
Look up Existing IntegrationIdpSamlDraft Resource
Get an existing IntegrationIdpSamlDraft 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?: IntegrationIdpSamlDraftState, opts?: CustomResourceOptions): IntegrationIdpSamlDraft
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
attributes: Optional[IntegrationIdpSamlDraftAttributesArgs] = None,
disable_idp_initiated_login: Optional[bool] = None,
display_name: Optional[str] = None,
idp_type: Optional[str] = None,
service_provider_metadatas: Optional[Sequence[IntegrationIdpSamlDraftServiceProviderMetadataArgs]] = None,
sp_metadata: Optional[str] = None) -> IntegrationIdpSamlDraft
func GetIntegrationIdpSamlDraft(ctx *Context, name string, id IDInput, state *IntegrationIdpSamlDraftState, opts ...ResourceOption) (*IntegrationIdpSamlDraft, error)
public static IntegrationIdpSamlDraft Get(string name, Input<string> id, IntegrationIdpSamlDraftState? state, CustomResourceOptions? opts = null)
public static IntegrationIdpSamlDraft get(String name, Output<String> id, IntegrationIdpSamlDraftState state, CustomResourceOptions options)
resources: _: type: cyral:IntegrationIdpSamlDraft 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.
- Attributes
Integration
Idp Saml Draft Attributes - SAML Attribute names for the identity attributes required by the Cyral SP. Each attribute name MUST be at least 3 characters long.
- Disable
Idp boolInitiated Login - Whether or not IdP-Initiated login should be disabled for this generic SAML integration draft. Defaults to
false
. - Display
Name string - Display name used in the Cyral control plane.
- Idp
Type string - Identity provider type. The value provided can be used as a filter when retrieving SAML integrations. See data source
cyral.IntegrationIdpSaml
. - Service
Provider List<IntegrationMetadatas Idp Saml Draft Service Provider Metadata> - The SP Metadata fields describing the Cyral service provider for this integration.
- Sp
Metadata string - The SP Metadata document describing the Cyral service provider for this integration.
- Attributes
Integration
Idp Saml Draft Attributes Args - SAML Attribute names for the identity attributes required by the Cyral SP. Each attribute name MUST be at least 3 characters long.
- Disable
Idp boolInitiated Login - Whether or not IdP-Initiated login should be disabled for this generic SAML integration draft. Defaults to
false
. - Display
Name string - Display name used in the Cyral control plane.
- Idp
Type string - Identity provider type. The value provided can be used as a filter when retrieving SAML integrations. See data source
cyral.IntegrationIdpSaml
. - Service
Provider []IntegrationMetadatas Idp Saml Draft Service Provider Metadata Args - The SP Metadata fields describing the Cyral service provider for this integration.
- Sp
Metadata string - The SP Metadata document describing the Cyral service provider for this integration.
- attributes
Integration
Idp Saml Draft Attributes - SAML Attribute names for the identity attributes required by the Cyral SP. Each attribute name MUST be at least 3 characters long.
- disable
Idp BooleanInitiated Login - Whether or not IdP-Initiated login should be disabled for this generic SAML integration draft. Defaults to
false
. - display
Name String - Display name used in the Cyral control plane.
- idp
Type String - Identity provider type. The value provided can be used as a filter when retrieving SAML integrations. See data source
cyral.IntegrationIdpSaml
. - service
Provider List<IntegrationMetadatas Idp Saml Draft Service Provider Metadata> - The SP Metadata fields describing the Cyral service provider for this integration.
- sp
Metadata String - The SP Metadata document describing the Cyral service provider for this integration.
- attributes
Integration
Idp Saml Draft Attributes - SAML Attribute names for the identity attributes required by the Cyral SP. Each attribute name MUST be at least 3 characters long.
- disable
Idp booleanInitiated Login - Whether or not IdP-Initiated login should be disabled for this generic SAML integration draft. Defaults to
false
. - display
Name string - Display name used in the Cyral control plane.
- idp
Type string - Identity provider type. The value provided can be used as a filter when retrieving SAML integrations. See data source
cyral.IntegrationIdpSaml
. - service
Provider IntegrationMetadatas Idp Saml Draft Service Provider Metadata[] - The SP Metadata fields describing the Cyral service provider for this integration.
- sp
Metadata string - The SP Metadata document describing the Cyral service provider for this integration.
- attributes
Integration
Idp Saml Draft Attributes Args - SAML Attribute names for the identity attributes required by the Cyral SP. Each attribute name MUST be at least 3 characters long.
- disable_
idp_ boolinitiated_ login - Whether or not IdP-Initiated login should be disabled for this generic SAML integration draft. Defaults to
false
. - display_
name str - Display name used in the Cyral control plane.
- idp_
type str - Identity provider type. The value provided can be used as a filter when retrieving SAML integrations. See data source
cyral.IntegrationIdpSaml
. - service_
provider_ Sequence[Integrationmetadatas Idp Saml Draft Service Provider Metadata Args] - The SP Metadata fields describing the Cyral service provider for this integration.
- sp_
metadata str - The SP Metadata document describing the Cyral service provider for this integration.
- attributes Property Map
- SAML Attribute names for the identity attributes required by the Cyral SP. Each attribute name MUST be at least 3 characters long.
- disable
Idp BooleanInitiated Login - Whether or not IdP-Initiated login should be disabled for this generic SAML integration draft. Defaults to
false
. - display
Name String - Display name used in the Cyral control plane.
- idp
Type String - Identity provider type. The value provided can be used as a filter when retrieving SAML integrations. See data source
cyral.IntegrationIdpSaml
. - service
Provider List<Property Map>Metadatas - The SP Metadata fields describing the Cyral service provider for this integration.
- sp
Metadata String - The SP Metadata document describing the Cyral service provider for this integration.
Supporting Types
IntegrationIdpSamlDraftAttributes, IntegrationIdpSamlDraftAttributesArgs
- Email string
- The name of the attribute in the incoming SAML assertion containing the users email address. Defaults to
email
. - First
Name string - The name of the attribute in the incoming SAML assertion containing the users first name (given name). Defaults to
firstName
. - Groups string
- The name of the attribute in the incoming SAML assertion containing the users group membership in the IdP. Defaults to
memberOf
. - Last
Name string - The name of the attribute in the incoming SAML assertion containing the users last name (family name). Defaults to
lastName
.
- Email string
- The name of the attribute in the incoming SAML assertion containing the users email address. Defaults to
email
. - First
Name string - The name of the attribute in the incoming SAML assertion containing the users first name (given name). Defaults to
firstName
. - Groups string
- The name of the attribute in the incoming SAML assertion containing the users group membership in the IdP. Defaults to
memberOf
. - Last
Name string - The name of the attribute in the incoming SAML assertion containing the users last name (family name). Defaults to
lastName
.
- email String
- The name of the attribute in the incoming SAML assertion containing the users email address. Defaults to
email
. - first
Name String - The name of the attribute in the incoming SAML assertion containing the users first name (given name). Defaults to
firstName
. - groups String
- The name of the attribute in the incoming SAML assertion containing the users group membership in the IdP. Defaults to
memberOf
. - last
Name String - The name of the attribute in the incoming SAML assertion containing the users last name (family name). Defaults to
lastName
.
- email string
- The name of the attribute in the incoming SAML assertion containing the users email address. Defaults to
email
. - first
Name string - The name of the attribute in the incoming SAML assertion containing the users first name (given name). Defaults to
firstName
. - groups string
- The name of the attribute in the incoming SAML assertion containing the users group membership in the IdP. Defaults to
memberOf
. - last
Name string - The name of the attribute in the incoming SAML assertion containing the users last name (family name). Defaults to
lastName
.
- email str
- The name of the attribute in the incoming SAML assertion containing the users email address. Defaults to
email
. - first_
name str - The name of the attribute in the incoming SAML assertion containing the users first name (given name). Defaults to
firstName
. - groups str
- The name of the attribute in the incoming SAML assertion containing the users group membership in the IdP. Defaults to
memberOf
. - last_
name str - The name of the attribute in the incoming SAML assertion containing the users last name (family name). Defaults to
lastName
.
- email String
- The name of the attribute in the incoming SAML assertion containing the users email address. Defaults to
email
. - first
Name String - The name of the attribute in the incoming SAML assertion containing the users first name (given name). Defaults to
firstName
. - groups String
- The name of the attribute in the incoming SAML assertion containing the users group membership in the IdP. Defaults to
memberOf
. - last
Name String - The name of the attribute in the incoming SAML assertion containing the users last name (family name). Defaults to
lastName
.
IntegrationIdpSamlDraftServiceProviderMetadata, IntegrationIdpSamlDraftServiceProviderMetadataArgs
- assertion
Consumer List<Property Map>Services - entity
Id String - single
Logout StringUrl - url String
- xml
Document String
IntegrationIdpSamlDraftServiceProviderMetadataAssertionConsumerService, IntegrationIdpSamlDraftServiceProviderMetadataAssertionConsumerServiceArgs
Package Details
- Repository
- cyral cyralinc/terraform-provider-cyral
- License
- Notes
- This Pulumi package is based on the
cyral
Terraform Provider.