Forward auth
Deploy an authentication proxy in front of applications and manage its domains. Generated from the `notploy` command surface.
Deploy an authentication proxy in front of applications and manage its domains.
notploy forward-auth exposes 10 commands. They map one-to-one onto the forward-auth.* API operations, so anything reachable from the dashboard is reachable from here.
Run notploy forward-auth --help to list these commands in your terminal, or
notploy forward-auth <command> --help for a single command.
Commands
notploy forward-auth deploy-on-server
Calls POST /api/trpc/forwardAuth.deployOnServer.
notploy forward-auth deploy-on-server --serverId <value> --providerId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--serverId <value> | string | Yes | — |
--providerId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy forward-auth disable
Calls POST /api/trpc/forwardAuth.disable.
notploy forward-auth disable --domainId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--domainId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy forward-auth enable
Calls POST /api/trpc/forwardAuth.enable.
notploy forward-auth enable --domainId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--domainId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy forward-auth get-auth-domain
Calls GET /api/trpc/forwardAuth.getAuthDomain.
notploy forward-auth get-auth-domain --serverId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--serverId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy forward-auth list-providers
Calls GET /api/trpc/forwardAuth.listProviders.
notploy forward-auth list-providers [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--profile <name> | string | No | — |
notploy forward-auth remove-auth-domain
Calls POST /api/trpc/forwardAuth.removeAuthDomain.
notploy forward-auth remove-auth-domain --serverId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--serverId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy forward-auth remove-on-server
Calls POST /api/trpc/forwardAuth.removeOnServer.
notploy forward-auth remove-on-server --serverId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--serverId <value> | string | Yes | — |
--profile <name> | string | No | — |
notploy forward-auth server-status
Calls GET /api/trpc/forwardAuth.serverStatus.
notploy forward-auth server-status [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--profile <name> | string | No | — |
notploy forward-auth set-auth-domain
Calls POST /api/trpc/forwardAuth.setAuthDomain.
notploy forward-auth set-auth-domain --serverId <value> --authDomain <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--serverId <value> | string | Yes | — |
--authDomain <value> | string | Yes | — |
--https [boolean] | boolean | No | — |
--no-https | boolean | No | — |
--certificateType <value> | string | No | none, letsencrypt, custom |
--customCertResolver <value> | string | No | — |
--profile <name> | string | No | — |
notploy forward-auth status
Calls GET /api/trpc/forwardAuth.status.
notploy forward-auth status --domainId <value> [options]| Option | Type | Required | Allowed values |
|---|---|---|---|
--domainId <value> | string | Yes | — |
--profile <name> | string | No | — |