confluent.cloud.user (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

Manage existing Confluent Cloud 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: Update existing user name
  confluent.cloud.user:
    name: John Smith
    id: u-j31z28
    state: present

Scanned by Steampunk Spotter

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

- name: Delete user (by id)
  confluent.cloud.user:
    id: u-j31z28
    state: absent

Scanned by Steampunk Spotter

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

- name: Delete user (by email)
  confluent.cloud.user:
    email: john.smith@example.com
    state: absent

Inputs

    
id:
    description: User Id
    type: str

name:
    description:
    - User's full name
    - Mutation after creation requires supplying the user id.
    - Mutation requires authentication with Cloud API keys owned this the user being changed
    type: str

email:
    description:
    - The user's email address.
    - Immutable after deployment.
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - If `absent`, the user will be removed. Note that absent will not cause User to fail
      if the User does not exist.
    - If `present`, the user will be invited.
    type: str

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

email:
  description: User email
  returned: success
  sample: john.smith@example.com
  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
name:
  description: User full name
  returned: success
  sample: John Smith
  type: str