OAuth CLI reference
Source: @socra/oauth-cli@0.0.6.
This reference includes every command, argument, and option declared by this released package. Defaults and accepted values are included where the package declares them. Command-specific validation and permissions also apply; see the API reference for resource contracts.
Use socra oauth --help, or append --help to any command, to inspect the locally installed version.
socra oauth
Manage OAuth configuration and client registrations
Scroll to see all columns.
| Command | Purpose |
|---|---|
socra oauth config | Manage project-level OAuth branding and consent configuration |
socra oauth client | Manage OAuth client registrations |
socra oauth client-secret | Manage OAuth client secrets |
socra oauth installation | Manage admin consent and application installations in the current Account |
socra oauth token | Exchange client credentials for an installation token |
socra oauth config
Manage project-level OAuth branding and consent configuration
Scroll to see all columns.
| Command | Purpose |
|---|---|
socra oauth config set | Update OAuth configuration for a project |
socra oauth config get | Get OAuth configuration for a project |
socra oauth config set
Update OAuth configuration for a project
Text
socra oauth config set <project> [options]
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
project | Yes | Project id, e.g. proj_... |
Options
Scroll to see all columns.
| Option | Input | Description |
|---|---|---|
--name | Value | Application display name |
--support-email | Value | User support email |
--audience | Value | internal or external |
--domains | Value | Comma-separated authorized domains |
socra oauth config get
Get OAuth configuration for a project
Text
socra oauth config get <project>
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
project | Yes | Project id |
socra oauth client
Manage OAuth client registrations
Scroll to see all columns.
| Command | Purpose |
|---|---|
socra oauth client create | Create an OAuth client |
socra oauth client get | Get an OAuth client |
socra oauth client list | List OAuth clients for a project |
socra oauth client update | Update an OAuth client |
socra oauth client delete | Delete an OAuth client |
socra oauth client create
Create an OAuth client
Text
socra oauth client create <name> [options]
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
name | Yes | Client display name |
Options
Scroll to see all columns.
| Option | Input | Description |
|---|---|---|
--project | Value | Owning project id |
--type | Value | web, spa, or native |
--redirect-uris | Value | Comma-separated redirect URIs |
--javascript-origins | Value | Comma-separated JavaScript origins |
socra oauth client get
Get an OAuth client
Text
socra oauth client get <id> [options]
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
id | Yes | Client id |
Options
Scroll to see all columns.
| Option | Input | Description |
|---|---|---|
--project | Value | Owning project id |
socra oauth client list
List OAuth clients for a project
Text
socra oauth client list [options]
Options
Scroll to see all columns.
| Option | Input | Description |
|---|---|---|
--project | Value | Owning project id |
socra oauth client update
Update an OAuth client
Text
socra oauth client update <id> [options]
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
id | Yes | Client id |
Options
Scroll to see all columns.
| Option | Input | Description |
|---|---|---|
--project | Value | Owning project id |
--name | Value | Client display name |
--status | Value | active or suspended |
--redirect-uris | Value | Comma-separated redirect URIs |
--javascript-origins | Value | Comma-separated JavaScript origins |
socra oauth client delete
Delete an OAuth client
Text
socra oauth client delete <id> [options]
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
id | Yes | Client id |
Options
Scroll to see all columns.
| Option | Input | Description |
|---|---|---|
--project | Value | Owning project id |
socra oauth client-secret
Manage OAuth client secrets
Scroll to see all columns.
| Command | Purpose |
|---|---|
socra oauth client-secret create | Create a client secret; plaintext is shown only once |
socra oauth client-secret list | List active secrets for a client |
socra oauth client-secret delete | Revoke a client secret |
socra oauth client-secret create
Create a client secret; plaintext is shown only once
Text
socra oauth client-secret create <client> [options]
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
client | Yes | Client id |
Options
Scroll to see all columns.
| Option | Input | Description |
|---|---|---|
--project | Value | Owning project id |
socra oauth client-secret list
List active secrets for a client
Text
socra oauth client-secret list <client> [options]
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
client | Yes | Client id |
Options
Scroll to see all columns.
| Option | Input | Description |
|---|---|---|
--project | Value | Owning project id |
socra oauth client-secret delete
Revoke a client secret
Text
socra oauth client-secret delete <client> <id> [options]
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
client | Yes | Client id |
id | Yes | Client secret id |
Options
Scroll to see all columns.
| Option | Input | Description |
|---|---|---|
--project | Value | Owning project id |
socra oauth installation
Manage admin consent and application installations in the current Account
Scroll to see all columns.
| Command | Purpose |
|---|---|
socra oauth installation create | As Account owner, consent to the project and its requested scopes |
socra oauth installation get | Get an installation |
socra oauth installation list | List installations |
socra oauth installation delete | Revoke installation consent and its principal |
socra oauth installation create
As Account owner, consent to the project and its requested scopes
Text
socra oauth installation create [options]
Options
Scroll to see all columns.
| Option | Input | Description |
|---|---|---|
--project | Value | Application project id |
--scopes | Value | Optional comma-separated scopes to approve |
socra oauth installation get
Get an installation
Text
socra oauth installation get <id>
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
id | Yes | Installation id |
socra oauth installation list
List installations
Text
socra oauth installation list [options]
Options
Scroll to see all columns.
| Option | Input | Description |
|---|---|---|
--after | Value | Continue after this installation id |
socra oauth installation delete
Revoke installation consent and its principal
Text
socra oauth installation delete <id>
Arguments
Scroll to see all columns.
| Argument | Required | Description |
|---|---|---|
id | Yes | Installation id |
socra oauth token
Exchange client credentials for an installation token
Scroll to see all columns.
| Command | Purpose |
|---|---|
socra oauth token create | Mint a short-lived installation token; prints the token response |
socra oauth token create
Mint a short-lived installation token; prints the token response
Text
socra oauth token create [options]
Options
Scroll to see all columns.
| Option | Input | Description |
|---|---|---|
--client | Value | Confidential OAuth client id |
--principal | Value | Installation principal id |
--client-secret-file | Value | Read client secret from this file |
--scope | Value | Space-separated subset of consented scopes (defaults to all) |
Next step
Return to the OAuth overview.