api_keys

Creates, updates, deletes, gets or lists a api_keys resource.

Overview

Name	api_keys
Type	Resource
Id	confluent.iam.api_keys

Fields

Name	Datatype	Description
id	string	ID is the "natural identifier" for an object within its scope/namespace; it is normally unique across time but not space. That is, you can assume that the ID will not be reclaimed and reused after an object is deleted ("time"); however, it may collide with IDs for other object kinds or objects of the same kind within a different scope/namespace ("space").
_spec	object
api_version	string	APIVersion defines the schema version of this representation of a resource.
kind	string	Kind defines the object this REST resource represents.
metadata	``	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
spec	object	The desired state of the Api Key

Methods

Name	Accessible by	Required Params	Description
get_iam_v2api_key	SELECT	id	Make a request to read an API key.
list_iam_v2api_keys	SELECT		Retrieve a sorted, filtered, paginated list of all API keys. This can show all keys for a single owner (across resources - Kafka clusters), or all keys for a single resource (across owners). If no owner or resource filters are specified, returns all API Keys in the organization. You will only see the keys that are accessible to the account making the API request.
create_iam_v2api_key	INSERT		Make a request to create an API key.
delete_iam_v2api_key	DELETE	id	Make a request to delete an API key.
update_iam_v2api_key	UPDATE	id	Make a request to update an API key.

SELECT examples

Retrieve a sorted, filtered, paginated list of all API keys. This can show all keys for a single owner (across resources - Kafka clusters), or all keys for a single resource (across owners). If no owner or resource filters are specified, returns all API Keys in the organization. You will only see the keys that are accessible to the account making the API request.

SELECT
id,
_spec,
api_version,
kind,
metadata,
spec
FROM confluent.iam.api_keys
;

INSERT example

Use the following StackQL query and manifest file to create a new api_keys resource.

All Properties

/*+ create */
INSERT INTO confluent.iam.api_keys (
data__spec
)
SELECT 
'{{ spec }}'
;

Manifest

- name: api_keys
  props:
    - name: spec
      props:
        - name: owner
          value: string
        - name: resource
          value: string

UPDATE example

Updates a api_keys resource.

/*+ update */
UPDATE confluent.iam.api_keys
SET 
spec = '{{ spec }}'
WHERE 
id = '{{ id }}';

DELETE example

Deletes the specified api_keys resource.

/*+ delete */
DELETE FROM confluent.iam.api_keys
WHERE id = '{{ id }}';