Notploy

Users

Accounts, API keys, sessions, permissions and per-user metrics. Generated from the `notploy` command surface.

Accounts, API keys, sessions, permissions and per-user metrics.

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

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

Commands

notploy user all

Calls GET /api/trpc/user.all.

notploy user all [options]
OptionTypeRequiredAllowed values
--profile <name>stringNo—

notploy user assign-permissions

Calls POST /api/trpc/user.assignPermissions.

notploy user assign-permissions --id <value> --accessedProjects <json> --accessedEnvironments <json> --accessedServices <json> --accessedGitProviders <json> --accessedServers <json> --canCreateProjects --canCreateServices --canDeleteProjects --canDeleteServices --canAccessToDocker --canAccessToTraefikFiles --canAccessToAPI --canAccessToSSHKeys --canAccessToGitProviders --canDeleteEnvironments --canCreateEnvironments [options]
OptionTypeRequiredAllowed values
--id <value>stringYes—
--accessedProjects <json>arrayYes—
--accessedEnvironments <json>arrayYes—
--accessedServices <json>arrayYes—
--accessedGitProviders <json>arrayYes—
--accessedServers <json>arrayYes—
--canCreateProjects [boolean]booleanYes—
--canCreateServices [boolean]booleanYes—
--canDeleteProjects [boolean]booleanYes—
--canDeleteServices [boolean]booleanYes—
--canAccessToDocker [boolean]booleanYes—
--canAccessToTraefikFiles [boolean]booleanYes—
--canAccessToAPI [boolean]booleanYes—
--canAccessToSSHKeys [boolean]booleanYes—
--canAccessToGitProviders [boolean]booleanYes—
--canDeleteEnvironments [boolean]booleanYes—
--canCreateEnvironments [boolean]booleanYes—
--profile <name>stringNo—

notploy user check-user-organizations

Calls GET /api/trpc/user.checkUserOrganizations.

notploy user check-user-organizations --userId <value> [options]
OptionTypeRequiredAllowed values
--userId <value>stringYes—
--profile <name>stringNo—

notploy user create-api-key

Calls POST /api/trpc/user.createApiKey.

notploy user create-api-key --name <value> --metadata <json> [options]
OptionTypeRequiredAllowed values
--name <value>stringYes—
--prefix <value>stringNo—
--expiresIn <value>numberNo—
--metadata <json>objectYes—
--rateLimitEnabled [boolean]booleanNo—
--no-rateLimitEnabledbooleanNo—
--rateLimitTimeWindow <value>numberNo—
--rateLimitMax <value>numberNo—
--remaining <value>numberNo—
--refillAmount <value>numberNo—
--refillInterval <value>numberNo—
--profile <name>stringNo—

notploy user create-user-with-credentials

Calls POST /api/trpc/user.createUserWithCredentials.

notploy user create-user-with-credentials --email <value> --password <value> --role <value> [options]
OptionTypeRequiredAllowed values
--email <value>stringYes—
--password <value>stringYes—
--role <value>stringYes—
--profile <name>stringNo—

notploy user delete-api-key

Calls POST /api/trpc/user.deleteApiKey.

notploy user delete-api-key --apiKeyId <value> [options]
OptionTypeRequiredAllowed values
--apiKeyId <value>stringYes—
--profile <name>stringNo—

notploy user generate-token

Calls POST /api/trpc/user.generateToken.

notploy user generate-token [options]
OptionTypeRequiredAllowed values
--profile <name>stringNo—

notploy user get

Calls GET /api/trpc/user.get.

notploy user get [options]
OptionTypeRequiredAllowed values
--profile <name>stringNo—

notploy user get-backups

Calls GET /api/trpc/user.getBackups.

notploy user get-backups [options]
OptionTypeRequiredAllowed values
--profile <name>stringNo—

notploy user get-bookmarked-templates

Calls GET /api/trpc/user.getBookmarkedTemplates.

notploy user get-bookmarked-templates [options]
OptionTypeRequiredAllowed values
--profile <name>stringNo—

notploy user get-container-metrics

Calls GET /api/trpc/user.getContainerMetrics.

notploy user get-container-metrics --url <value> --token <value> --appName <value> --dataPoints <value> [options]
OptionTypeRequiredAllowed values
--url <value>stringYes—
--token <value>stringYes—
--appName <value>stringYes—
--dataPoints <value>stringYes—
--profile <name>stringNo—

notploy user get-invitations

Calls GET /api/trpc/user.getInvitations.

notploy user get-invitations [options]
OptionTypeRequiredAllowed values
--profile <name>stringNo—

notploy user get-metrics-token

Calls GET /api/trpc/user.getMetricsToken.

