oracle / oracle.oci / 4.2.0 / module / oci_identity_provider_facts Fetches details about one or multiple IdentityProvider resources in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_identity_provider_facts (4.2.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.2.0
collections: - name: oracle.oci version: 4.2.0
Fetches details about one or multiple IdentityProvider resources in Oracle Cloud Infrastructure
**Deprecated.** For more information, see L(Deprecated IAM Service APIs,https://docs.cloud.oracle.com/Content/Identity/Reference/deprecatediamapis.htm).
Lists all the identity providers in your tenancy. You must specify the identity provider type (e.g., `SAML2` for identity providers using the SAML2.0 protocol). You must specify your tenancy's OCID as the value for the compartment ID (remember that the tenancy is simply the root compartment). See L(Where to Get the Tenancy's OCID and User's OCID,https://docs.cloud.oracle.com/Content/API/Concepts/apisigningkey.htm#five).
If I(identity_provider_id) is specified, the details of a single IdentityProvider will be returned.
- name: Get a specific identity_provider oci_identity_provider_facts: # required identity_provider_id: "ocid1.identityprovider.oc1..xxxxxxEXAMPLExxxxxx"
- name: List identity_providers oci_identity_provider_facts: # required protocol: SAML2 compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx" # optional name: name_example sort_by: TIMECREATED sort_order: ASC lifecycle_state: CREATING
name: description: - A filter to only return resources that match the given name exactly. type: str 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 sort_by: choices: - TIMECREATED - NAME description: - The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for NAME is ascending. The NAME sort order is case sensitive. - '**Note:** In general, some "List" operations (for example, `ListInstances`) let you optionally filter by Availability Domain if the scope of the resource type is within a single Availability Domain. If you call one of these "List" operations without specifying an Availability Domain, the resources are grouped by Availability Domain, then sorted.' 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 protocol: choices: - SAML2 description: - The protocol used for federation. - Required to list multiple identity_providers. type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal 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 sort_order: choices: - ASC - DESC description: - The sort order to use, either ascending (`ASC`) or descending (`DESC`). The NAME sort order is case sensitive. 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 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 compartment_id: description: - The OCID of the compartment (remember that the tenancy is simply the root compartment). - Required to list multiple identity_providers. type: str lifecycle_state: choices: - CREATING - ACTIVE - INACTIVE - DELETING - DELETED description: - A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. 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 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 to get a specific identity_provider. 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
identity_providers: 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: - List of IdentityProvider resources 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