oci_preauthenticated_request_facts – Fetches details of existing OCI Preauthenticated Requests

New in version 2.5.

Synopsis

  • Fetches details of all OCI Preauthenticated Requests for a specific Bucket or an OCI Preauthenticated Request

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_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
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
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.
bucket_name
- / required
Bucket name from which details of all preauthenticated-requests must be fetched.
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.
namespace_name
- / required
Namespace name from which details of all preauthenticated-requests must be fetched.
object_name_prefix
-
User-specified object name prefixes can be used to query and return a list of pre-authenticated requests.
par_id
-
Identifier of the preauthenticated-request. Required if the details of a specific preauthenticated-request details needs to be fetched.

aliases: id
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

Examples

# Fetch Preauthenticated Request
- name: List all Preauthenticated Request of a Bucket
  oci_preauthenticated_request_facts:
    namespace_name: 'us-example-1'
    bucket_name: 'ansible_bucket'

# Fetch Preauthenticated Request for a specific Object
- name: List Preauthenticated Request for objects with a specified name prefix
  oci_preauthenticated_request_facts:
    namespace_name: 'us-example-1'
    bucket_name: 'ansible_bucket'
    object_name_prefix: 'ansible_object'

# Fetch a specific Preauthenticated Request
- name: List a specific Preauthenticated Request
  oci_preauthenticated_request_facts:
    namespace_name: 'us-example-1'
    bucket_name: 'ansible_bucket'
    par_id: 'fEbFqu0/thO3JqpA/MRVbD/BpE='

Return Values

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

Key Returned Description
preauthenticated_requests
complex
success
Attributes of the Fetched Preauthenticated Request.

Sample:
[{'object_name': 'ansible_object', 'name': 'ansible_bucket_par', 'access_type': 'AnyObjectWrite', 'time_expires': '2018-12-23T17:31:35+00:00', 'id': 'EbFqu0/thO3/MRVb/XmZ0iaT6IA=', 'time_created': '2018-12-22T12:04:02.229000+00:00'}]
  access_type
string
always
The collection of rules for routing destination IPs to network devices.

Sample:
AnyObjectWrite
  id
string
always
Identifier of the Preauthenticated Request

Sample:
fEbFqu0/thO3JqpA/MRVbD/BpE=
  name
string
always
The user-provided name of the pre-authenticated request.

Sample:
ansible_bucker_par
  object_name
string
always
The name of the object that is being granted access to by the pre-authenticated request.

Sample:
ansible_object
  time_created
datetime
always
The date when the pre-authenticated request was created as per specification RFC 3339.

Sample:
2018-12-22 12:04:02.229000
  time_expires
datetime
always
The expiration date for the pre-authenticated request as per RFC 3339.

Sample:
2018-12-22 00: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

  • Debayan Gupta(@debayan_gupta)

Hint

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