⚠️ Porta is in beta — APIs and features may change before v1.0
Skip to content

CLI: Clients

Manage OIDC clients and client secrets via the porta client command.

Mode: HTTP (requires porta login)

Client CRUD

porta client create

bash
porta client create \
  --name "ERP Web App" \
  --org-id <org-id> \
  --app-id <app-id> \
  --type public \
  --redirect-uris "https://erp.example.com/callback" \
  [--scope "openid profile email roles"] \
  [--cors-origins "https://erp.example.com"]
FlagRequiredDescription
--nameClient display name
--org-idOrganization ID
--app-idApplication ID
--typepublic or confidential
--redirect-urisComma-separated redirect URIs
--application-typeweb, native, or spa (default: web)
--scopeSpace-separated scopes
--cors-originsComma-separated CORS origins
--login-methodsOverride org default login methods

porta client list

bash
porta client list [--org-id <id>] [--status active] [--search "erp"]

porta client show

bash
porta client show --id <client-id>

Shows full client details including effectiveLoginMethods.

porta client update

bash
porta client update --id <client-id> \
  [--name "New Name"] \
  [--redirect-uris "https://new.example.com/callback"] \
  [--scope "openid profile email"]

porta client revoke

bash
porta client revoke --id <client-id>

WARNING

Revoking a client immediately invalidates all tokens and prevents new authentication flows.

porta client activate / porta client deactivate

bash
porta client activate --id <client-id>
porta client deactivate --id <client-id>

Client Secrets

Manage secrets for confidential clients. Supports multiple active secrets for zero-downtime rotation.

porta client secret generate

bash
porta client secret generate --client-id <id> [--label "production-2024"]

DANGER

The plaintext secret is displayed only once. Copy and store it securely.

porta client secret list

bash
porta client secret list --client-id <id>

Shows secret metadata (ID, label, creation date) without plaintext values.

porta client secret revoke

bash
porta client secret revoke --client-id <id> --secret-id <id>

Login Methods

Manage per-client login method overrides.

porta client login-methods get

bash
porta client login-methods get --client-id <id>

Shows the effective login methods (client override or inherited from org).

porta client login-methods set

bash
porta client login-methods set --client-id <id> --methods password
porta client login-methods set --client-id <id> --methods password,magic_link

porta client login-methods clear

bash
porta client login-methods clear --client-id <id>

Removes the client-specific override, causing the client to inherit login methods from its organization.

Released under the MIT License.