community.general.gitlab_user module – Creates/updates/deletes/blocks/unblocks GitLab Users
Note
This module is part of the community.general collection (version 8.6.7).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.general.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.gitlab_user.
Synopsis
When the user does not exist in GitLab, it will be created.
When the user exists and state=absent, the user will be deleted.
When the user exists and state=blocked, the user will be blocked.
When changes are made to user, the user will be updated.
Aliases: source_control.gitlab.gitlab_user
Requirements
The below requirements are needed on the host that executes this module.
administrator rights on the GitLab server
python-gitlab python module
requests (Python library https://pypi.org/project/requests/)
Parameters
Parameter |
Comments |
|---|---|
The access level to the group. One of the following can be used. guest reporter developer master (alias for maintainer) maintainer owner Choices:
|
|
GitLab CI job token for logging in. |
|
GitLab OAuth token for logging in. |
|
The password to use for authentication against the API. |
|
GitLab access token with API permissions. |
|
The resolvable endpoint for the API. |
|
The username to use for authentication against the API. |
|
The CA certificates bundle to use to verify GitLab server certificate. |
|
Require confirmation. Choices:
|
|
The email that belongs to the user. Required only if |
|
Define external parameter for this user. Choices:
|
|
Id or Full path of parent group in the form of group/name. Add user as a member to this group. |
|
List of identities to be added/updated for this user. To remove all other identities from this user, set |
|
User ID for external identity. |
|
The name of the external identity provider |
|
Grant admin privileges to the user. Choices:
|
|
Name of the user you want to create. Required only if |
|
Overwrite identities with identities added in this module. This means that all identities that the user has and that are not listed in This is only done if a list is provided for Choices:
|
|
The password of the user. GitLab server enforces minimum password length to 8, set this value with 8 or more characters. |
|
Whether the user can change its password or not. Choices:
|
|
The expiration date of the SSH public key in ISO 8601 format This is only used when adding new SSH public keys. |
|
The SSH public key itself. |
|
The name of the SSH public key. |
|
Create, delete or block a user. Choices:
|
|
The username of the user. |
|
Whether or not to validate SSL certs when supplying a HTTPS endpoint. Choices:
|
Attributes
Attribute |
Support |
Description |
|---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
Notes
Note
From community.general 0.2.0 and onwards, name, email and password are optional while deleting the user.
Examples
- name: "Delete GitLab User"
community.general.gitlab_user:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
username: myusername
state: absent
- name: "Create GitLab User"
community.general.gitlab_user:
api_url: https://gitlab.example.com/
validate_certs: true
api_username: dj-wasabi
api_password: "MySecretPassword"
name: My Name
username: myusername
password: mysecretpassword
email: [email protected]
sshkey_name: MySSH
sshkey_file: ssh-rsa AAAAB3NzaC1yc...
state: present
group: super_group/mon_group
access_level: owner
- name: "Create GitLab User using external identity provider"
community.general.gitlab_user:
api_url: https://gitlab.example.com/
validate_certs: true
api_token: "{{ access_token }}"
name: My Name
username: myusername
password: mysecretpassword
email: [email protected]
identities:
- provider: Keycloak
extern_uid: f278f95c-12c7-4d51-996f-758cc2eb11bc
state: present
group: super_group/mon_group
access_level: owner
- name: "Block GitLab User"
community.general.gitlab_user:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
username: myusername
state: blocked
- name: "Unblock GitLab User"
community.general.gitlab_user:
api_url: https://gitlab.example.com/
api_token: "{{ access_token }}"
username: myusername
state: unblocked
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
the error message returned by the GitLab API Returned: failed Sample: |
|
Success or failure message Returned: always Sample: |
|
json parsed response from the server Returned: always |
|
API object Returned: always |