confluent.cloud.user_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 users within a Confluent Cloud environment.

Includes named users already setup and those who are invited by not yet activate.

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

Usage examples

Scanned by Steampunk Spotter

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

- name: List all users in the Confluent Cloud org
  confluent.cloud.user_info:

Scanned by Steampunk Spotter

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

- name: List users that match the given Ids
  confluent.cloud.user_info:
    ids:
      - u-l6xn83
      - u-ld9ok7

Scanned by Steampunk Spotter

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

- name: List users that match the given Names
  confluent.cloud.user_info:
    names:
      - John Smith

Scanned by Steampunk Spotter

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

- name: List users that match the given Emails
  confluent.cloud.user_info:
    names:
      - john@example.com
      - john.smith@example.com

Inputs

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

names:
    description:
    - List of users filtered by full name.
    - Mutually exclusive when used with `ids` or `emails`.
    elements: str
    type: list

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

users:
  contains:
    email:
      description: The user's email address
      returned: success
      sample: john.smith@example.com
      type: str
    full_name:
      description: The user's full name
      returned: success
      sample: John Smith
      type: str
    id:
      description: User id
      returned: success
      sample: u-j31z28
      type: str
    metadata:
      description: User metadata, including create timestamp and updated timestamp
      returned: success
      type: dict
  description: Dictionary of matching users, keyed by user id
  returned: success
  type: dict