esp.bitbucket.bitbucket_project_permissions (1.4.1) — module

Install collection

Install with ansible-galaxy collection install esp.bitbucket:==1.4.1

Add to requirements.yml

  collections:
    - name: esp.bitbucket
      version: 1.4.1

Description

Promote or demote a group's or a users's permission level for the specified project.

Authentication can be done with I(token) or with I(username) and I(password).

Usage examples

Scanned by Steampunk Spotter

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

- name: Set PROJECT_WRITE permission level for the specified project to jsmith user
  esp.bitbucket.bitbucket_project_permissions:
    url: 'https://bitbucket.example.com'
    username: admin
    password: secrect
    project_key: FOO
    user: jsmith
    permission: PROJECT_WRITE
    validate_certs: no

Scanned by Steampunk Spotter

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

- name: Revoke all permissions for the specified project from a group
  esp.bitbucket.bitbucket_project_permissions:
    url: 'https://bitbucket.example.com'
    token: 'MjA2M...hqP58'
    project_key: FOO
    group: dev-group
    permission: ''
    validate_certs: no

Inputs

    
url:
    description:
    - Bitbucket Server URL.
    required: false
    type: str

user:
    description:
    - Bitbucket user to grant or revoke permission from.
    - This is only needed when not using I(group).
    required: false
    type: str

group:
    description:
    - Bitbucket group to grant or revoke permission from.
    - This is only needed when not using I(user).
    required: false
    type: str

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

token:
    description:
    - Token parameter for authentication.
    - This is only needed when not using I(username) and I(password).
    required: false
    type: str

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

password:
    description:
    - Password used for authentication.
    - This is only needed when not using I(token).
    - Required when I(username) is provided.
    required: false
    type: str

username:
    description:
    - Username used for authentication.
    - This is only needed when not using I(token).
    - Required when I(password) is provided.
    required: false
    type: str

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

permission:
    choices:
    - PROJECT_READ
    - PROJECT_WRITE
    - PROJECT_ADMIN
    - ''
    description:
    - The permission to grant.
    - Empty string '' means revoke all grants form a user or group.
    required: true
    type: str

project_key:
    aliases:
    - project
    description:
    - Bitbucket project key.
    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

group:
  description: Bitbucket group to grant or revoke permission from.
  returned: success
  sample: dev-group
  type: str
permission:
  description: The permission to grant. Empty string '' means revoke all grants form
    a user or group.
  returned: always
  sample: PROJECT_WRITE
  type: str
project_key:
  description: Bitbucket project key.
  returned: always
  sample: FOO
  type: str
user:
  description: Bitbucket user to grant or revoke permission from.
  returned: success
  sample: jsmith
  type: str