---
# @generated by sylphx-gen 0.1.0 from contracts@e145cc7cf1bc9605f2b27439e5e17ed76a1a2fd7e7021906a013f7565e4a0cd5. Do not edit.
title: "Create an OAUTH client"
description: "`auth.oauth_clients.create` (POST /v1/{parent}/oauth_clients): Creates an OAuth client."
type: reference
product: auth
summary: "Creates an OAuth client."
updated: 2026-09-28
nav: false
---

> **This method is not served on the public API.** `api.sylphx.com` does not route this call: its backend is not deployed behind the public API, or does not implement the call. This page documents the contract. It is kept out of the sidebar and of search engines.

Creates an OAuth client.

- **Path** `POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/oauth_clients`
- **Scope** `auth:write`
- **Effect** `write` — a successful call changes state.
- **Collection** [oauth_clients](/docs/api/oauth_clients)
- **Query** `oauth_client_id`, `validate_only`

## Request

| Field | Type | What it is |
| --- | --- | --- |
| `parent` | `string` | The parent to create in. Required. |
| `oauth_client_id` | `string` | The OAuth client id, the final name segment; the server assigns one when empty. |
| `oauth_client` | `OauthClient` | The OAuth client to create; only caller-writable fields are read. Required. |
| `validate_only` | `bool` | Validate and return the result without writing anything. |

