Notploy

SSO

Single sign-on providers, enforcement and trusted origins. Generated from the `notploy` command surface.

Single sign-on providers, enforcement and trusted origins.

notploy sso exposes 16 commands. They map one-to-one onto the sso.* API operations, so anything reachable from the dashboard is reachable from here.

Run notploy sso --help to list these commands in your terminal, or notploy sso <command> --help for a single command.

Commands

notploy sso add-trusted-origin

Calls POST /api/trpc/sso.addTrustedOrigin.

notploy sso add-trusted-origin --origin <value> [options]
OptionTypeRequiredAllowed values
--origin <value>stringYes—
--profile <name>stringNo—

notploy sso delete-provider

Calls POST /api/trpc/sso.deleteProvider.

notploy sso delete-provider --providerId <value> [options]
OptionTypeRequiredAllowed values
--providerId <value>stringYes—
--profile <name>stringNo—

notploy sso descriptors

Calls GET /api/trpc/sso.descriptors.

notploy sso descriptors [options]
OptionTypeRequiredAllowed values
--profile <name>stringNo—

notploy sso enforce-sso

Calls GET /api/trpc/sso.enforceSSO.

notploy sso enforce-sso [options]
OptionTypeRequiredAllowed values
--profile <name>stringNo—

notploy sso get-trusted-origins

Calls GET /api/trpc/sso.getTrustedOrigins.

notploy sso get-trusted-origins [options]
OptionTypeRequiredAllowed values
--profile <name>stringNo—

notploy sso health

Calls GET /api/trpc/sso.health.

notploy sso health --providerId <value> [options]
OptionTypeRequiredAllowed values
--providerId <value>stringYes—
--profile <name>stringNo—

notploy sso list-providers

Calls GET /api/trpc/sso.listProviders.

notploy sso list-providers [options]
OptionTypeRequiredAllowed values
--profile <name>stringNo—

notploy sso one

Calls GET /api/trpc/sso.one.

notploy sso one --providerId <value> [options]
OptionTypeRequiredAllowed values
--providerId <value>stringYes—
--profile <name>stringNo—

notploy sso provider-kind

Calls GET /api/trpc/sso.providerKind.

notploy sso provider-kind --email <value> [options]
OptionTypeRequiredAllowed values
--email <value>stringYes—
--profile <name>stringNo—

notploy sso register

Calls POST /api/trpc/sso.register.

notploy sso register --providerId <value> --issuer <value> --domains <json> [options]
OptionTypeRequiredAllowed values
--providerId <value>stringYes—
--issuer <value>stringYes—
--domains <json>arrayYes—
--oidcConfig <json>objectNo—
--samlConfig <json>objectNo—
--ldapConfig <json>objectNo—
--oauthConfig <json>objectNo—
--organizationId <value>stringNo—
--overrideUserInfo [boolean]booleanNo—
--no-overrideUserInfobooleanNo—
--profile <name>stringNo—

notploy sso remove-trusted-origin

Calls POST /api/trpc/sso.removeTrustedOrigin.

notploy sso remove-trusted-origin --origin <value> [options]
OptionTypeRequiredAllowed values
--origin <value>stringYes—
--profile <name>stringNo—

notploy sso show-sign-in-with-sso

Calls GET /api/trpc/sso.showSignInWithSSO.

notploy sso show-sign-in-with-sso [options]
OptionTypeRequiredAllowed values
--profile <name>stringNo—

notploy sso social-provider

Calls GET /api/trpc/sso.socialProvider.

notploy sso social-provider [options]
OptionTypeRequiredAllowed values
--profile <name>stringNo—

notploy sso test-connection

Calls POST /api/trpc/sso.testConnection.

notploy sso test-connection --issuer <value> [options]
OptionTypeRequiredAllowed values
--providerId <value>stringNo—
--issuer <value>stringYes—
--oidcConfig <json>objectNo—
--samlConfig <json>objectNo—
--ldapConfig <json>objectNo—
--oauthConfig <json>objectNo—
--profile <name>stringNo—

notploy sso update

Calls POST /api/trpc/sso.update.

notploy sso update --providerId <value> --issuer <value> --domains <json> [options]
OptionTypeRequiredAllowed values
--providerId <value>stringYes—
--issuer <value>stringYes—
--domains <json>arrayYes—
--oidcConfig <json>objectNo—
--samlConfig <json>objectNo—
--ldapConfig <json>objectNo—
--oauthConfig <json>objectNo—
--organizationId <value>stringNo—
--overrideUserInfo [boolean]booleanNo—
--no-overrideUserInfobooleanNo—
--profile <name>stringNo—

notploy sso update-trusted-origin

Calls POST /api/trpc/sso.updateTrustedOrigin.

notploy sso update-trusted-origin --oldOrigin <value> --newOrigin <value> [options]
OptionTypeRequiredAllowed values
--oldOrigin <value>stringYes—
--newOrigin <value>stringYes—
--profile <name>stringNo—

On this page