oracle / oracle.oci / 4.32.0 / module / oci_identity_provider Manage an IdentityProvider resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_identity_provider (4.32.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.32.0
collections: - name: oracle.oci version: 4.32.0
This module allows the user to create, update and delete an IdentityProvider resource in Oracle Cloud Infrastructure
For I(state=present), **Deprecated.** For more information, see L(Deprecated IAM Service APIs,https://docs.cloud.oracle.com/Content/Identity/Reference/deprecatediamapis.htm).
Creates a new identity provider in your tenancy. For more information, see L(Identity Providers and Federation,https://docs.cloud.oracle.com/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 L(Resource Identifiers,https://docs.cloud.oracle.com/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 L(UpdateIdentityProvider,https://docs.cloud.oracle.com/en-us/iaas/api/#/en/identity/20160918/IdentityProvider/UpdateIdentityProvider).
After you send your request, the new object's `lifecycleState` will temporarily be CREATING. Before using the object, first make sure its `lifecycleState` has changed to ACTIVE.
This resource has the following action operations in the M(oracle.oci.oci_identity_provider_actions) module: reset_idp_scim_client.
- name: Create identity_provider with protocol = SAML2 oci_identity_provider: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" name: name_example product_type: IDCS protocol: SAML2 # optional description: description_example freeform_tags: {'Department': 'Finance'} defined_tags: {'Operations': {'CostCenter': 'US'}} metadata_url: metadata_url_example metadata: metadata_example freeform_attributes: null
- name: Update identity_provider with protocol = SAML2 oci_identity_provider: # required protocol: SAML2 # optional description: description_example freeform_tags: {'Department': 'Finance'} defined_tags: {'Operations': {'CostCenter': 'US'}} metadata_url: metadata_url_example metadata: metadata_example freeform_attributes: null
- name: Update identity_provider using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with protocol = SAML2 oci_identity_provider: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" name: name_example protocol: SAML2 # optional description: description_example freeform_tags: {'Department': 'Finance'} defined_tags: {'Operations': {'CostCenter': 'US'}} metadata_url: metadata_url_example metadata: metadata_example freeform_attributes: null
- name: Delete identity_provider oci_identity_provider: # required identity_provider_id: "ocid1.identityprovider.oc1..xxxxxxEXAMPLExxxxxx" state: absent
- name: Delete identity_provider using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with protocol = SAML2 oci_identity_provider: # required compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" name: name_example protocol: SAML2
name: description: - 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. - Required for create using I(state=present). - Required for update, delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. type: str wait: default: true description: Whether to wait for create or delete operation to complete. type: bool state: choices: - present - absent default: present description: - The state of the IdentityProvider. - Use I(state=present) to create or update an IdentityProvider. - Use I(state=absent) to delete an IdentityProvider. required: false type: str key_by: description: The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource. elements: str type: list region: description: - The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See C(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information on OCI regions. type: str tenancy: description: - OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See C(config_file_location)). To get the tenancy OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) type: str api_user: description: - The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See C(config_file_location)). To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str metadata: description: - The XML that contains the information required for federating. - Required for create using I(state=present). - This parameter is updatable. - Applicable when protocol is 'SAML2' type: str protocol: choices: - SAML2 description: - The protocol used for federation. - 'Example: `SAML2`' - Required for create using I(state=present), update using I(state=present) with identity_provider_id present. - Required for delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal - security_token default: api_key description: - The type of authentication to use for making API requests. By default C(auth_type="api_key") based authentication is performed and the API key (see I(api_user_key_file)) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use C(auth_type="instance_principal") to use instance principal based authentication when running ansible playbooks within an OCI compute instance. type: str cert_bundle: description: - The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used. type: str description: description: - The description you assign to the `IdentityProvider` during creation. Does not have to be unique, and it's changeable. - Required for create using I(state=present). - This parameter is updatable. - Applicable when protocol is 'SAML2' type: str auth_purpose: choices: - service_principal description: - The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None. type: str defined_tags: description: - 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`' - This parameter is updatable. type: dict force_create: default: false description: Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with I(key_by). type: bool metadata_url: description: - The URL for retrieving the identity provider's metadata, which contains information required for federating. - Required for create using I(state=present). - This parameter is updatable. - Applicable when protocol is 'SAML2' type: str product_type: choices: - IDCS - ADFS description: - The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS). - 'Example: `IDCS`' - Required for create using I(state=present). type: str wait_timeout: description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most of the services but some services might have a longer wait timeout. type: int freeform_tags: description: - '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 L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`' - This parameter is updatable. type: dict compartment_id: description: - The OCID of your tenancy. - Required for create using I(state=present). - Required for update when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. - Required for delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. type: str api_user_key_file: description: - Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See C(config_file_location)). If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided. type: str config_profile_name: description: - The profile to load from the config file referenced by C(config_file_location). If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in C(config_file_location). type: str freeform_attributes: description: - 'Extra name value pairs associated with this identity provider. Example: `{"clientId": "app_sf3kdjf3"}`' - This parameter is updatable. type: dict api_user_fingerprint: description: - Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See C(config_file_location)). To get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str config_file_location: description: - Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config. type: str identity_provider_id: aliases: - id description: - The OCID of the identity provider. - Required for update using I(state=present) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is not set. - Required for delete using I(state=absent) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is not set. type: str api_user_key_pass_phrase: description: - Passphrase used by the key referenced in C(api_user_key_file), if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See C(config_file_location)). type: str realm_specific_endpoint_template_enabled: description: - Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used. type: bool
identity_provider: contains: compartment_id: description: - The OCID of the tenancy containing the `IdentityProvider`. returned: on success sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx type: str defined_tags: description: - 'Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`' returned: on success sample: Operations: CostCenter: US type: dict description: description: - The description you assign to the `IdentityProvider` during creation. Does not have to be unique, and it's changeable. returned: on success sample: description_example type: str freeform_attributes: description: - 'Extra name value pairs associated with this identity provider. Example: `{"clientId": "app_sf3kdjf3"}`' returned: on success sample: {} type: dict freeform_tags: description: - '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 L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`' returned: on success sample: Department: Finance type: dict id: description: - The OCID of the `IdentityProvider`. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str inactive_status: description: - The detailed status of INACTIVE lifecycleState. returned: on success sample: 56 type: int lifecycle_state: description: - The current state. After creating an `IdentityProvider`, make sure its `lifecycleState` changes from CREATING to ACTIVE before using it. returned: on success sample: CREATING type: str metadata: description: - The XML that contains the information required for federating Identity with SAML2 Identity Provider. returned: on success sample: metadata_example type: str metadata_url: description: - The URL for retrieving the identity provider's metadata, which contains information required for federating. returned: on success sample: metadata_url_example type: str name: description: - 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. This is the name federated users see when choosing which identity provider to use when signing in to the Oracle Cloud Infrastructure Console. returned: on success sample: name_example type: str product_type: description: - The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS). - 'Allowed values are: - `ADFS` - `IDCS`' - 'Example: `IDCS`' returned: on success sample: product_type_example type: str protocol: description: - 'The protocol used for federation. Allowed value: `SAML2`.' - 'Example: `SAML2`' returned: on success sample: SAML2 type: str redirect_url: description: - The URL to redirect federated users to for authentication with the identity provider. returned: on success sample: redirect_url_example type: str signing_certificate: description: - The identity provider's signing certificate used by the IAM Service to validate the SAML2 token. returned: on success sample: '-----BEGIN CERTIFICATE----MIIBIjANBgkqhkiG9w0BA..-----END PUBLIC KEY-----' type: str time_created: description: - Date and time the `IdentityProvider` was created, in the format defined by RFC3339. - 'Example: `2016-08-25T21:10:29.600Z`' returned: on success sample: '2013-10-20T19:20:30+01:00' type: str description: - Details of the IdentityProvider resource acted upon by the current operation returned: on success sample: compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx defined_tags: Operations: CostCenter: US description: description_example freeform_attributes: {} freeform_tags: Department: Finance id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx inactive_status: 56 lifecycle_state: CREATING metadata: metadata_example metadata_url: metadata_url_example name: name_example product_type: product_type_example protocol: SAML2 redirect_url: redirect_url_example signing_certificate: '-----BEGIN CERTIFICATE----MIIBIjANBgkqhkiG9w0BA..-----END PUBLIC KEY-----' time_created: '2013-10-20T19:20:30+01:00' type: complex