Config Reference

class globus_jupyterlab.globus_config.GlobusConfig

Bases: object

Track all Globus Related information related to the Globus Jupyterlab server extension. Many settings can be re-configured via environment variables where JupyterLab is being run. For example:

$ export GLOBUS_REFRESH_TOKENS=true
$ jupyter lab

get_refresh_tokens() → bool

Should Jupyterlab use Refresh tokens? Default is False. When True, JupyterLab will automatically refresh access tokens, eliminating the need for additional user authentications to refresh tokens.

Configurable via evironment variable: GLOBUS_REFRESH_TOKENS

Acceptable values:

• ‘true’ – use refresh tokens

• ‘false’ – do not use refresh tokens

get_named_grant() → str

Set a custom Named Grant when a user logs into Globus. Changes the pre-filled text displayed on the Globus Consent page when logging in.

Configurable via evironment variable: GLOBUS_NAMED_GRANT

get_transfer_submission_url() → str

By default, JupyterLab will start transfers on the user’s behalf using the Globus Transfer API directly. Configure this to instead use a custom Globus Resource Server for submitting transfers on the user’s behalf.

Note: GLOBUS_TRANSFER_SUBMISSION_SCOPE must also be configured.

Configurable via evironment variable: GLOBUS_TRANSFER_SUBMISSION_URL

get_transfer_submission_scope() → str

Define a custom ‘transfer submission’ scope for submitting user transfers. Used in conjunction with GLOBUS_TRANSFER_SUBMISSION_URL. Includes a custom scope to use when logging in and submitting transfers. Transfers submitted to the custom URL will be authorized with the access token for this custom scope instead of a Globus Transfer access token.

Configurable via evironment variable: GLOBUS_TRANSFER_SUBMISSION_SCOPE