oci_identity_provider_facts – Retrieve details about published App Catalog listings in OCI Compute Service¶

New in version 2.5.

Synopsis ¶

This module retrieves information of a specified app catalog listing or lists all the app catalog listings in the tenancy.

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 2.7
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io

Parameters ¶

Parameter	Choices/Defaults	Comments
api_user string		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 `config_file_location`). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint string		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 `config_file_location`). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file string		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 `config_file_location`). If the key is encrypted with a pass-phrase, the `api_user_key_pass_phrase` option must also be provided.
api_user_key_pass_phrase string		Passphrase used by the key referenced in `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 `config_file_location`).
auth_type string	Choices: api_key ← instance_principal instance_obo_user	The type of authentication to use for making API requests. By default `auth_type="api_key"` based authentication is performed and the API key (see 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 `auth_type="instance_principal"` to use instance principal based authentication when running ansible` playbooks within an OCI compute instance.
compartment_id string		The OCID of the tenancy (remember that the tenancy is simply the root compartment).
config_file_location string		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.
config_profile_name string		The profile to load from the config file referenced by `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 `config_file_location`.
identity_provider_id string		The OCID of the identity provider. Required to get information of a specific identity provider. aliases: id
name string		Filter the identity providers with given name.
protocol string	Choices: SAML2 ←	The protocol used for federation.
region string		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 `config_file_location`). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
tenancy string		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 `config_file_location`). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

- name: Get all identity providers of given protocol in the tenancy
  oci_identity_provider_facts:
    protocol: SAML2
    compartment_id: ocid1.tenancy.oc1..xxxxxEXAMPLExxxxx

- name: Get a specific identity provider using its OCID
  oci_identity_provider_facts:
    identity_provider_id: ocid1.saml2idp.oc1..xxxxxEXAMPLExxxxx

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

Key		Returned	Description
identity_providers complex		on success	List of identity provider details Sample: [{'freeform_tags': {}, 'redirect_url': 'https://testidp.oracletest.com/adfs/ls/', 'signing_certificate': None, 'lifecycle_state': 'ACTIVE', 'id': 'ocid1.saml2idp.oc1..xxxxxEXAMPLExxxxx', 'name': 'TEST_IDENTITY_PROVDER', 'description': 'Test Identity Provider', 'inactive_status': None, 'metadata_url': None, 'freeform_attributes': {}, 'product_type': 'ADFS', 'protocol': 'SAML2', 'defined_tags': {}, 'compartment_id': 'ocid1.tenancy.oc1..xxxxxEXAMPLExxxxx', 'time_created': '2019-04-01T21:49:41.934000+00:00'}]
	compartment_id string	success	The OCID of the tenancy containing the IdentityProvider. Sample: ocid1.tenancy.oc1..xxxxxEXAMPLExxxxx
	defined_tags string	success	Defined tags for this resource. Each key is predefined and scoped to a namespace. Sample: {'Operations': {'CostCenter': '42'}}
	description string	success	The description you assign to the IdentityProvider during creation. Sample: Test identity provider
	freeform_tags string	success	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Sample: {'Department': 'Finance'}
	id string	success	The OCID of the IdentityProvider. Sample: ocid1.saml2idp.oc1..xxxxxEXAMPLExxxxx
	inactive_status string	success	The detailed status of INACTIVE lifecycleState.
	lifecycle_state string	success	The current state. After creating an IdentityProvider, make sure its lifecycleState changes from CREATING to ACTIVE before using it. Sample: ACTIVE
	metadata_url string	success	The URL for retrieving the identity provider's metadata, which contains information required for federating. Sample: https://idcs-31ddf5c2bxxxxxxx429d5c2c927.identity.oraclecloud.com
	name string	success	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. Sample: TEST_IDENTITY_PROVDER
	product_type string	success	The identity provider service or product. Supported identity providers are Oracle Identity Cloud Service (IDCS) and Microsoft Active Directory Federation Services (ADFS). Sample: ADFS
	protocol string	success	The protocol used for federation. Sample: SAML2
	redirect_url string	success	The URL to redirect federated users to for authentication with the identity provider. Sample: https://idpinstance.ansibletest.com/adfs/ls/
	signing_certificate string	success	The identity provider's signing certificate used by the IAM Service to validate the SAML2 token.
	time_created string	success	Date and time the IdentityProvider was created, in the format defined by RFC3339. Sample: 2016-08-25 21:10:29.600000+00:00

Status ¶

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors¶

Manoj Meda (@manojmeda)

Hint

If you notice any issues in this documentation you can edit this document to improve it.

oci_identity_provider_facts – Retrieve details about published App Catalog listings in OCI Compute Service¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