PreauthenticatedRequest¶

class oci.object_storage.models.PreauthenticatedRequest(**kwargs)¶

Bases: object

Pre-authenticated requests provide a way to let users access a bucket or an object without having their own credentials. When you create a pre-authenticated request, a unique URL is generated. Users in your organization, partners, or third parties can use this URL to access the targets identified in the pre-authenticated request. See Using Pre-Authenticated Requests.

To use any of the API operations, you must be authorized in an IAM policy. If you are not authorized, talk to an administrator. If you are an administrator who needs to write policies to give users access, see Getting Started with Policies.

Attributes

`ACCESS_TYPE_ANY_OBJECT_READ`	A constant which can be used with the access_type property of a PreauthenticatedRequest.
`ACCESS_TYPE_ANY_OBJECT_READ_WRITE`	A constant which can be used with the access_type property of a PreauthenticatedRequest.
`ACCESS_TYPE_ANY_OBJECT_WRITE`	A constant which can be used with the access_type property of a PreauthenticatedRequest.
`ACCESS_TYPE_OBJECT_READ`	A constant which can be used with the access_type property of a PreauthenticatedRequest.
`ACCESS_TYPE_OBJECT_READ_WRITE`	A constant which can be used with the access_type property of a PreauthenticatedRequest.
`ACCESS_TYPE_OBJECT_WRITE`	A constant which can be used with the access_type property of a PreauthenticatedRequest.
`BUCKET_LISTING_ACTION_DENY`	A constant which can be used with the bucket_listing_action property of a PreauthenticatedRequest.
`BUCKET_LISTING_ACTION_LIST_OBJECTS`	A constant which can be used with the bucket_listing_action property of a PreauthenticatedRequest.
`access_type`	[Required] Gets the access_type of this PreauthenticatedRequest.
`access_uri`	[Required] Gets the access_uri of this PreauthenticatedRequest.
`bucket_listing_action`	Gets the bucket_listing_action of this PreauthenticatedRequest.
`full_path`	Gets the full_path of this PreauthenticatedRequest.
`id`	[Required] Gets the id of this PreauthenticatedRequest.
`name`	[Required] Gets the name of this PreauthenticatedRequest.
`object_name`	Gets the object_name of this PreauthenticatedRequest.
`time_created`	[Required] Gets the time_created of this PreauthenticatedRequest.
`time_expires`	[Required] Gets the time_expires of this PreauthenticatedRequest.

Methods

__init__(**kwargs) Initializes a new PreauthenticatedRequest object with values from keyword arguments.

ACCESS_TYPE_ANY_OBJECT_READ = 'AnyObjectRead'¶: A constant which can be used with the access_type property of a PreauthenticatedRequest. This constant has a value of “AnyObjectRead”

ACCESS_TYPE_ANY_OBJECT_READ_WRITE = 'AnyObjectReadWrite'¶: A constant which can be used with the access_type property of a PreauthenticatedRequest. This constant has a value of “AnyObjectReadWrite”

ACCESS_TYPE_ANY_OBJECT_WRITE = 'AnyObjectWrite'¶: A constant which can be used with the access_type property of a PreauthenticatedRequest. This constant has a value of “AnyObjectWrite”

ACCESS_TYPE_OBJECT_READ = 'ObjectRead'¶: A constant which can be used with the access_type property of a PreauthenticatedRequest. This constant has a value of “ObjectRead”

ACCESS_TYPE_OBJECT_READ_WRITE = 'ObjectReadWrite'¶: A constant which can be used with the access_type property of a PreauthenticatedRequest. This constant has a value of “ObjectReadWrite”

ACCESS_TYPE_OBJECT_WRITE = 'ObjectWrite'¶: A constant which can be used with the access_type property of a PreauthenticatedRequest. This constant has a value of “ObjectWrite”

BUCKET_LISTING_ACTION_DENY = 'Deny'¶: A constant which can be used with the bucket_listing_action property of a PreauthenticatedRequest. This constant has a value of “Deny”

BUCKET_LISTING_ACTION_LIST_OBJECTS = 'ListObjects'¶: A constant which can be used with the bucket_listing_action property of a PreauthenticatedRequest. This constant has a value of “ListObjects”

__init__(**kwargs)¶

Initializes a new PreauthenticatedRequest object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:

id (str) – The value to assign to the id property of this PreauthenticatedRequest.
name (str) – The value to assign to the name property of this PreauthenticatedRequest.
access_uri (str) – The value to assign to the access_uri property of this PreauthenticatedRequest.
object_name (str) – The value to assign to the object_name property of this PreauthenticatedRequest.
bucket_listing_action (str) – The value to assign to the bucket_listing_action property of this PreauthenticatedRequest. Allowed values for this property are: “Deny”, “ListObjects”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
access_type (str) – The value to assign to the access_type property of this PreauthenticatedRequest. Allowed values for this property are: “ObjectRead”, “ObjectWrite”, “ObjectReadWrite”, “AnyObjectWrite”, “AnyObjectRead”, “AnyObjectReadWrite”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
time_expires (datetime) – The value to assign to the time_expires property of this PreauthenticatedRequest.
time_created (datetime) – The value to assign to the time_created property of this PreauthenticatedRequest.
full_path (str) – The value to assign to the full_path property of this PreauthenticatedRequest.

access_type¶

[Required] Gets the access_type of this PreauthenticatedRequest. The operation that can be performed on this resource.

Allowed values for this property are: “ObjectRead”, “ObjectWrite”, “ObjectReadWrite”, “AnyObjectWrite”, “AnyObjectRead”, “AnyObjectReadWrite”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The access_type of this PreauthenticatedRequest.
Return type:	str

access_uri¶

[Required] Gets the access_uri of this PreauthenticatedRequest. The URI to embed in the URL when using the pre-authenticated request.

Returns:	The access_uri of this PreauthenticatedRequest.
Return type:	str

bucket_listing_action¶

Gets the bucket_listing_action of this PreauthenticatedRequest. 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.

Allowed values for this property are: “Deny”, “ListObjects”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The bucket_listing_action of this PreauthenticatedRequest.
Return type:	str

full_path¶

Gets the full_path of this PreauthenticatedRequest. The full Path for the object.

Returns:	The full_path of this PreauthenticatedRequest.
Return type:	str

id¶

[Required] Gets the id of this PreauthenticatedRequest. The unique identifier to use when directly addressing the pre-authenticated request.

Returns:	The id of this PreauthenticatedRequest.
Return type:	str

name¶

[Required] Gets the name of this PreauthenticatedRequest. The user-provided name of the pre-authenticated request.

Returns:	The name of this PreauthenticatedRequest.
Return type:	str

object_name¶

Gets the object_name of this PreauthenticatedRequest. 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. Example: test/object1.log

Returns:	The object_name of this PreauthenticatedRequest.
Return type:	str

time_created¶

[Required] Gets the time_created of this PreauthenticatedRequest. The date when the pre-authenticated request was created as per specification RFC 3339.

Returns:	The time_created of this PreauthenticatedRequest.
Return type:	datetime

time_expires¶

[Required] Gets the time_expires of this PreauthenticatedRequest. The expiration date for the pre-authenticated request as per RFC 3339. After this date the pre-authenticated request will no longer be valid.

Returns:	The time_expires of this PreauthenticatedRequest.
Return type:	datetime