Skip to content

ezgh sso directory update

Change the directory's name, alias, sign-in policy or branding.

Updated View as Markdown
ezgh sso directory update [--name n] [--alias a] [policy and branding flags] [--logo file | --remove-logo] [flags]

Change the directory. What’s given changes and the rest stays: ezgh reads the current sign-in policy and colors and sends them with your changes.

Changing --alias moves the portal and the issuer to https://<new alias>.sso.ezgh.app. The old address redirects for 30 days, and is never given to anyone else; applications must be updated to the new issuer, and passkeys, which belong to the old address, stop working (people with no other factor need reset-factors). A shorter session or idle timeout applies to existing sessions at once.

Part of ezgh sso directory.

Examples

ezgh sso directory update --mfa-required=false --allowed-factors password
ezgh sso directory update --logo logo.png --primary-color "#0f766e"

Flags

Flag Type Default Description
--alias string a new alias; the old portal URL redirects for 30 days and is never reused
--allowed-factors strings, comma-separated or repeated [password,totp,passkey] the factors people may use: password, totp, passkey
--background-color string #ffffff the portal’s background color, #RRGGBB
--idle-timeout duration 1h0m0s how long an unused session lasts, 1m up to the session duration
--logo string a PNG or JPEG file (at most 512 KiB and 1024×1024) for the portal
--mfa-required boolean true require a second factor (or a passkey) for hosted sign-in
--name string the directory’s display name
--primary-color string #2563eb the portal’s primary color, #RRGGBB
--remove-logo boolean remove the portal’s logo
--session-duration duration 8h0m0s how long an SSO session lasts, 5m to 24h
--trust-upstream-mfa boolean count an identity provider’s MFA claim as MFA (and require it when MFA is required)

This command also takes the global flags.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close