oracle.oci.oci_object_storage_preauthenticated_request – Manage a PreauthenticatedRequest resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install oracle.oci
.
To use it in a playbook, specify: oracle.oci.oci_object_storage_preauthenticated_request
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create and delete a PreauthenticatedRequest resource in Oracle Cloud Infrastructure
For state=present, creates a pre-authenticated request specific to the bucket.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
Parameters¶
Parameter | Choices/Defaults | Comments |
---|---|---|
access_type
string
|
|
The operation that can be performed on this resource.
Required for create using 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_purpose
string
|
|
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
|
auth_type
string
|
|
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_listing_action
string
|
Specifies whether a list operation is allowed on a PAR with accessType "AnyObjectRead" or "AnyObjectReadWrite". Deny: Prevents the user from performing a list operation. ListObjects: Authorizes the user to perform a list operation.
|
|
bucket_name
string
/ required
|
The name of the bucket. Avoid entering confidential information. Example: `my-new-bucket1`
|
|
cert_bundle
string
|
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
|
|
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
|
|
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
/ elements=string
|
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
|
|
name
string
|
A user-specified name for the pre-authenticated request. Names can be helpful in managing pre-authenticated requests. Avoid entering confidential information.
Required for create using state=present.
Required for delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set. |
|
namespace_name
string
/ required
|
The Object Storage namespace used for the request.
|
|
object_name
string
|
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 if the access type allows that. The object name can be a prefix as well, in that case pre-authenticated request grants access to all the objects within the bucket starting with that prefix provided that we have the correct access type.
|
|
par_id
string
|
The unique identifier for the pre-authenticated request. This can be used to manage operations against the pre-authenticated request, such as GET or DELETE.
Required for delete using state=absent when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: id |
|
realm_specific_endpoint_template_enabled
boolean
|
|
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
|
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
string
|
|
The state of the PreauthenticatedRequest.
Use state=present to create a PreauthenticatedRequest.
Use state=absent to delete a PreauthenticatedRequest.
|
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
string
|
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 for create using state=present.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create preauthenticated_request
oci_object_storage_preauthenticated_request:
# required
name: name_example
access_type: ObjectRead
time_expires: time_expires_example
namespace_name: namespace_name_example
bucket_name: bucket_name_example
# optional
bucket_listing_action: bucket_listing_action_example
object_name: object_name_example
- name: Delete preauthenticated_request
oci_object_storage_preauthenticated_request:
# required
namespace_name: namespace_name_example
bucket_name: bucket_name_example
par_id: "ocid1.par.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete preauthenticated_request using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_object_storage_preauthenticated_request:
# required
name: name_example
namespace_name: namespace_name_example
bucket_name: bucket_name_example
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
|
on success |
Details of the PreauthenticatedRequest resource acted upon by the current operation
Sample:
{'access_type': 'ObjectRead', 'bucket_listing_action': 'bucket_listing_action_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'name': 'name_example', 'object_name': 'object_name_example', 'time_created': '2013-10-20T19:20:30+01:00', 'time_expires': '2013-10-20T19:20:30+01:00'}
|
|
access_type
string
|
on success |
The operation that can be performed on this resource.
Sample:
ObjectRead
|
|
bucket_listing_action
string
|
on success |
Specifies whether a list operation is allowed on a PAR with accessType "AnyObjectRead" or "AnyObjectReadWrite". Deny: Prevents the user from performing a list operation. ListObjects: Authorizes the user to perform a list operation.
Sample:
bucket_listing_action_example
|
|
id
string
|
on success |
The unique identifier to use when directly addressing the pre-authenticated request.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|
name
string
|
on success |
The user-provided name of the pre-authenticated request.
Sample:
name_example
|
|
object_name
string
|
on success |
The name of object that is being granted access to by the pre-authenticated request. This can be null and if it is, the pre-authenticated request grants access to the entire bucket.
Sample:
object_name_example
|
|
time_created
string
|
on success |
The date when the pre-authenticated request was created as per RFC 3339.
Sample:
2013-10-20T19:20:30+01:00
|
|
time_expires
string
|
on success |
The expiration date for the pre-authenticated request as per RFC 3339. After this date the pre- authenticated request will no longer be valid.
Sample:
2013-10-20T19:20:30+01:00
|
Authors¶
Oracle (@oracle)