1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. Identity
  5. IdentityProvider
Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi

oci.Identity.IdentityProvider

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi

    This resource provides the Identity Provider resource in Oracle Cloud Infrastructure Identity service.

    Deprecated. For more information, see Deprecated IAM Service APIs.

    Creates a new identity provider in your tenancy. For more information, see Identity Providers and Federation.

    You must specify your tenancy’s OCID as the compartment ID in the request object. Remember that the tenancy is simply the root compartment. For information about OCIDs, see Resource Identifiers.

    You must also specify a name for the IdentityProvider, which must be unique across all IdentityProvider objects in your tenancy and cannot be changed.

    You must also specify a description for the IdentityProvider (although it can be an empty string). It does not have to be unique, and you can change it anytime with UpdateIdentityProvider.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testIdentityProvider = new oci.identity.IdentityProvider("test_identity_provider", {
        compartmentId: tenancyOcid,
        description: identityProviderDescription,
        metadata: identityProviderMetadata,
        metadataUrl: identityProviderMetadataUrl,
        name: identityProviderName,
        productType: identityProviderProductType,
        protocol: identityProviderProtocol,
        definedTags: {
            "Operations.CostCenter": "42",
        },
        freeformAttributes: identityProviderFreeformAttributes,
        freeformTags: {
            Department: "Finance",
        },
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_identity_provider = oci.identity.IdentityProvider("test_identity_provider",
        compartment_id=tenancy_ocid,
        description=identity_provider_description,
        metadata=identity_provider_metadata,
        metadata_url=identity_provider_metadata_url,
        name=identity_provider_name,
        product_type=identity_provider_product_type,
        protocol=identity_provider_protocol,
        defined_tags={
            "Operations.CostCenter": "42",
        },
        freeform_attributes=identity_provider_freeform_attributes,
        freeform_tags={
            "Department": "Finance",
        })
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/Identity"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := Identity.NewIdentityProvider(ctx, "test_identity_provider", &Identity.IdentityProviderArgs{
    			CompartmentId: pulumi.Any(tenancyOcid),
    			Description:   pulumi.Any(identityProviderDescription),
    			Metadata:      pulumi.Any(identityProviderMetadata),
    			MetadataUrl:   pulumi.Any(identityProviderMetadataUrl),
    			Name:          pulumi.Any(identityProviderName),
    			ProductType:   pulumi.Any(identityProviderProductType),
    			Protocol:      pulumi.Any(identityProviderProtocol),
    			DefinedTags: pulumi.Map{
    				"Operations.CostCenter": pulumi.Any("42"),
    			},
    			FreeformAttributes: pulumi.Any(identityProviderFreeformAttributes),
    			FreeformTags: pulumi.Map{
    				"Department": pulumi.Any("Finance"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Oci = Pulumi.Oci;
    
    return await Deployment.RunAsync(() => 
    {
        var testIdentityProvider = new Oci.Identity.IdentityProvider("test_identity_provider", new()
        {
            CompartmentId = tenancyOcid,
            Description = identityProviderDescription,
            Metadata = identityProviderMetadata,
            MetadataUrl = identityProviderMetadataUrl,
            Name = identityProviderName,
            ProductType = identityProviderProductType,
            Protocol = identityProviderProtocol,
            DefinedTags = 
            {
                { "Operations.CostCenter", "42" },
            },
            FreeformAttributes = identityProviderFreeformAttributes,
            FreeformTags = 
            {
                { "Department", "Finance" },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.Identity.IdentityProvider;
    import com.pulumi.oci.Identity.IdentityProviderArgs;
    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 testIdentityProvider = new IdentityProvider("testIdentityProvider", IdentityProviderArgs.builder()
                .compartmentId(tenancyOcid)
                .description(identityProviderDescription)
                .metadata(identityProviderMetadata)
                .metadataUrl(identityProviderMetadataUrl)
                .name(identityProviderName)
                .productType(identityProviderProductType)
                .protocol(identityProviderProtocol)
                .definedTags(Map.of("Operations.CostCenter", "42"))
                .freeformAttributes(identityProviderFreeformAttributes)
                .freeformTags(Map.of("Department", "Finance"))
                .build());
    
        }
    }
    
    resources:
      testIdentityProvider:
        type: oci:Identity:IdentityProvider
        name: test_identity_provider
        properties:
          compartmentId: ${tenancyOcid}
          description: ${identityProviderDescription}
          metadata: ${identityProviderMetadata}
          metadataUrl: ${identityProviderMetadataUrl}
          name: ${identityProviderName}
          productType: ${identityProviderProductType}
          protocol: ${identityProviderProtocol}
          definedTags:
            Operations.CostCenter: '42'
          freeformAttributes: ${identityProviderFreeformAttributes}
          freeformTags:
            Department: Finance
    

    Create IdentityProvider Resource

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

    Constructor syntax

    new IdentityProvider(name: string, args: IdentityProviderArgs, opts?: CustomResourceOptions);
    @overload
    def IdentityProvider(resource_name: str,
                         args: IdentityProviderArgs,
                         opts: Optional[ResourceOptions] = None)
    
    @overload
    def IdentityProvider(resource_name: str,
                         opts: Optional[ResourceOptions] = None,
                         compartment_id: Optional[str] = None,
                         description: Optional[str] = None,
                         metadata: Optional[str] = None,
                         metadata_url: Optional[str] = None,
                         product_type: Optional[str] = None,
                         protocol: Optional[str] = None,
                         defined_tags: Optional[Mapping[str, Any]] = None,
                         freeform_attributes: Optional[Mapping[str, Any]] = None,
                         freeform_tags: Optional[Mapping[str, Any]] = None,
                         name: Optional[str] = None)
    func NewIdentityProvider(ctx *Context, name string, args IdentityProviderArgs, opts ...ResourceOption) (*IdentityProvider, error)
    public IdentityProvider(string name, IdentityProviderArgs args, CustomResourceOptions? opts = null)
    public IdentityProvider(String name, IdentityProviderArgs args)
    public IdentityProvider(String name, IdentityProviderArgs args, CustomResourceOptions options)
    
    type: oci:Identity:IdentityProvider
    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 IdentityProviderArgs
    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 IdentityProviderArgs
    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 IdentityProviderArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args IdentityProviderArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args IdentityProviderArgs
    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 identityProviderResource = new Oci.Identity.IdentityProvider("identityProviderResource", new()
    {
        CompartmentId = "string",
        Description = "string",
        Metadata = "string",
        MetadataUrl = "string",
        ProductType = "string",
        Protocol = "string",
        DefinedTags = 
        {
            { "string", "any" },
        },
        FreeformAttributes = 
        {
            { "string", "any" },
        },
        FreeformTags = 
        {
            { "string", "any" },
        },
        Name = "string",
    });
    
    example, err := Identity.NewIdentityProvider(ctx, "identityProviderResource", &Identity.IdentityProviderArgs{
    	CompartmentId: pulumi.String("string"),
    	Description:   pulumi.String("string"),
    	Metadata:      pulumi.String("string"),
    	MetadataUrl:   pulumi.String("string"),
    	ProductType:   pulumi.String("string"),
    	Protocol:      pulumi.String("string"),
    	DefinedTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	FreeformAttributes: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	FreeformTags: pulumi.Map{
    		"string": pulumi.Any("any"),
    	},
    	Name: pulumi.String("string"),
    })
    
    var identityProviderResource = new IdentityProvider("identityProviderResource", IdentityProviderArgs.builder()
        .compartmentId("string")
        .description("string")
        .metadata("string")
        .metadataUrl("string")
        .productType("string")
        .protocol("string")
        .definedTags(Map.of("string", "any"))
        .freeformAttributes(Map.of("string", "any"))
        .freeformTags(Map.of("string", "any"))
        .name("string")
        .build());
    
    identity_provider_resource = oci.identity.IdentityProvider("identityProviderResource",
        compartment_id="string",
        description="string",
        metadata="string",
        metadata_url="string",
        product_type="string",
        protocol="string",
        defined_tags={
            "string": "any",
        },
        freeform_attributes={
            "string": "any",
        },
        freeform_tags={
            "string": "any",
        },
        name="string")
    
    const identityProviderResource = new oci.identity.IdentityProvider("identityProviderResource", {
        compartmentId: "string",
        description: "string",
        metadata: "string",
        metadataUrl: "string",
        productType: "string",
        protocol: "string",
        definedTags: {
            string: "any",
        },
        freeformAttributes: {
            string: "any",
        },
        freeformTags: {
            string: "any",
        },
        name: "string",
    });
    
    type: oci:Identity:IdentityProvider
    properties:
        compartmentId: string
        definedTags:
            string: any
        description: string
        freeformAttributes:
            string: any
        freeformTags:
            string: any
        metadata: string
        metadataUrl: string
        name: string
        productType: string
        protocol: string
    

    IdentityProvider Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The IdentityProvider resource accepts the following input properties:

    CompartmentId string
    The OCID of your tenancy.
    Description string
    (Updatable) The description you assign to the IdentityProvider during creation. Does not have to be unique, and it's changeable.
    Metadata string
    (Updatable) The XML that contains the information required for federating.
    MetadataUrl string
    (Updatable) The URL for retrieving the identity provider's metadata, which contains information required for federating.
    ProductType string
    The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS). Example: IDCS
    Protocol string

    (Updatable) The protocol used for federation. Example: SAML2

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    FreeformAttributes Dictionary<string, object>
    (Updatable) Extra name value pairs associated with this identity provider. Example: {"clientId": "app_sf3kdjf3"}
    FreeformTags Dictionary<string, object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Name string
    The name you assign to the IdentityProvider during creation. The name must be unique across all IdentityProvider objects in the tenancy and cannot be changed.
    CompartmentId string
    The OCID of your tenancy.
    Description string
    (Updatable) The description you assign to the IdentityProvider during creation. Does not have to be unique, and it's changeable.
    Metadata string
    (Updatable) The XML that contains the information required for federating.
    MetadataUrl string
    (Updatable) The URL for retrieving the identity provider's metadata, which contains information required for federating.
    ProductType string
    The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS). Example: IDCS
    Protocol string

    (Updatable) The protocol used for federation. Example: SAML2

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    FreeformAttributes map[string]interface{}
    (Updatable) Extra name value pairs associated with this identity provider. Example: {"clientId": "app_sf3kdjf3"}
    FreeformTags map[string]interface{}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Name string
    The name you assign to the IdentityProvider during creation. The name must be unique across all IdentityProvider objects in the tenancy and cannot be changed.
    compartmentId String
    The OCID of your tenancy.
    description String
    (Updatable) The description you assign to the IdentityProvider during creation. Does not have to be unique, and it's changeable.
    metadata String
    (Updatable) The XML that contains the information required for federating.
    metadataUrl String
    (Updatable) The URL for retrieving the identity provider's metadata, which contains information required for federating.
    productType String
    The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS). Example: IDCS
    protocol String

    (Updatable) The protocol used for federation. Example: SAML2

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformAttributes Map<String,Object>
    (Updatable) Extra name value pairs associated with this identity provider. Example: {"clientId": "app_sf3kdjf3"}
    freeformTags Map<String,Object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    name String
    The name you assign to the IdentityProvider during creation. The name must be unique across all IdentityProvider objects in the tenancy and cannot be changed.
    compartmentId string
    The OCID of your tenancy.
    description string
    (Updatable) The description you assign to the IdentityProvider during creation. Does not have to be unique, and it's changeable.
    metadata string
    (Updatable) The XML that contains the information required for federating.
    metadataUrl string
    (Updatable) The URL for retrieving the identity provider's metadata, which contains information required for federating.
    productType string
    The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS). Example: IDCS
    protocol string

    (Updatable) The protocol used for federation. Example: SAML2

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformAttributes {[key: string]: any}
    (Updatable) Extra name value pairs associated with this identity provider. Example: {"clientId": "app_sf3kdjf3"}
    freeformTags {[key: string]: any}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    name string
    The name you assign to the IdentityProvider during creation. The name must be unique across all IdentityProvider objects in the tenancy and cannot be changed.
    compartment_id str
    The OCID of your tenancy.
    description str
    (Updatable) The description you assign to the IdentityProvider during creation. Does not have to be unique, and it's changeable.
    metadata str
    (Updatable) The XML that contains the information required for federating.
    metadata_url str
    (Updatable) The URL for retrieving the identity provider's metadata, which contains information required for federating.
    product_type str
    The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS). Example: IDCS
    protocol str

    (Updatable) The protocol used for federation. Example: SAML2

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeform_attributes Mapping[str, Any]
    (Updatable) Extra name value pairs associated with this identity provider. Example: {"clientId": "app_sf3kdjf3"}
    freeform_tags Mapping[str, Any]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    name str
    The name you assign to the IdentityProvider during creation. The name must be unique across all IdentityProvider objects in the tenancy and cannot be changed.
    compartmentId String
    The OCID of your tenancy.
    description String
    (Updatable) The description you assign to the IdentityProvider during creation. Does not have to be unique, and it's changeable.
    metadata String
    (Updatable) The XML that contains the information required for federating.
    metadataUrl String
    (Updatable) The URL for retrieving the identity provider's metadata, which contains information required for federating.
    productType String
    The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS). Example: IDCS
    protocol String

    (Updatable) The protocol used for federation. Example: SAML2

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    freeformAttributes Map<Any>
    (Updatable) Extra name value pairs associated with this identity provider. Example: {"clientId": "app_sf3kdjf3"}
    freeformTags Map<Any>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    name String
    The name you assign to the IdentityProvider during creation. The name must be unique across all IdentityProvider objects in the tenancy and cannot be changed.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    InactiveState string
    The detailed status of INACTIVE lifecycleState.
    RedirectUrl string
    The URL to redirect federated users to for authentication with the identity provider.
    SigningCertificate string
    The identity provider's signing certificate used by the IAM Service to validate the SAML2 token.
    State string
    The current state.
    TimeCreated string
    Date and time the IdentityProvider was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    Id string
    The provider-assigned unique ID for this managed resource.
    InactiveState string
    The detailed status of INACTIVE lifecycleState.
    RedirectUrl string
    The URL to redirect federated users to for authentication with the identity provider.
    SigningCertificate string
    The identity provider's signing certificate used by the IAM Service to validate the SAML2 token.
    State string
    The current state.
    TimeCreated string
    Date and time the IdentityProvider was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    id String
    The provider-assigned unique ID for this managed resource.
    inactiveState String
    The detailed status of INACTIVE lifecycleState.
    redirectUrl String
    The URL to redirect federated users to for authentication with the identity provider.
    signingCertificate String
    The identity provider's signing certificate used by the IAM Service to validate the SAML2 token.
    state String
    The current state.
    timeCreated String
    Date and time the IdentityProvider was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    id string
    The provider-assigned unique ID for this managed resource.
    inactiveState string
    The detailed status of INACTIVE lifecycleState.
    redirectUrl string
    The URL to redirect federated users to for authentication with the identity provider.
    signingCertificate string
    The identity provider's signing certificate used by the IAM Service to validate the SAML2 token.
    state string
    The current state.
    timeCreated string
    Date and time the IdentityProvider was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    id str
    The provider-assigned unique ID for this managed resource.
    inactive_state str
    The detailed status of INACTIVE lifecycleState.
    redirect_url str
    The URL to redirect federated users to for authentication with the identity provider.
    signing_certificate str
    The identity provider's signing certificate used by the IAM Service to validate the SAML2 token.
    state str
    The current state.
    time_created str
    Date and time the IdentityProvider was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    id String
    The provider-assigned unique ID for this managed resource.
    inactiveState String
    The detailed status of INACTIVE lifecycleState.
    redirectUrl String
    The URL to redirect federated users to for authentication with the identity provider.
    signingCertificate String
    The identity provider's signing certificate used by the IAM Service to validate the SAML2 token.
    state String
    The current state.
    timeCreated String
    Date and time the IdentityProvider was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

    Look up Existing IdentityProvider Resource

    Get an existing IdentityProvider 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?: IdentityProviderState, opts?: CustomResourceOptions): IdentityProvider
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            compartment_id: Optional[str] = None,
            defined_tags: Optional[Mapping[str, Any]] = None,
            description: Optional[str] = None,
            freeform_attributes: Optional[Mapping[str, Any]] = None,
            freeform_tags: Optional[Mapping[str, Any]] = None,
            inactive_state: Optional[str] = None,
            metadata: Optional[str] = None,
            metadata_url: Optional[str] = None,
            name: Optional[str] = None,
            product_type: Optional[str] = None,
            protocol: Optional[str] = None,
            redirect_url: Optional[str] = None,
            signing_certificate: Optional[str] = None,
            state: Optional[str] = None,
            time_created: Optional[str] = None) -> IdentityProvider
    func GetIdentityProvider(ctx *Context, name string, id IDInput, state *IdentityProviderState, opts ...ResourceOption) (*IdentityProvider, error)
    public static IdentityProvider Get(string name, Input<string> id, IdentityProviderState? state, CustomResourceOptions? opts = null)
    public static IdentityProvider get(String name, Output<String> id, IdentityProviderState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    CompartmentId string
    The OCID of your tenancy.
    DefinedTags Dictionary<string, object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description you assign to the IdentityProvider during creation. Does not have to be unique, and it's changeable.
    FreeformAttributes Dictionary<string, object>
    (Updatable) Extra name value pairs associated with this identity provider. Example: {"clientId": "app_sf3kdjf3"}
    FreeformTags Dictionary<string, object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    InactiveState string
    The detailed status of INACTIVE lifecycleState.
    Metadata string
    (Updatable) The XML that contains the information required for federating.
    MetadataUrl string
    (Updatable) The URL for retrieving the identity provider's metadata, which contains information required for federating.
    Name string
    The name you assign to the IdentityProvider during creation. The name must be unique across all IdentityProvider objects in the tenancy and cannot be changed.
    ProductType string
    The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS). Example: IDCS
    Protocol string

    (Updatable) The protocol used for federation. Example: SAML2

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    RedirectUrl string
    The URL to redirect federated users to for authentication with the identity provider.
    SigningCertificate string
    The identity provider's signing certificate used by the IAM Service to validate the SAML2 token.
    State string
    The current state.
    TimeCreated string
    Date and time the IdentityProvider was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    CompartmentId string
    The OCID of your tenancy.
    DefinedTags map[string]interface{}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    Description string
    (Updatable) The description you assign to the IdentityProvider during creation. Does not have to be unique, and it's changeable.
    FreeformAttributes map[string]interface{}
    (Updatable) Extra name value pairs associated with this identity provider. Example: {"clientId": "app_sf3kdjf3"}
    FreeformTags map[string]interface{}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    InactiveState string
    The detailed status of INACTIVE lifecycleState.
    Metadata string
    (Updatable) The XML that contains the information required for federating.
    MetadataUrl string
    (Updatable) The URL for retrieving the identity provider's metadata, which contains information required for federating.
    Name string
    The name you assign to the IdentityProvider during creation. The name must be unique across all IdentityProvider objects in the tenancy and cannot be changed.
    ProductType string
    The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS). Example: IDCS
    Protocol string

    (Updatable) The protocol used for federation. Example: SAML2

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    RedirectUrl string
    The URL to redirect federated users to for authentication with the identity provider.
    SigningCertificate string
    The identity provider's signing certificate used by the IAM Service to validate the SAML2 token.
    State string
    The current state.
    TimeCreated string
    Date and time the IdentityProvider was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId String
    The OCID of your tenancy.
    definedTags Map<String,Object>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description you assign to the IdentityProvider during creation. Does not have to be unique, and it's changeable.
    freeformAttributes Map<String,Object>
    (Updatable) Extra name value pairs associated with this identity provider. Example: {"clientId": "app_sf3kdjf3"}
    freeformTags Map<String,Object>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    inactiveState String
    The detailed status of INACTIVE lifecycleState.
    metadata String
    (Updatable) The XML that contains the information required for federating.
    metadataUrl String
    (Updatable) The URL for retrieving the identity provider's metadata, which contains information required for federating.
    name String
    The name you assign to the IdentityProvider during creation. The name must be unique across all IdentityProvider objects in the tenancy and cannot be changed.
    productType String
    The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS). Example: IDCS
    protocol String

    (Updatable) The protocol used for federation. Example: SAML2

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    redirectUrl String
    The URL to redirect federated users to for authentication with the identity provider.
    signingCertificate String
    The identity provider's signing certificate used by the IAM Service to validate the SAML2 token.
    state String
    The current state.
    timeCreated String
    Date and time the IdentityProvider was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId string
    The OCID of your tenancy.
    definedTags {[key: string]: any}
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description string
    (Updatable) The description you assign to the IdentityProvider during creation. Does not have to be unique, and it's changeable.
    freeformAttributes {[key: string]: any}
    (Updatable) Extra name value pairs associated with this identity provider. Example: {"clientId": "app_sf3kdjf3"}
    freeformTags {[key: string]: any}
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    inactiveState string
    The detailed status of INACTIVE lifecycleState.
    metadata string
    (Updatable) The XML that contains the information required for federating.
    metadataUrl string
    (Updatable) The URL for retrieving the identity provider's metadata, which contains information required for federating.
    name string
    The name you assign to the IdentityProvider during creation. The name must be unique across all IdentityProvider objects in the tenancy and cannot be changed.
    productType string
    The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS). Example: IDCS
    protocol string

    (Updatable) The protocol used for federation. Example: SAML2

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    redirectUrl string
    The URL to redirect federated users to for authentication with the identity provider.
    signingCertificate string
    The identity provider's signing certificate used by the IAM Service to validate the SAML2 token.
    state string
    The current state.
    timeCreated string
    Date and time the IdentityProvider was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    compartment_id str
    The OCID of your tenancy.
    defined_tags Mapping[str, Any]
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description str
    (Updatable) The description you assign to the IdentityProvider during creation. Does not have to be unique, and it's changeable.
    freeform_attributes Mapping[str, Any]
    (Updatable) Extra name value pairs associated with this identity provider. Example: {"clientId": "app_sf3kdjf3"}
    freeform_tags Mapping[str, Any]
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    inactive_state str
    The detailed status of INACTIVE lifecycleState.
    metadata str
    (Updatable) The XML that contains the information required for federating.
    metadata_url str
    (Updatable) The URL for retrieving the identity provider's metadata, which contains information required for federating.
    name str
    The name you assign to the IdentityProvider during creation. The name must be unique across all IdentityProvider objects in the tenancy and cannot be changed.
    product_type str
    The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS). Example: IDCS
    protocol str

    (Updatable) The protocol used for federation. Example: SAML2

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    redirect_url str
    The URL to redirect federated users to for authentication with the identity provider.
    signing_certificate str
    The identity provider's signing certificate used by the IAM Service to validate the SAML2 token.
    state str
    The current state.
    time_created str
    Date and time the IdentityProvider was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z
    compartmentId String
    The OCID of your tenancy.
    definedTags Map<Any>
    (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}
    description String
    (Updatable) The description you assign to the IdentityProvider during creation. Does not have to be unique, and it's changeable.
    freeformAttributes Map<Any>
    (Updatable) Extra name value pairs associated with this identity provider. Example: {"clientId": "app_sf3kdjf3"}
    freeformTags Map<Any>
    (Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}
    inactiveState String
    The detailed status of INACTIVE lifecycleState.
    metadata String
    (Updatable) The XML that contains the information required for federating.
    metadataUrl String
    (Updatable) The URL for retrieving the identity provider's metadata, which contains information required for federating.
    name String
    The name you assign to the IdentityProvider during creation. The name must be unique across all IdentityProvider objects in the tenancy and cannot be changed.
    productType String
    The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS). Example: IDCS
    protocol String

    (Updatable) The protocol used for federation. Example: SAML2

    ** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

    redirectUrl String
    The URL to redirect federated users to for authentication with the identity provider.
    signingCertificate String
    The identity provider's signing certificate used by the IAM Service to validate the SAML2 token.
    state String
    The current state.
    timeCreated String
    Date and time the IdentityProvider was created, in the format defined by RFC3339. Example: 2016-08-25T21:10:29.600Z

    Import

    IdentityProviders can be imported using the id, e.g.

    $ pulumi import oci:Identity/identityProvider:IdentityProvider test_identity_provider "id"
    

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

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.3.0 published on Wednesday, Jul 17, 2024 by Pulumi