import * as pulumi from "@pulumi/pulumi"; /** * This resource provides the Identity Provider resource in Oracle Cloud Infrastructure Identity service. * Api doc link for the resource: https://docs.oracle.com/iaas/api/#/en/identity/latest/IdentityProvider * * Example terraform configs related to the resource : https://github.com/oracle/terraform-provider-oci/tree/master/examples/identity * * **Deprecated.** For more information, see [Deprecated IAM Service APIs](https://docs.cloud.oracle.com/iaas/Content/Identity/Reference/deprecatediamapis.htm). * * Creates a new identity provider in your tenancy. For more information, see * [Identity Providers and Federation](https://docs.cloud.oracle.com/iaas/Content/Identity/Concepts/federation.htm). * * 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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm). * * 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](https://docs.cloud.oracle.com/iaas/api/#/en/identity/20160918/IdentityProvider/UpdateIdentityProvider). * * ## Example Usage * * ```typescript * 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 * * IdentityProviders can be imported using the `id`, e.g. * * ```sh * $ pulumi import oci:Identity/identityProvider:IdentityProvider test_identity_provider "id" * ``` */ export declare class IdentityProvider extends pulumi.CustomResource { /** * Get an existing IdentityProvider resource's state with the given name, ID, and optional extra * properties used to qualify the lookup. * * @param name The _unique_ name of the resulting resource. * @param id The _unique_ provider ID of the resource to lookup. * @param state Any extra arguments used during the lookup. * @param opts Optional settings to control the behavior of the CustomResource. */ static get(name: string, id: pulumi.Input, state?: IdentityProviderState, opts?: pulumi.CustomResourceOptions): IdentityProvider; /** * Returns true if the given object is an instance of IdentityProvider. This is designed to work even * when multiple copies of the Pulumi SDK have been loaded into the same process. */ static isInstance(obj: any): obj is IdentityProvider; /** * The OCID of your tenancy. */ readonly compartmentId: pulumi.Output; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ readonly definedTags: pulumi.Output<{ [key: string]: string; }>; /** * (Updatable) The description you assign to the `IdentityProvider` during creation. Does not have to be unique, and it's changeable. */ readonly description: pulumi.Output; /** * (Updatable) Extra name value pairs associated with this identity provider. Example: `{"clientId": "appSf3kdjf3"}` */ readonly freeformAttributes: pulumi.Output<{ [key: string]: string; }>; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ readonly freeformTags: pulumi.Output<{ [key: string]: string; }>; /** * The detailed status of INACTIVE lifecycleState. */ readonly inactiveState: pulumi.Output; /** * (Updatable) The XML that contains the information required for federating. */ readonly metadata: pulumi.Output; /** * (Updatable) The URL for retrieving the identity provider's metadata, which contains information required for federating. */ readonly metadataUrl: pulumi.Output; /** * 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. */ readonly name: pulumi.Output; /** * The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS). Example: `IDCS` */ readonly productType: pulumi.Output; /** * (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 */ readonly protocol: pulumi.Output; /** * The URL to redirect federated users to for authentication with the identity provider. */ readonly redirectUrl: pulumi.Output; /** * The identity provider's signing certificate used by the IAM Service to validate the SAML2 token. */ readonly signingCertificate: pulumi.Output; /** * The current state. */ readonly state: pulumi.Output; /** * Date and time the `IdentityProvider` was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ readonly timeCreated: pulumi.Output; /** * Create a IdentityProvider resource with the given unique name, arguments, and options. * * @param name The _unique_ name of the resource. * @param args The arguments to use to populate this resource's properties. * @param opts A bag of options that control this resource's behavior. */ constructor(name: string, args: IdentityProviderArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering IdentityProvider resources. */ export interface IdentityProviderState { /** * The OCID of your tenancy. */ compartmentId?: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) The description you assign to the `IdentityProvider` during creation. Does not have to be unique, and it's changeable. */ description?: pulumi.Input; /** * (Updatable) Extra name value pairs associated with this identity provider. Example: `{"clientId": "appSf3kdjf3"}` */ freeformAttributes?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The detailed status of INACTIVE lifecycleState. */ inactiveState?: pulumi.Input; /** * (Updatable) The XML that contains the information required for federating. */ metadata?: pulumi.Input; /** * (Updatable) The URL for retrieving the identity provider's metadata, which contains information required for federating. */ metadataUrl?: pulumi.Input; /** * 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. */ name?: pulumi.Input; /** * The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS). Example: `IDCS` */ productType?: pulumi.Input; /** * (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 */ protocol?: pulumi.Input; /** * The URL to redirect federated users to for authentication with the identity provider. */ redirectUrl?: pulumi.Input; /** * The identity provider's signing certificate used by the IAM Service to validate the SAML2 token. */ signingCertificate?: pulumi.Input; /** * The current state. */ state?: pulumi.Input; /** * Date and time the `IdentityProvider` was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` */ timeCreated?: pulumi.Input; } /** * The set of arguments for constructing a IdentityProvider resource. */ export interface IdentityProviderArgs { /** * The OCID of your tenancy. */ compartmentId: pulumi.Input; /** * (Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Operations.CostCenter": "42"}` */ definedTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) The description you assign to the `IdentityProvider` during creation. Does not have to be unique, and it's changeable. */ description: pulumi.Input; /** * (Updatable) Extra name value pairs associated with this identity provider. Example: `{"clientId": "appSf3kdjf3"}` */ freeformAttributes?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (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](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}` */ freeformTags?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * (Updatable) The XML that contains the information required for federating. */ metadata: pulumi.Input; /** * (Updatable) The URL for retrieving the identity provider's metadata, which contains information required for federating. */ metadataUrl: pulumi.Input; /** * 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. */ name?: pulumi.Input; /** * The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS). Example: `IDCS` */ productType: pulumi.Input; /** * (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 */ protocol: pulumi.Input; } //# sourceMappingURL=identityProvider.d.ts.map