API Key

Docs > DDSQL Reference > Data Directory > API Key

An API Key in Oracle Cloud Infrastructure (OCI) is a public key that you upload to your user account to enable secure authentication when using the OCI Command Line Interface (CLI), SDKs, or API calls. It works with a corresponding private key stored locally, allowing you to sign requests without using a password. This provides a secure and convenient way to automate and manage OCI resources programmatically.

oci.identitydomains_api_key

Fields

ID	Type	Data Type	Description
_key	core	string
cloud_account_id	core	string	The identifier of the related cloud account. The concept of an account might have different names in different cloud providers. AWS is calling it account, GCP calls it project and Azure uses the term subscription.
cloud_account_name	core	string	The name of the account this resource belongs to.
cloud_provider	core	string	The name of the cloud provider.
cloud_tags	core	hstore
compartment_id	core	string	Compartment containing the resource. Used for Access control, logical grouping, and authorization boundaries.
compartment_ocid	core	string	The value to assign to the compartment_ocid property of this ApiKey.
created_at	core	timestamp	Time when the resource has been created.
delete_in_progress	core	bool	The value to assign to the delete_in_progress property of this ApiKey.
description	core	string	The value to assign to the description property of this ApiKey.
domain_ocid	core	string	The value to assign to the domain_ocid property of this ApiKey.
fingerprint	core	string	The value to assign to the fingerprint property of this ApiKey.
freeform_tags	core	hstore	The value to assign to the freeform_tags property of this Instance.
id	core	string	The value to assign to the id property of this ApiKey.
idcs_created_by	core	json	The value to assign to the idcs_created_by property of this ApiKey.
idcs_last_modified_by	core	json	The value to assign to the idcs_last_modified_by property of this ApiKey.
idcs_last_upgraded_in_release	core	string	The value to assign to the idcs_last_upgraded_in_release property of this ApiKey.
idcs_prevented_operations	core	array<string>	The value to assign to the idcs_prevented_operations property of this ApiKey. Allowed values for items in this list are: "replace", "update", "delete", 'UNKNOWN_ENUM_VALUE'. Any unrecognized values returned by a service will be mapped to 'UNKNOWN_ENUM_VALUE'.
key	core	string	The value to assign to the key property of this ApiKey.
meta	core	json	The value to assign to the meta property of this ApiKey.
name	core	string	The name of this resource.
ocid	core	string	The value to assign to the ocid property of this ApiKey.
region_id	core	string	The region this resource resides within.
resource_type	core	string	The name of the resource type.
schemas	core	array<string>	The value to assign to the schemas property of this ApiKey.
tags	core	hstore_csv	The value to assign to the tags property of this ApiKey.
tenancy_ocid	core	string	The value to assign to the tenancy_ocid property of this ApiKey.
time_created	core	timestamp	The value to assign to the time_created property of this Instance.
updated_at	core	timestamp	Time when the resource has been updated the last time.
user	core	json	The value to assign to the user property of this ApiKey.
zone_id	core	string	The zone this resource resides within.