bitbucket_repo_permissions – Manage Bitbucket repository permissions

Synopsis

Promote or demote a group’s or a users’s permission level for the specified repository.

Authentication can be done with token or with username and password.

Parameters

url (False, str, None)

Bitbucket Server URL.

username (False, str, None)

Username used for authentication.

This is only needed when not using token.

Required when password is provided.

password (False, str, None)

Password used for authentication.

This is only needed when not using token.

Required when username is provided.

token (False, str, None)

Token parameter for authentication.

This is only needed when not using username and password.

project_key (True, str, None)

Bitbucket project key.

repository (True, str, None)

Repository name.

user (False, str, None)

Bitbucket user to grant or revoke permission from.

This is only needed when not using group.

group (False, str, None)

Bitbucket group to grant or revoke permission from.

This is only needed when not using user.

permission (True, str, None)

The permission to grant.

Empty string ‘’ means revoke all grants form a user or group.

validate_certs (optional, bool, True)

If no, SSL certificates will not be validated.

This should only set to no used on personally controlled sites using self-signed certificates.

use_proxy (optional, bool, True)

If no, it will not use a proxy, even if one is defined in an environment variable on the target hosts.

sleep (optional, int, 5)

Number of seconds to sleep between API retries.

retries (optional, int, 3)

Number of retries to call Bitbucket API URL before failure.

Notes

Note

• Bitbucket Access Token can be obtained from Bitbucket profile -> Manage Account -> Personal Access Tokens.

• Supports check_mode.

Examples

- name: Set REPO_WRITE permission level for the specified repository to jsmith user
  esp.bitbucket.bitbucket_repo_permissions:
    username: admin
    password: secrect
    project_key: FOO
    repository: bar
    user: jsmith
    permission: REPO_WRITE
    validate_certs: no

- name: Revoke all permissions for the specified repository from a group
  esp.bitbucket.bitbucket_repo_permissions:
    token: 'MjA2M...hqP58'
    project_key: FOO
    repository: bar
    group: dev-group
    permission: ''
    validate_certs: no

Return Values

project_key (always, str, FOO)

Bitbucket project key.

repository (always, str, bar)

Bitbucket repository name.

permission (always, str, REPO_WRITE)

The permission to grant. Empty string ‘’ means revoke all grants form a user or group.

user (success, str, jsmith)

Bitbucket user to grant or revoke permission from.

group (success, str, dev-group)

Bitbucket group to grant or revoke permission from.

Status

Authors

• Krzysztof Lewandowski (@klewan)