oci_preauthenticated_request – Create and delete an OCI Preauthenticated Request¶

New in version 2.5.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis ¶

Create a new OCI Preauthenticated Request for a bucket or an object
Delete an OCI Preauthenticated Request, if present
Note that the unique URL provided by the system when you create a pre-authenticated request is the only way a user can access the bucket or object specified as the request target. Copy the URL to durable storage. The URL is returned only at the time of creation and cannot be retrieved later.

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
access_type -	Choices: ObjectRead ObjectWrite ObjectReadWrite AnyObjectWrite	The expiration date for the pre-authenticated request as per RFC 3339. After this date the pre-authenticated request will no longer be valid. Required while creating a Preauthenticated request with state=present.
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.
bucket_name -		The name of the bucket. Avoid entering confidential information.
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`.
force_create boolean	Choices: no ← yes	Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
key_by list		The list of comma-separated attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource except freeform_tags are used to uniquely identify a resource.
name -		A user-specified name for the pre-authenticated request. Names can be helpful in managing pre-authenticated requests. Required while creating a Preauthenticated request with state=present. aliases: display_name
namespace_name - / required		The Object Storage namespace used for the request.
object_name -		The name of the object that is being granted access to by the pre-authenticated request. Avoid entering confidential information. The object name can be null and if so, the pre-authenticated request grants access to the entire bucket.
par_id -		Identifier of the Preauthenticated Request. Mandatory for delete. 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.
state -	Choices: present ← absent	Create or delete Preauthenticated Request. Use state=present to create a Preauthenticated request and state=absent to delete a Preauthenticated request.
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
time_expires -		The expiration date for the pre-authenticated request as per RFC 3339. After this date the pre-authenticated request will no longer be valid.
wait boolean	Choices: no yes ←	Whether to wait for create or delete operation to complete.
wait_timeout integer	Default: 2000	Time, in seconds, to wait when wait=yes.
wait_until string		The lifecycle state to wait for the resource to transition into when wait=yes. By default, when wait=yes, we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.

Notes ¶

Note

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

Examples ¶

# Note: These examples do not set authentication details.
# Create Preauthenticated Request for Entire Bucket
- name: Create Preauthenticated Request for a Bucket and permit uploading one or more objects to it
  oci_preauthenticated_request:
    namespace_name: 'us-example-1'
    bucket_name: 'ansible_bucket'
    name: 'ansible_bucket_par'
    access_type: 'AnyObjectWrite'
    time_expires: '2018-12-22T00:00:00+00:00'
    state: 'present'

# Create Preauthenticated Request for Entire Bucket
- name: Create Preauthenticated Request for a specific Object and permit writes to the object
  oci_preauthenticated_request:
    namespace_name: 'us-example-1'
    bucket_name: 'ansible_bucket'
    object_name: 'ansible_object'
    name: 'ansible_object_par'
    access_type: 'ObjectWrite'
    time_expires: '2018-12-22T00:00:00+00:00'
    state: 'present'

# Delete Preauthenticated Request
- name: Delete an existing Preauthenticated Request
  oci_preauthenticated_request:
    namespace_name: 'us-example-1'
    bucket_name: 'ansible_bucket'
    par_id: 'fEbFqu0/thO3JqpA/MRVbD/BpE='
    state: 'absent'

Return Values ¶

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

Key		Returned	Description
preauthenticated_request complex		success	Attributes of the created Preauthenticated Request. For delete, deleted Preauthenticated Request description will be returned. Sample: {'name': 'ansible_bucket_par', 'id': 'EbFqu0/thO3/MRVb/XmZ0iaT6IA=', 'object_name': 'ansible_object', 'access_type': 'AnyObjectWrite', 'time_expires': '2018-12-23T17:31:35+00:00', 'access_uri': '/p/TF0WATak/n/us-example-1/b/ansible_bucket/o/ansible_object', '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
	access_uri string	always	The URI to embed in the URL when using the pre-authenticated request. Sample: /p/TF0WATak6uM7AU4PXA/n/us-example-1/b/ansible_bucket/o/
	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+00:00
	time_expires datetime	always	The expiration date for the pre-authenticated request as per RFC 3339. Sample: 2018-12-22 00:00: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.

oci_preauthenticated_request – Create and delete an OCI Preauthenticated Request¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