notploy user get-metrics-token [options]
OptionTypeRequiredAllowed values
--profile <name>stringNo—

notploy user get-permissions

Calls GET /api/trpc/user.getPermissions.

notploy user get-permissions [options]
OptionTypeRequiredAllowed values
--profile <name>stringNo—

notploy user get-server-metrics

Calls GET /api/trpc/user.getServerMetrics.

notploy user get-server-metrics [options]
OptionTypeRequiredAllowed values
--profile <name>stringNo—

notploy user get-user-by-token

Calls GET /api/trpc/user.getUserByToken.

notploy user get-user-by-token --token <value> [options]
OptionTypeRequiredAllowed values
--token <value>stringYes—
--profile <name>stringNo—

notploy user have-root-access

Calls GET /api/trpc/user.haveRootAccess.

notploy user have-root-access [options]
OptionTypeRequiredAllowed values
--profile <name>stringNo—

notploy user list-passkeys

Calls GET /api/trpc/user.listPasskeys.

notploy user list-passkeys [options]
OptionTypeRequiredAllowed values
--profile <name>stringNo—

notploy user list-sessions

Calls GET /api/trpc/user.listSessions.

notploy user list-sessions [options]
OptionTypeRequiredAllowed values
--profile <name>stringNo—

notploy user one

Calls GET /api/trpc/user.one.

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

notploy user remove

Calls POST /api/trpc/user.remove.

notploy user remove --userId <value> [options]
OptionTypeRequiredAllowed values
--userId <value>stringYes—
--profile <name>stringNo—

notploy user revoke-session

Calls POST /api/trpc/user.revokeSession.

notploy user revoke-session --sessionId <value> [options]
OptionTypeRequiredAllowed values
--sessionId <value>stringYes—
--profile <name>stringNo—

notploy user send-invitation

Calls POST /api/trpc/user.sendInvitation.

notploy user send-invitation --invitationId <value> --notificationId <value> [options]
OptionTypeRequiredAllowed values
--invitationId <value>stringYes—
--notificationId <value>stringYes—
--profile <name>stringNo—

notploy user session

Calls GET /api/trpc/user.session.

notploy user session [options]
OptionTypeRequiredAllowed values
--profile <name>stringNo—

notploy user toggle-template-bookmark

Calls POST /api/trpc/user.toggleTemplateBookmark.

notploy user toggle-template-bookmark --templateId <value> [options]
OptionTypeRequiredAllowed values
--templateId <value>stringYes—
--profile <name>stringNo—

notploy user update

Calls POST /api/trpc/user.update.

notploy user update [options]
OptionTypeRequiredAllowed values
--id <value>stringNo—
--firstName <value>stringNo—
--lastName <value>stringNo—
--isRegistered [boolean]booleanNo—
--no-isRegisteredbooleanNo—
--expirationDate <value>stringNo—
--createdAt2 <value>stringNo—
--createdAt <value>stringNo—
--twoFactorEnabled [boolean]booleanNo—
--no-twoFactorEnabledbooleanNo—
--email <value>stringNo—
--emailVerified [boolean]booleanNo—
--no-emailVerifiedbooleanNo—
--image <value>stringNo—
--banned [boolean]booleanNo—
--no-bannedbooleanNo—
--banReason <value>stringNo—
--banExpires <value>stringNo—
--updatedAt <value>stringNo—
--enablePaidFeatures [boolean]booleanNo—
--no-enablePaidFeaturesbooleanNo—
--allowImpersonation [boolean]booleanNo—
--no-allowImpersonationbooleanNo—
--stripeCustomerId <value>stringNo—
--stripeSubscriptionId <value>stringNo—
--serversQuantity <value>numberNo—
--sendInvoiceNotifications [boolean]booleanNo—
--no-sendInvoiceNotificationsbooleanNo—
--password <value>stringNo—
--currentPassword <value>stringNo—
--profile <name>stringNo—

SSO

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

Admin

Administrative operations that apply to the whole instance. Generated from the `notploy` command surface.

On this page

Commandsnotploy user allnotploy user assign-permissionsnotploy user check-user-organizationsnotploy user create-api-keynotploy user create-user-with-credentialsnotploy user delete-api-keynotploy user generate-tokennotploy user getnotploy user get-backupsnotploy user get-bookmarked-templatesnotploy user get-container-metricsnotploy user get-invitationsnotploy user get-metrics-tokennotploy user get-permissionsnotploy user get-server-metricsnotploy user get-user-by-tokennotploy user have-root-accessnotploy user list-passkeysnotploy user list-sessionsnotploy user onenotploy user removenotploy user revoke-sessionnotploy user send-invitationnotploy user sessionnotploy user toggle-template-bookmarknotploy user update