confluent.cloud.service_account_info (0.1.0) — module

Get information on existing service accounts

| "added in version" 0.0.1 of confluent.cloud"

Authors: Keith Resar (@keithresar)

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 service accounts within a Confluent Cloud environment.

Note this is different than user accounts which uses its own module.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: List all service accounts in the Confluent Cloud org
  confluent.cloud.service_account_info:
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: List service accounts that match the given Ids
  confluent.cloud.service_account_info:
    ids:
      - sa-lz51vz
      - sa-logpdp
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: List service accounts that match the given Names
  confluent.cloud.service_account_info:
    names:
      - application_1

Inputs

    
ids:
    description:
    - List of service accounts filtered by Id
    - Mutually exclusive when used with `names`.
    elements: str
    type: list

names:
    description:
    - List of users filtered by name.
    - Mutually exclusive when used with `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

service_accounts:
  contains:
    description:
      description: A free-form description of the Service Account
      returned: success
      sample: Service account for Application 1
      type: str
    id:
      description: Service account id
      returned: success
      sample: sa-lz51vz
      type: str
    metadata:
      description: User metadata, including create timestamp and updated timestamp
      returned: success
      type: dict
    name:
      description: A human-readable name for the Service Account
      returned: success
      sample: application_1
      type: str
  description: Dictionary of matching users, keyed by user id
  returned: success
  type: dict