BdsApiKey¶

class oci.bds.models.BdsApiKey(**kwargs)¶

Bases: object

The API key information.

Attributes

`LIFECYCLE_STATE_ACTIVE`	A constant which can be used with the lifecycle_state property of a BdsApiKey.
`LIFECYCLE_STATE_CREATING`	A constant which can be used with the lifecycle_state property of a BdsApiKey.
`LIFECYCLE_STATE_DELETED`	A constant which can be used with the lifecycle_state property of a BdsApiKey.
`LIFECYCLE_STATE_DELETING`	A constant which can be used with the lifecycle_state property of a BdsApiKey.
`LIFECYCLE_STATE_FAILED`	A constant which can be used with the lifecycle_state property of a BdsApiKey.
`default_region`	[Required] Gets the default_region of this BdsApiKey.
`domain_ocid`	Gets the domain_ocid of this BdsApiKey.
`fingerprint`	[Required] Gets the fingerprint of this BdsApiKey.
`id`	[Required] Gets the id of this BdsApiKey.
`key_alias`	[Required] Gets the key_alias of this BdsApiKey.
`lifecycle_state`	[Required] Gets the lifecycle_state of this BdsApiKey.
`pemfilepath`	[Required] Gets the pemfilepath of this BdsApiKey.
`tenant_id`	[Required] Gets the tenant_id of this BdsApiKey.
`time_created`	Gets the time_created of this BdsApiKey.
`user_id`	[Required] Gets the user_id of this BdsApiKey.

Methods

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

LIFECYCLE_STATE_ACTIVE = 'ACTIVE'¶: A constant which can be used with the lifecycle_state property of a BdsApiKey. This constant has a value of “ACTIVE”

LIFECYCLE_STATE_CREATING = 'CREATING'¶: A constant which can be used with the lifecycle_state property of a BdsApiKey. This constant has a value of “CREATING”

LIFECYCLE_STATE_DELETED = 'DELETED'¶: A constant which can be used with the lifecycle_state property of a BdsApiKey. This constant has a value of “DELETED”

LIFECYCLE_STATE_DELETING = 'DELETING'¶: A constant which can be used with the lifecycle_state property of a BdsApiKey. This constant has a value of “DELETING”

LIFECYCLE_STATE_FAILED = 'FAILED'¶: A constant which can be used with the lifecycle_state property of a BdsApiKey. This constant has a value of “FAILED”

__init__(**kwargs)¶

Initializes a new BdsApiKey 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 BdsApiKey.
user_id (str) – The value to assign to the user_id property of this BdsApiKey.
key_alias (str) – The value to assign to the key_alias property of this BdsApiKey.
default_region (str) – The value to assign to the default_region property of this BdsApiKey.
tenant_id (str) – The value to assign to the tenant_id property of this BdsApiKey.
fingerprint (str) – The value to assign to the fingerprint property of this BdsApiKey.
pemfilepath (str) – The value to assign to the pemfilepath property of this BdsApiKey.
time_created (datetime) – The value to assign to the time_created property of this BdsApiKey.
lifecycle_state (str) – The value to assign to the lifecycle_state property of this BdsApiKey. Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.
domain_ocid (str) – The value to assign to the domain_ocid property of this BdsApiKey.

default_region¶

[Required] Gets the default_region of this BdsApiKey. The name of the region to establish the Object Storage endpoint. Example us-phoenix-1 .

Returns:	The default_region of this BdsApiKey.
Return type:	str

domain_ocid¶

Gets the domain_ocid of this BdsApiKey. Identity domain OCID ,where user is present. For default domain ,this field will be optional.

Returns:	The domain_ocid of this BdsApiKey.
Return type:	str

fingerprint¶

[Required] Gets the fingerprint of this BdsApiKey. The fingerprint that corresponds to the public API key requested.

Returns:	The fingerprint of this BdsApiKey.
Return type:	str

id¶

[Required] Gets the id of this BdsApiKey. Identifier of the user’s API key.

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

key_alias¶

[Required] Gets the key_alias of this BdsApiKey. User friendly identifier used to uniquely differentiate between different API keys. Only ASCII alphanumeric characters with no spaces allowed.

Returns:	The key_alias of this BdsApiKey.
Return type:	str

lifecycle_state¶

[Required] Gets the lifecycle_state of this BdsApiKey. The state of the key.

Allowed values for this property are: “CREATING”, “ACTIVE”, “DELETING”, “DELETED”, “FAILED”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:	The lifecycle_state of this BdsApiKey.
Return type:	str

pemfilepath¶

[Required] Gets the pemfilepath of this BdsApiKey. The full path and file name of the private key used for authentication. This location will be automatically selected on the BDS local file system.

Returns:	The pemfilepath of this BdsApiKey.
Return type:	str

tenant_id¶

[Required] Gets the tenant_id of this BdsApiKey. The OCID of your tenancy.

Returns:	The tenant_id of this BdsApiKey.
Return type:	str

time_created¶

Gets the time_created of this BdsApiKey. The time the API key was created, shown as an RFC 3339 formatted datetime string.

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

user_id¶

[Required] Gets the user_id of this BdsApiKey. The user OCID for which this API key was created.

Returns:	The user_id of this BdsApiKey.
Return type:	str