oci_auth_token_facts – Fetches details about one or multiple AuthToken resources in Oracle Cloud Infrastructure

New in version 2.5.

Synopsis

  • Fetches details about one or multiple AuthToken resources in Oracle Cloud Infrastructure
  • Lists the auth tokens for the specified user. The returned object contains the token’s OCID, but not the token itself. The actual token is returned only upon creation.

Requirements

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

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.
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.
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
user_id
- / required
The OCID of the user.

Examples

- name: List auth_tokens
  oci_auth_token_facts:
    user_id: ocid1.user.oc1..xxxxxxEXAMPLExxxxxx

Return Values

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

Key Returned Description
auth_tokens
complex
 on success
List of AuthToken resources

Sample:
[{'token': 'token_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'description': 'description_example', 'inactive_status': 56, 'time_created': '2016-08-25T21:10:29.600Z', 'lifecycle_state': 'CREATING', 'user_id': 'ocid1.user.oc1..xxxxxxEXAMPLExxxxxx', 'time_expires': '2016-08-25T21:10:29.600Z'}]
  description
string
 on success
The description you assign to the auth token. Does not have to be unique, and it's changeable.

Sample:
description_example
  id
string
 on success
The OCID of the auth token.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
  inactive_status
integer
 on success
The detailed status of INACTIVE lifecycleState.

Sample:
56
  lifecycle_state
string
 on success
The token's current state. After creating an auth token, make sure its `lifecycleState` changes from CREATING to ACTIVE before using it.

Sample:
CREATING
  time_created
string
 on success
Date and time the `AuthToken` object was created, in the format defined by RFC3339.
Example: `2016-08-25T21:10:29.600Z`

Sample:
2016-08-25 21:10:29.600000+00:00
  time_expires
string
 on success
Date and time when this auth token will expire, in the format defined by RFC3339. Null if it never expires.
Example: `2016-08-25T21:10:29.600Z`

Sample:
2016-08-25 21:10:29.600000+00:00
  token
string
 on success
The auth token. The value is available only in the response for `CreateAuthToken`, and not for `ListAuthTokens` or `UpdateAuthToken`.

Sample:
token_example
  user_id
string
 on success
The OCID of the user the auth token belongs to.

Sample:
ocid1.user.oc1..xxxxxxEXAMPLExxxxxx


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)
  • Mike Ross (@mross22)
  • Nabeel Al-Saber (@nalsaber)

Hint

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