confluent.cloud.api_key_info (0.1.0) — module

Install collection

Install with ansible-galaxy collection install confluent.cloud:==0.1.0

Add to requirements.yml

  collections:
    - name: confluent.cloud
      version: 0.1.0

Description

Enumerate and filter API keys within a Confluent Cloud environment.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: List all API keys in the Confluent Cloud org
  confluent.cloud.api_keys_info:

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: List API keys that match the given Ids
  confluent.cloud.api_keys_info:
    ids:
      - YU6F4EODE4OXXYD4
      - FL2Z7WMXO5KJOPZY

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: List API keys that match the given Names
  confluent.cloud.api_keys_info:
    names:
      - application_1

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: List API keys that match the given Owner
  confluent.cloud.api_keys_info:
    owners:
      - u-lgyjxv
      - u-ld9ok7

Inputs

    
ids:
    description:
    - List of API keys filtered by Id
    - Mutually exclusive when used with `names` or `owners`.
    elements: str
    type: list

names:
    description:
    - List of API keys filtered by name.
    - Mutually exclusive when used with `ids` or `owners`.
    elements: str
    type: list

owners:
    description:
    - The owner to which this API key belows
    - Mutually exclusive when used with `names` or `ids`.
    elements: str
    type: list

api_key:
    description: Confluent Cloud API Key
    required: true
    type: str

api_secret:
    description: Confluent Cloud API Secret
    required: true
    type: str

api_retries:
    default: 5
    description: Amount of max retries for the API requests.
    type: int

api_timeout:
    default: 60
    description: Timeout used for the API requests.
    type: int

api_endpoint:
    default: https://api.confluent.cloud
    description: Endpoint used for the API requests.
    type: str

validate_certs:
    default: true
    description: Whether to vaidate API endpoint TLS certs
    type: bool

api_retry_max_delay:
    default: 12
    description: Exponential backoff delay in seconds between retries up to this max delay
      value.
    type: int

Outputs

api_keys:
  contains:
    description:
      description: A free-form description of the API key
      returned: success
      sample: API Key 1
      type: str
    id:
      description: API key id
      returned: success
      sample: AX6SWFVF46SLIK2P
      type: str
    metadata:
      description: User metadata, including create timestamp and updated timestamp
      returned: success
      type: dict
    name:
      description: A human-readable name for the API key
      returned: success
      sample: api_key_1
      type: str
    owner:
      contains:
        id:
          description: Id for the owner
          returned: success
          sample: u-lgyjxv
          type: str
        kind:
          description: Kind of owner
          returned: success
          sample: User
          type: str
      description: API key owner
      returned: success
      type: dict
    resource:
      contains:
        id:
          description: Id for the resource
          returned: success
          sample: lkc-c29js0
          type: str
        kind:
          description: Kind of resource
          returned: success
          sample: User
          type: str
      description: cmk.v2.Cluster id (or null if not associated with a resource).
      returned: success
      type: dict
  description: Dictionary of matching API keys, keyed by API key id
  returned: success
  type: dict