oci_api_key_facts - Retrieve details of api signing keys for a specified user¶
New in version 2.5.
Synopsis¶
- This module retrieves details of api signing keys of a specified user. Note that this is not the SSH key for accessing compute instances. This is the credential for securing requests to the Oracle Cloud Infrastructure REST API.
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_key_id |
The OCID of the api signing key. Required when facts about a specific api signing key for the specified user needs to be obtained.
aliases: id |
|
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 |
|
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 . |
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 whose API signing keys must be retrieved
|
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 api signing keys of the specified user
oci_api_key_facts:
user_id: "ocid1.user.oc1..xxxxxEXAMPLExxxxx"
- name: Get details of a specific api signing key of a user
oci_api_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 | |
---|---|---|---|
api_keys
complex
|
on success |
Information about one or more api signing keys of the specified user
Sample:
{'api_keys': [{'lifecycle_state': 'ACTIVE', 'key_value': '-----BEGIN PUBLIC KEY-----...urt/fN8jNz2nZwIDAQAB-----END PUBLIC KEY-----', 'inactive_status': None, 'user_id': 'ocid1.user.oc1..xxxxxEXAMPLExxxxx', 'fingerprint': '08:07:a6:7d:06:b4:73:91:e9:2c:da:42:c8:cb:df:02', 'key_id': 'ocid1.tenancy.oc1..xxxxxEXAMPLExxxxx/ocid1.user.oc1..xxxxxEXAMPLExxxxx/08:07:a6:7d:06:b4:73:91:e9:2c:da', 'time_created': '2018-01-08T09:33:59.705000+00:00'}]}
|
|
key_value
string
|
always |
The key's value.
Sample:
-----BEGIN PUBLIC KEY-----...urt/fN8jNz2nZwIDAQAB-----END PUBLIC KEY-----
|
|
inactive_status
string
|
Only when the lifecycle_state is 'INACTIVE' |
The detailed status of INACTIVE lifecycleState.
|
|
user_id
string
|
always |
Date and time the ApiKey object was created, in the format defined by RFC3339.
Sample:
2016-08-25 21:10:29.600000
|
|
fingerprint
string
|
always |
The key's fingerprint
Sample:
12:34:56:78:90:ab:cd:ef:12:34:56:78:90:ab:cd:ef
|
|
lifecycle_status
string
|
always |
The API key's current state.
Sample:
ACTIVE
|
|
key_id
string
|
always |
The OCID of the API signing key. An Oracle-assigned identifier for the key, in this format TENANCY_OCID/USER_OCID/KEY_FINGERPRINT.
Sample:
ocid1.tenancy.oc1..xxxxxEXAMPLExxxxx/ocid1.user.oc1..xxxxxEXAMPLExxxxx/08:07:a6:7d:06:b4:73:91:e9:2c:da
|
Status¶
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
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.