esp.terraform.tfe_team_membership_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 team memberships.

Usage examples

Scanned by Steampunk Spotter

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

- name: Retrieve details on all team members
  esp.terraform.tfe_team_membership_info:
    url: 'https://terraform.example.com'
    token: '{{ token }}'
    organization: foo
    team: developers
    validate_certs: no
  register: _result

Inputs

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

team:
    description:
    - Terraform team to list the memberships of.
    - The team may be referred either by its id 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

organization:
    description:
    - Organization name.
    required: true
    type: str

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 team.
      returned: success
      sample:
        attributes:
          name: owners
          organization-access:
            manage-policies: true
            manage-vcs-settings: true
            manage-workspaces: true
          permissions:
            can-destroy: false
            can-update-api-token: true
            can-update-membership: true
            can-update-organization-access: false
            can-update-visibility: false
          users-count: 1
          visibility: secret
        id: team-VQ1FncissQs9Bom8
        links:
          self: /api/v2/teams/team-VQ1FncissQs9Bom8
        relationships:
          authentication-token:
            meta: {}
          organization:
            data:
              id: foo
              type: organizations
          organization-memberships:
            data:
            - id: ou-SKVvnWhoTxWrofkE
              type: organization-memberships
          users:
            data:
            - id: user-K1LWGyjmnDL59y4H
              type: users
        type: teams
      type: dict
    members:
      description: Details on memberships.
      elements: dict
      returned: success
      sample:
      - attributes:
          avatar-url: https://www.gravatar.com/avatar/73e8b34b8de0f050f5fdd7960ef0c756?s=100&d=mm
          is-service-account: false
          permissions:
            can-change-email: false
            can-change-username: false
            can-create-organizations: true
            can-manage-user-tokens: true
          two-factor:
            verified: false
          username: john_smith
        id: user-K1LWGyjmnDL59y4H
        links:
          self: /api/v2/users/user-K1LWGyjmnDL59y4H
        relationships:
          authentication-tokens:
            links:
              related: /api/v2/users/user-K1LWGyjmnDL59y4H/authentication-tokens
        type: users
      type: list
  description: Details on memberships.
  returned: success
  type: dict
organization:
  description: Organization name or external-id.
  returned: always
  sample: foo
  type: str