m1yag1.globus.globus_group module – Manage Globus Groups

Note

This module is part of the m1yag1.globus collection (version 0.6.0).

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 m1yag1.globus.

To use it in a playbook, specify: m1yag1.globus.globus_group.

New in m1yag1.globus 1.0.0

Synopsis

  • Create, update, or delete Globus Groups

  • Manage group membership and permissions

Parameters

Parameter

Comments

admins

list / elements=string

List of group administrators.

Accepts usernames (e.g., user@globusid.org), identity URNs, or UUIDs.

auth_method

string

Authentication method to use.

If not specified, auto-detects based on available credentials.

When client_id and client_secret are provided, uses client_credentials.

Otherwise falls back to cli (reads tokens from globus-cli storage).

Choices:

  • "client_credentials"

  • "cli"

client_id

string

Globus Auth client ID for client_credentials authentication.

Can also be set via the GLOBUS_CLIENT_ID environment variable.

client_secret

string

Globus Auth client secret for client_credentials authentication.

Can also be set via the GLOBUS_CLIENT_SECRET environment variable.

description

string

Description of the group

members

list / elements=string

List of group members.

Accepts usernames (e.g., user@globusid.org), identity URNs, or UUIDs.

name

string / required

Name of the group

state

string

Desired state of the group

Choices:

  • "present" ← (default)

  • "absent"

visibility

string

Group visibility setting

Choices:

  • "public"

  • "private" ← (default)

Notes

Note

  • Authentication is required for all Globus API operations.

  • For client_credentials auth, register a confidential client at https://developers.globus.org.

  • For cli auth, run globus login first to cache tokens.

  • The cli method reads tokens from ~/.globus/cli/storage.db.

  • For cli auth with multiple profiles, set GLOBUS_PROFILE environment variable.

  • Set GLOBUS_SDK_ENVIRONMENT to sandbox or test for non-production environments.

See Also

See also

Globus Auth Documentation

Official Globus authentication documentation

Globus CLI

Command-line interface for Globus

Examples

- name: Create a Globus group
  globus_group:
    name: "research-team"
    description: "Research team collaboration group"
    visibility: "private"
    members:
      - "user1@example.org"
      - "user2@example.org"
    admins:
      - "admin@example.org"
    state: present

- name: Delete a Globus group
  globus_group:
    name: "old-group"
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

changed

boolean

Whether the group was changed

Returned: always

group_id

string

ID of the created/managed group

Returned: when state=present

name

string

Name of the group

Returned: always

Authors

  • m1yag1