Try SpotterFetches details about one or multiple PreauthenticatedRequest resources in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0Fetches details about one or multiple PreauthenticatedRequest resources in Oracle Cloud Infrastructure
Lists pre-authenticated requests for the bucket.
If I(par_id) is specified, the details of a single PreauthenticatedRequest will be returned.
- name: Get a specific preauthenticated_request
oci_object_storage_preauthenticated_request_facts:
# required
par_id: "ocid1.par.oc1..xxxxxxEXAMPLExxxxxx"
namespace_name: namespace_name_example
bucket_name: bucket_name_example
- name: List preauthenticated_requests
oci_object_storage_preauthenticated_request_facts:
# required
namespace_name: namespace_name_example
bucket_name: bucket_name_example
# optional
object_name_prefix: object_name_prefix_example
name:
description: Use I(name) along with the other options to return only resources that
match the given name exactly.
type: str
par_id:
aliases:
- id
description:
- 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 to get a specific preauthenticated_request.
type: str
region:
description:
- 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 C(config_file_location)).
Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm)
for more information on OCI regions.
type: str
tenancy:
description:
- 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 C(config_file_location)). To get the tenancy OCID, please
refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm)
type: str
api_user:
description:
- 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 C(config_file_location)).
To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
auth_type:
choices:
- api_key
- instance_principal
- instance_obo_user
- resource_principal
- security_token
default: api_key
description:
- The type of authentication to use for making API requests. By default C(auth_type="api_key")
based authentication is performed and the API key (see I(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 C(auth_type="instance_principal")
to use instance principal based authentication when running ansible playbooks within
an OCI compute instance.
type: str
bucket_name:
description:
- 'The name of the bucket. Avoid entering confidential information. Example: `my-new-bucket1`'
required: true
type: str
cert_bundle:
description:
- 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.
type: str
auth_purpose:
choices:
- service_principal
description:
- The auth purpose which can be used in conjunction with 'auth_type=instance_principal'.
The default auth_purpose for instance_principal is None.
type: str
namespace_name:
description:
- The Object Storage namespace used for the request.
required: true
type: str
api_user_key_file:
description:
- 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 C(config_file_location)).
If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option
must also be provided.
type: str
object_name_prefix:
description:
- User-specified object name prefixes can be used to query and return a list of pre-authenticated
requests.
type: str
config_profile_name:
description:
- The profile to load from the config file referenced by C(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 C(config_file_location).
type: str
api_user_fingerprint:
description:
- 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 C(config_file_location)). To
get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm).
type: str
config_file_location:
description:
- 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.
type: str
api_user_key_pass_phrase:
description:
- Passphrase used by the key referenced in C(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 C(config_file_location)).
type: str
realm_specific_endpoint_template_enabled:
description:
- 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.
type: bool
preauthenticated_requests:
contains:
access_type:
description:
- The operation that can be performed on this resource.
returned: on success
sample: ObjectRead
type: str
bucket_listing_action:
description:
- '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.'
returned: on success
sample: bucket_listing_action_example
type: str
id:
description:
- The unique identifier to use when directly addressing the pre-authenticated
request.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
name:
description:
- The user-provided name of the pre-authenticated request.
returned: on success
sample: name_example
type: str
object_name:
description:
- 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.
returned: on success
sample: object_name_example
type: str
time_created:
description:
- The date when the pre-authenticated request was created as per L(RFC 3339,https://tools.ietf.org/html/rfc3339).
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
time_expires:
description:
- The expiration date for the pre-authenticated request as per L(RFC 3339,https://tools.ietf.org/html/rfc3339).
After this date the pre- authenticated request will no longer be valid.
returned: on success
sample: '2013-10-20T19:20:30+01:00'
type: str
description:
- List of PreauthenticatedRequest resources
returned: on success
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'
type: complex