Deployments.ai Docs
Command reference

deployments oauth-app

Subscriber-owned OAuth applications

CommandSummary
deployments oauth-app registerRegister an OAuth application
deployments oauth-app listList OAuth applications
deployments oauth-app showShow an OAuth application
deployments oauth-app rotateRotate an OAuth client secret
deployments oauth-app archiveArchive an OAuth application

deployments oauth-app register

Register an OAuth application.

deployments oauth-app register --name <name> --provider <provider> --client-id <client-id> --scopes <a-b-c> --redirect-uri <a-b-c>
  • Calls POST /v1/oauth-apps (SDK createProviderApplication).
  • Needs an environment: --env or the saved context.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
  • Output contains secrets. They are redacted unless you pass --reveal.
FlagTypeRequiredDefaultDescription
--namestringyesResource name
--providerstringyesProvider key
--client-idstringyesOAuth client ID
--client-secretstringOAuth client secret (prefer env or file source)
--client-secret-envstringEnvironment variable containing the client secret
--client-secret-filestringFile containing the client secret
--credentialstringProvider-specific OAuth credential JSON (prefer env or file source)
--credential-envstringEnvironment variable containing provider-specific OAuth credential JSON
--credential-filestringFile containing provider-specific OAuth credential JSON
--registrationstring (json)Vendor MCP pre-registration, e.g. {"method":"pre_registered","tokenEndpointAuthMethod":"none"}
--scopesstring (a,b,c)yesProvider scopes
--redirect-uristring (a,b,c)yesConfigured callback URLs

Also accepts the global flags.

deployments oauth-app list

List OAuth applications.

deployments oauth-app list
  • Calls GET /v1/oauth-apps (SDK listProviderApplications).
  • Needs an environment: --env or the saved context.
  • Paginated. --page-size sets the page size; pass the returned cursor as --cursor for the next page.
FlagTypeRequiredDefaultDescription
--cursorstring (cursor)Pagination cursor
--page-sizestring (number)Page size

Also accepts the global flags.

deployments oauth-app show

Show an OAuth application.

deployments oauth-app show <id>
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID

Also accepts the global flags.

deployments oauth-app rotate

Rotate an OAuth client secret.

deployments oauth-app rotate <id> --expected-version <number>
  • Calls POST /v1/oauth-apps/{id}/rotate (SDK rotateProviderApplicationSecret).
  • Needs an environment: --env or the saved context.
  • Destructive. Live runs ask for confirmation; pass --yes in scripts or with --json.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
  • Output contains secrets. They are redacted unless you pass --reveal.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--expected-versionstring (number)yesExpected resource version
--client-secretstringNew OAuth client secret (prefer env or file source)
--client-secret-envstringEnvironment variable containing the new client secret
--client-secret-filestringFile containing the new client secret
--credentialstringReplacement provider-specific OAuth credential JSON (prefer env or file source)
--credential-envstringEnvironment variable containing replacement OAuth credential JSON
--credential-filestringFile containing replacement OAuth credential JSON

Also accepts the global flags.

deployments oauth-app archive

Archive an OAuth application.

deployments oauth-app archive <id>
  • Calls DELETE /v1/oauth-apps/{id} (SDK archiveProviderApplication).
  • Needs an environment: --env or the saved context.
  • Destructive. Live runs ask for confirmation; pass --yes in scripts or with --json.
  • Sends an idempotency key. The CLI generates one per run; pass --idempotency-key to retry safely.
FlagTypeRequiredDefaultDescription
<id>positionalyesResource ID
--reasonstringReason for this operation

Also accepts the global flags.

On this page