### OauthClient

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/oauth_clients/{oauth_client}`. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `OauthClientSpec` | Desired state. Required. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |

### OauthClientSpec

| Field | Type | What it is |
| --- | --- | --- |
| `client_type` | `OauthClientType` | Confidential or public. Required. One of `confidential`, `public`. |
| `token_endpoint_auth_method` | `TokenEndpointAuthMethod` | How the client authenticates at the token endpoint. Required. One of `none`, `client_secret_basic`, `private_key_jwt`. |
| `redirect_uris` | `string[]` | Exact redirect URIs. |
| `grant_types` | `GrantType[]` | Allowed grants. Required. One of `authorization_code`, `refresh_token`, `device_code`, `client_credentials`. |
| `scopes` | `string[]` | Scopes the client may request. |
| `jwks_uri` | `string` | The client's JWKS URI, for `private_key_jwt`. |
| `dpop_required` | `bool` | Require DPoP-bound tokens (RFC 9449). |
| `access_token_ttl` | `duration` | Access token lifetime; default 1h. |
| `refresh_token_ttl` | `duration` | Refresh token lifetime; default 30d. |

## Response

| Field | Type | What it is |
| --- | --- | --- |
| `name` | `string` | `orgs/{org}/projects/{project}/envs/{env}/oauth_clients/{oauth_client}`. |
| `uid` | `string` | `ocl_<cell><ulid>`; never reused. Output only. |
| `meta` | `ResourceMeta` | Resource metadata. |
| `spec` | `OauthClientSpec` | Desired state. Required. |
| `status` | `OauthClientStatus` | Observed state. Output only. |

### ResourceMeta

| Field | Type | What it is |
| --- | --- | --- |
| `generation` | `int64` | Increases by one on every change to `spec`. Output only. |
| `etag` | `string` | Strong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as `If-Match` or `etag` to make Update and Delete conditional; a mismatch fails with ABORTED / 409 `ETAG_MISMATCH`. Output only. |
| `create_time` | `timestamp` | When the Resource was created. Output only. |
| `update_time` | `timestamp` | When the Resource last changed. Output only. |
| `delete_time` | `timestamp` | Set while the Resource is being deleted. Output only. |
| `labels` | `map<string, string>` | Caller-writable, indexed labels (AIP-122 label rules). |
| `annotations` | `map<string, string>` | Caller-writable, unindexed annotations. |
| `display_name` | `string` | Caller-writable human-readable name. |
| `creator` | `string` | The principal that created the Resource. Output only. |

### OauthClientSpec

| Field | Type | What it is |
| --- | --- | --- |
| `client_type` | `OauthClientType` | Confidential or public. Required. One of `confidential`, `public`. |
| `token_endpoint_auth_method` | `TokenEndpointAuthMethod` | How the client authenticates at the token endpoint. Required. One of `none`, `client_secret_basic`, `private_key_jwt`. |
| `redirect_uris` | `string[]` | Exact redirect URIs. |
| `grant_types` | `GrantType[]` | Allowed grants. Required. One of `authorization_code`, `refresh_token`, `device_code`, `client_credentials`. |
| `scopes` | `string[]` | Scopes the client may request. |
| `jwks_uri` | `string` | The client's JWKS URI, for `private_key_jwt`. |
| `dpop_required` | `bool` | Require DPoP-bound tokens (RFC 9449). |
| `access_token_ttl` | `duration` | Access token lifetime; default 1h. |
| `refresh_token_ttl` | `duration` | Refresh token lifetime; default 30d. |

### OauthClientStatus

| Field | Type | What it is |
| --- | --- | --- |
| `observed_generation` | `int64` | The generation this status was computed from. Output only. |
| `conditions` | `Condition[]` | Ready, Reconciling, Stalled. Output only. |
| `client_id` | `string` | The OAuth `client_id`. Output only. |
| `client_secret` | `string` | The client secret, for `client_secret_basic`; set only in the responses of Create and RollSecret. Output only. Never returned again. |
| `client_secret_last4` | `string` | The last four characters of the client secret. Output only. |

### Condition

| Field | Type | What it is |
| --- | --- | --- |
| `type` | `string` | The condition type, for example `Ready`. |
| `status` | `ConditionStatus` | Whether the condition holds. One of `true`, `false`, `unknown`. |
| `observed_generation` | `int64` | The generation this observation was made against. |
| `reason` | `string` | A machine-readable UpperCamelCase reason. |
| `message` | `string` | A customer-safe human-readable message. |
| `severity` | `Severity` | How severe a FALSE condition is. One of `info`, `warning`, `error`. |
| `transition_time` | `timestamp` | When `status` last changed. |

## Errors

- [`UNAUTHENTICATED`](/docs/api/errors/UNAUTHENTICATED) — No valid key or token was presented.
- [`PERMISSION_DENIED`](/docs/api/errors/PERMISSION_DENIED) — The key lacks the method's permission.
- [`UNKNOWN_FIELD`](/docs/api/errors/UNKNOWN_FIELD) — The request has a field the schema does not know.
- [`INVALID_FIELD`](/docs/api/errors/INVALID_FIELD) — A field failed validation.
- [`RESOURCE_ALREADY_EXISTS`](/docs/api/errors/RESOURCE_ALREADY_EXISTS) — A Resource with this name exists.
- [`IDEMPOTENCY_KEY_REUSED`](/docs/api/errors/IDEMPOTENCY_KEY_REUSED) — An Idempotency-Key was reused with another body.
- [`IDEMPOTENCY_IN_PROGRESS`](/docs/api/errors/IDEMPOTENCY_IN_PROGRESS) — The first call with this Idempotency-Key is still running.
- [`PLAN_LIMIT_REACHED`](/docs/api/errors/PLAN_LIMIT_REACHED) — The plan's limit is reached.

Every error arrives in the body [Errors](/docs/platform/errors) describes.

## Examples

**cURL**

```curl
curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/oauth_clients" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"spec":{"client_type":"confidential","grant_types":["authorization_code"],"token_endpoint_auth_method":"none"}}'
```

**TypeScript**

```ts
const response = await sylphx.auth.oauthClients.create({ oauthClient: { spec: { clientType: 'confidential', grantTypes: ['authorization_code'], tokenEndpointAuthMethod: 'none' } }, parent: 'orgs/acme/projects/shop/envs/production' })
```

**Rust**

```rust
let mut req = sylphx::auth::CreateOauthClientRequest::default();
req.oauth_client = Some(sylphx::auth::OauthClient {
    spec: Some(sylphx::auth::OauthClientSpec {
        client_type: sylphx::auth::OauthClientType::Confidential,
        grant_types: vec![sylphx::auth::GrantType::AuthorizationCode],
        token_endpoint_auth_method: sylphx::auth::TokenEndpointAuthMethod::None,
        ..Default::default()
    }),
    ..Default::default()
});
req.parent = "orgs/acme/projects/shop/envs/production".to_string();
let response = sx.auth().oauth_clients().create(req).await?;
```

**CLI**

```bash
sylphx auth oauth-clients create --parent orgs/acme/projects/shop/envs/production --spec.client-type confidential --spec.token-endpoint-auth-method none
```

**Terraform**

```hcl
resource "sylphx_auth_oauth_client" "oauth_client" {
  oauth_client_id = "oauth_client"
  parent          = "orgs/acme/projects/shop/envs/production"
  spec            = { client_type = "confidential", grant_types = ["authorization_code"], token_endpoint_auth_method = "none" }
}
```

**MCP**

```json
{ "method_id": "auth.oauth_clients.create", "args": {"oauth_client":{"spec":{"client_type":"confidential","grant_types":["authorization_code"],"token_endpoint_auth_method":"none"}},"parent":"orgs/acme/projects/shop/envs/production"} }
```