esp.terraform.tfe_user_token_info (0.1.0) — module

Install collection

Install with ansible-galaxy collection install esp.terraform:==0.1.0

Add to requirements.yml

  collections:
    - name: esp.terraform
      version: 0.1.0

Description

Lists user tokens.

The objects returned by this module only contain metadata, and do not include the secret text of any authentication tokens.

A token is only shown upon creation, and cannot be recovered later.

Usage examples

Scanned by Steampunk Spotter

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

- name: Retrieve details on all user tokens, user supplied by email
  esp.terraform.tfe_user_token_info:
    url: 'https://terraform.example.com'
    token: '{{ token }}'
    user: jsmith@example.com
    user_token:
      - '*'
    validate_certs: no
  register: _result

Scanned by Steampunk Spotter

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

- name: Retrieve details on all user tokens, user supplied by id
  esp.terraform.tfe_user_token_info:
    url: 'https://terraform.example.com'
    token: '{{ token }}'
    user: user-ctVahEhZNb22D5Se
    user_token:
      - '*'
    validate_certs: no
  register: _result

Scanned by Steampunk Spotter

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

- name: Retrieve details on the given user tokens, user supplied by login
  esp.terraform.tfe_user_token_info:
    url: 'https://terraform.example.com'
    token: '{{ token }}'
    user: ann_doe
    user_token:
      - at-QmATJea6aWj1xR2t
    validate_certs: no
  register: _result

Inputs

    
url:
    description:
    - Terraform Enterprise URL.
    required: false
    type: str

user:
    description:
    - Terraform user.
    - One may refer to a user either by its id, email or its name.
    required: true
    type: str

sleep:
    default: 5
    description:
    - Number of seconds to sleep between API retries.
    type: int

token:
    description:
    - All requests to Terraform Enterprise must be authenticated with a bearer token.
    - There are three kinds of token available, i.e. user tokens, team tokens and organization
      tokens.
    - See L(Authentication,https://www.terraform.io/docs/cloud/api/index.html#authentication).
    required: true
    type: str

retries:
    default: 3
    description:
    - Number of retries to call Terraform API URL before failure.
    type: int

use_proxy:
    default: true
    description:
    - If C(no), it will not use a proxy, even if one is defined in an environment variable
      on the target hosts.
    type: bool

user_token:
    default:
    - '*'
    description:
    - List of user tokens to retrieve details for.
    - This can be '*' which means all user tokens.
    required: false
    type: list

validate_certs:
    default: true
    description:
    - If C(no), SSL certificates will not be validated.
    - This should only set to C(no) used on personally controlled sites using self-signed
      certificates.
    type: bool

Outputs

json:
  contains:
    data:
      description: Details on user tokens.
      elements: dict
      returned: success
      sample:
      - attributes:
          created-at: '2021-04-20T11:21:10.755000+00:00'
          description: user token
          last-used-at: '2021-04-25T22:36:14.038000+00:00'
          token: null
        id: at-zkxJyuwX6MMhQWEw
        relationships:
          created-by:
            data:
              id: user-K1LWGyjmnDL59y4H
              type: users
        type: authentication-tokens
      type: list
  description: Details on user tokens.
  returned: success
  type: dict