Модуль community.general.gitlab_group_access_token — управление токенами доступа к группам GitLab

Примечание

Этот модуль входит в коллекцию community.general (версия 12.6.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install community.general. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: community.general.gitlab_group_access_token.

Добавлено в community.general 8.4.0

Краткое описание
Требования
Параметры
Атрибуты
Примечания
Примеры
Возвращаемые значения

Краткое описание

Создаёт и отзывает токены доступа к группам.

Требования

Следующие требования необходимы на хосте, выполняющем этот модуль.

python-gitlab >= 3.1.0
requests (библиотека Python https://pypi.org/project/requests/)

Параметры

Параметр	Комментарии
access_level string	Уровень доступа токена доступа. Значение `planner` добавлено в community.general 11.3.0. Варианты: `"guest"` `"planner"` `"reporter"` `"developer"` `"maintainer"` ← (по умолчанию) `"owner"`
api_job_token string добавлено в community.general 4.2.0	Токен задания GitLab CI для входа в систему.
api_oauth_token string добавлено в community.general 4.2.0	Токен OAuth GitLab для входа в систему.
api_password string	Пароль для аутентификации в API.
api_token string	Токен доступа GitLab с разрешениями API.
api_url string	Адресуемая конечная точка API.
api_username string	Имя пользователя для аутентификации в API.
ca_path string добавлено в community.general 8.1.0	Пакет сертификатов ЦС для проверки сертификата сервера GitLab.
expires_at string / обязательный	Дата истечения срока действия токена доступа в формате `YYYY-MM-DD`. Обязательно заключайте это значение в кавычки в YAML, чтобы оно сохранялось как строка, а не интерпретировалось как дата YAML.
group string / обязательный	ID или полный путь группы в формате group/subgroup.
name string / обязательный	Имя токена доступа.
recreate string	Следует ли пересоздавать токен доступа, если он уже существует. При значении `never` токен никогда не пересоздаётся. При значении `always` токен пересоздаётся всегда. При значении `state_change` токен пересоздаётся, если желаемое состояние отличается от фактического. Варианты: `"never"` ← (по умолчанию) `"always"` `"state_change"`
scopes псевдонимы: scope list / элементы=string / обязательный	Область действия токена доступа. Значения `read_virtual_registry`, `write_virtual_registry`, `manage_runner` и `self_rotate` добавлены в community.general 11.3.0. Варианты: `"api"` `"read_api"` `"read_registry"` `"write_registry"` `"read_virtual_registry"` `"write_virtual_registry"` `"read_repository"` `"write_repository"` `"create_runner"` `"manage_runner"` `"ai_features"` `"k8s_proxy"` `"self_rotate"`
state string	При значении `present` токен доступа добавляется в группу, если он ещё не существует. При значении `absent` токен удаляется из группы, если он существует. Варианты: `"present"` ← (по умолчанию) `"absent"`
validate_certs boolean	Проверять ли SSL-сертификаты при указании конечной точки HTTPS. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная	Может выполняться в режиме `check_mode` и возвращать прогноз изменения состояния без изменения целевого объекта.
diff_mode	Поддержка: отсутствует	В режиме diff возвращает сведения об изменениях (или о возможных изменениях в `check_mode`).

Примечания

Примечание

Токены доступа нельзя изменить. Если требуется изменить параметр, токен доступа необходимо пересоздать. Пересоздание токенов регулируется параметром recreate, по умолчанию имеющим значение never.
Строка токена включается в результат только при создании или пересоздании токена доступа. Получить её позднее невозможно.
Сопоставление токенов выполняется путём сравнения параметра name.

Примеры

- name: "Creating a group access token"
  community.general.gitlab_group_access_token:
    api_url: https://gitlab.example.com/
    api_token: "somegitlabapitoken"
    group: "my_group/my_subgroup"
    name: "group_token"
    expires_at: "2024-12-31"
    access_level: developer
    scopes:
      - api
      - read_api
      - read_repository
      - write_repository
    state: present

- name: "Revoking a group access token"
  community.general.gitlab_group_access_token:
    api_url: https://gitlab.example.com/
    api_token: "somegitlabapitoken"
    group: "my_group/my_group"
    name: "group_token"
    expires_at: "2024-12-31"
    scopes:
      - api
      - read_api
      - read_repository
      - write_repository
    state: absent

- name: "Change (recreate) existing token if its actual state is different than desired state"
  community.general.gitlab_group_access_token:
    api_url: https://gitlab.example.com/
    api_token: "somegitlabapitoken"
    group: "my_group/my_group"
    name: "group_token"
    expires_at: "2024-12-31"
    scopes:
      - api
      - read_api
      - read_repository
      - write_repository
    recreate: state_change
    state: present

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
access_token dictionary	Объект API. Содержит значение токена только в том случае, если токен был создан или пересоздан. Возвращается: при успехе и `state=present`

Авторы

Zoran Krleza (@pixslx)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/gitlab_group_access_token_module.html