oci_customer_secret_key_facts - Retrieve details of customer secret keys for a specified user¶

New in version 2.5.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
- Author

Synopsis ¶

This module retrieves details of customer secret keys of a specified user. The returned object contains the customer secret key’s OCID, but not the password itself. The actual password is returned only upon creation of a customer secret key using the oci_customer_secret_key module.

Requirements ¶

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

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

Parameters ¶

Parameter	Choices/Defaults	Comments
api_user		The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_OCID 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		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		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		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	Choices: api_key ← instance_principal	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.
config_file_location		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	Default: DEFAULT	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`.
customer_secret_key_id		The OCID of the customer secret key. Required when facts about a specific customer secret key for the specified user needs to be obtained. aliases: id
display_name		Use display_name along with the other options to return only resources that match the given display name exactly.
region		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		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
user_id required		The OCID of the user

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 details of all the customer secret keys of the specified user
  oci_customer_secret_key_facts:
    user_id: "ocid1.user.oc1..xxxxxEXAMPLExxxxx"

- name: Get details of a specific customer secret key of a user
  oci_customer_secret_key_facts:
    user_id: "ocid1.user.oc1..xxxxxEXAMPLExxxxx"
    id: "ocid1.credential.oc1..xxxxxEXAMPLExxxxx"

Return Values ¶

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

Key		Returned	Description
customer_secret_keys complex		on success	Information about one or more customer secret keys in the specified user Sample: {'customer_secret_keys': [{'lifecycle_state': 'ACTIVE', 'inactive_status': 'None', 'display_name': 'My first customer secret key description', 'user_id': 'ocid1.user.oc1..xxxxxEXAMPLExxxxx', 'time_expires': 'None', 'id': 'ocid1.credential.oc1..xxxxxEXAMPLExxxxx', 'time_created': '2018-01-08T04:44:17.784000+00:00'}]}
	lifecycle_state string	always	The password's current state. Sample: ACTIVE
	inactive_status string	only when the lifecycle_state is 'INACTIVE'	The detailed status of INACTIVE lifecycleState.
	user_id string	always	The OCID of the user the customer secret key belongs to. Sample: ocid1.user.oc1..xxxxxEXAMPLExxxxx'
	description string	always	The description that was assigned to the Customer secret key. Sample: My first customer secret key description'
	id string	always	The OCID of the Customer secret key:. Sample: ocid1.credential.oc1..xxxxxEXAMPLExxxxx
	time_created string	always	Date and time the Customer secret key object was created, in the format defined by RFC3339. Sample: 2016-08-25 21:10:29.600000
	expires_on string	always	Date and time when this secret key will expire, in the format defined by RFC3339. Null if it never expires. Sample: 2016-08-25 21:10:29.600000

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author ¶

Sivakumar Thyagarajan (@sivakumart)

Hint

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