/ home / community / community.general / 8.5.0 / module / bitbucket_access_key

community.general.bitbucket_access_key (8.5.0) — module

Manages Bitbucket repository access keys

Authors: Evgeniy Krysanov (@catcombo)

Install collection

Install with ansible-galaxy collection install community.general:==8.5.0

Add to requirements.yml

  collections:
    - name: community.general
      version: 8.5.0

Description

Manages Bitbucket repository access keys (also called deploy keys).

Usage examples

Scanned by Steampunk Spotter

- name: Create access key
  community.general.bitbucket_access_key:
    repository: 'bitbucket-repo'
    workspace: bitbucket_workspace
    key: '{{lookup("file", "bitbucket.pub") }}'
    label: 'Bitbucket'
    state: present

Scanned by Steampunk Spotter

- name: Delete access key
  community.general.bitbucket_access_key:
    repository: bitbucket-repo
    workspace: bitbucket_workspace
    label: Bitbucket
    state: absent

Inputs

    
key:
    description:
    - The SSH public key.
    type: str

user:
    aliases:
    - username
    description:
    - The username.
    - If not set the environment variable E(BITBUCKET_USERNAME) will be used.
    - O(ignore:username) is an alias of O(user) since community.general 6.0.0. It was
      an alias of O(workspace) before.
    type: str
    version_added: 4.0.0
    version_added_collection: community.general

label:
    description:
    - The key label.
    required: true
    type: str

state:
    choices:
    - absent
    - present
    description:
    - Indicates desired state of the access key.
    required: true
    type: str

password:
    description:
    - The App password.
    - If not set the environment variable E(BITBUCKET_PASSWORD) will be used.
    type: str
    version_added: 4.0.0
    version_added_collection: community.general

client_id:
    description:
    - The OAuth consumer key.
    - If not set the environment variable E(BITBUCKET_CLIENT_ID) will be used.
    type: str

workspace:
    description:
    - The repository owner.
    - B(Note:) O(ignore:username) used to be an alias of this option. Since community.general
      6.0.0 it is an alias of O(user).
    required: true
    type: str

repository:
    description:
    - The repository name.
    required: true
    type: str

client_secret:
    description:
    - The OAuth consumer secret.
    - If not set the environment variable E(BITBUCKET_CLIENT_SECRET) will be used.
    type: str