Globus Connect Server OIDC Update

Name

globus-connect-server oidc update - Update the OIDC configuration settings

Synopsis

globus-connect-server oidc update [OPTIONS]…​

Description

The globus-connect-server oidc update command provides a command-line interface for updating settings for the configured OIDC server. The display name and support contact information can be updated in any configuration. A Globus OIDC server allows updates of the PAM module and certificates. An OIDC registration allows updates of its client credentials.

Only the parameters that are being updated should be provided.

Important

If you used the --quickstart-server-name flag when installing the Globus OIDC server, then you should not update the certificates using this command.

Options

-h, --help

Show a help message and exit.

--version

Show the version and exit.

--display-name DISPLAY_NAME

The display name for the OIDC server. This will be displayed on the login page when the user attempts to sign in. Note that this is limited to 64 characters.

--support-contact SUPPORT_CONTACT

The support contact name for the OIDC server. This is required by Globus Auth.

--support-email SUPPORT_EMAIL

The support contact email for the OIDC server. This is required by Globus Auth and is shown on the login screen in the event that a user requires support contact information.

-p, --pam-service PAM_SERVICE

The PAM module to use when authenticating the user. This is set to login if omitted. For Globus OIDC server only.

--certificate-path [CERT_PATH]

Full path to the certificate for the virtual host for the OIDC service. For Globus OIDC server only.

--certificate-chain-path [CHAIN_PATH]

Full path to the certificate chain for the virtual host for the OIDC service. For Globus OIDC server only.

--private-key-path [PRIVATE_KEY_PATH]

Full path to the private key for the virtual host for the OIDC service. For Globus OIDC server only.

--client-id CLIENT-ID

Client ID that Globus will use to authenticate with your OIDC server. This is not the Globus client-id of your endpoint. For OIDC registration only.

--client-secret SECRET

Client secret that Globus will use to authenticate with your OIDC server. This is not the Globus client-secret of your endpoint. For OIDC registration only.

Example

This invocation updates the display name to "Example OIDC Server" and the support contact to "Test User" with an email address of "testuser@test.com".

globus-connect-server oidc update \
    --display-name "Example OIDC Server" \
    --support-contact "Test User" \
    --support-email "testuser@test.com"