Skip to content

proxystore.globus.cli

ProxyStore Globus Auth CLI.

# basic login/logout
proxystore-globus-auth login
proxystore-globus-auth logout
# give consent for specific collections
proxystore-globus-auth login --collection COLLECTION_UUID --collection COLLECTION_UUID ...
# specify additional scopes
proxystore-globus-auth login --scope SCOPE --scope SCOPE ...

cli 

cli() -> None

ProxyStore Globus Auth.

Source code in proxystore/globus/cli.py 
22
23
24
25
@click.group()
def cli() -> None:  # pragma: no cover
    """ProxyStore Globus Auth."""
    pass

login 

login(collection: list[str], scope: list[str]) -> None

Authenticate with Globus Auth.

This requests scopes for Globus Auth, Globus Transfer, and the ProxyStore relay server. Collections or scopes options can be strung together. E.g., request transfer scope for multiple collections with:

$ proxystore-globus-auth -c UUID -c UUID -c UUID

Source code in proxystore/globus/cli.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
@cli.command()
@click.option(
    '--collection',
    '-c',
    metavar='UUID',
    multiple=True,
    help='Globus Collection UUID to request transfer scopes for.',
)
@click.option(
    '--scope',
    '-s',
    metavar='SCOPE',
    multiple=True,
    help='Additional scope to request.',
)
def login(collection: list[str], scope: list[str]) -> None:
    """Authenticate with Globus Auth.

    This requests scopes for Globus Auth, Globus Transfer, and the ProxyStore
    relay server. Collections or scopes options can be strung together. E.g.,
    request transfer scope for multiple collections with:

    $ proxystore-globus-auth -c UUID -c UUID -c UUID
    """
    basic_scopes = get_all_scopes_by_resource_server(collection)
    manager = NativeAppAuthManager(resource_server_scopes=basic_scopes)

    if manager.logged_in:
        click.echo(
            'Globus authentication tokens already exist. '
            'To recreate, logout and login again.',
        )
    else:
        manager.login(additional_scopes=scope)

logout 

logout() -> None

Revoke and remove all Globus tokens.

Source code in proxystore/globus/cli.py 
64
65
66
67
68
@cli.command()
def logout() -> None:
    """Revoke and remove all Globus tokens."""
    manager = NativeAppAuthManager()
    manager.logout()