# 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](/docs/oauth/reference/api) 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

| 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

| 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

| Argument | Required | Description |
| --- | --- | --- |
| `project` | Yes | Project id, e.g. proj_... |

### Options

| 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

| Argument | Required | Description |
| --- | --- | --- |
| `project` | Yes | Project id |

## socra oauth client

Manage OAuth client registrations

| 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

| Argument | Required | Description |
| --- | --- | --- |
| `name` | Yes | Client display name |

### Options

| 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

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Client id |

### Options

| 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

| Option | Input | Description |
| --- | --- | --- |
| `--project` | Value | Owning project id |

## socra oauth client update

Update an OAuth client

```text
socra oauth client update <id> [options]
```

### Arguments

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Client id |

### Options

| 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

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Client id |

### Options

| Option | Input | Description |
| --- | --- | --- |
| `--project` | Value | Owning project id |

## socra oauth client-secret

Manage OAuth client secrets

| 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

| Argument | Required | Description |
| --- | --- | --- |
| `client` | Yes | Client id |

### Options

| 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

| Argument | Required | Description |
| --- | --- | --- |
| `client` | Yes | Client id |

### Options

| 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

| Argument | Required | Description |
| --- | --- | --- |
| `client` | Yes | Client id |
| `id` | Yes | Client secret id |

### Options

| Option | Input | Description |
| --- | --- | --- |
| `--project` | Value | Owning project id |

## socra oauth installation

Manage admin consent and application installations in the current Account

| 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

| 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

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Installation id |

## socra oauth installation list

List installations

```text
socra oauth installation list [options]
```

### Options

| 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

| Argument | Required | Description |
| --- | --- | --- |
| `id` | Yes | Installation id |

## socra oauth token

Exchange client credentials for an installation token

| 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

| 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](/docs/oauth).

---

Company: Socra — Multiply Your Judgment
Canonical URL: https://cloud.socra.com/docs/oauth/reference/cli