Cloudflare/oauth Clients
@swamp/cloudflare/oauth-clientsv2026.10.23.1
01README
Cloudflare oauth-clients infrastructure models
02Release Notes
- Updated: oauth_clients
03Behaviors
@swamp/cloudflare/oauth-clients/oauth-clientsv2026.10.23.1oauth_clients.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| allowed_cors_origins? | array | Array of allowed CORS origins. |
| client_name? | string | Human-readable name of the OAuth client. |
| client_uri? | string | URL of the home page of the client. |
| grant_types? | array | Array of OAuth grant types the client is allowed to use. `authorization_code` is required; `refresh_token` may be included optionally. |
| logo_uri? | string | URL of the client's logo. |
| optional_scopes? | array | Scopes that the authorizing user may decline during consent. Each value must also appear in `scopes`. The scopes `openid`, `offline`, and `offline_access` cannot be optional. |
| policy_uri? | string | URL that points to a privacy policy document. |
| post_logout_redirect_uris? | array | Array of allowed post-logout redirect URIs. |
| redirect_uris? | array | Array of allowed redirect URIs for the client. |
| response_types? | array | Array of OAuth response types the client is allowed to use. |
| scopes? | array | Array of OAuth scopes the client is allowed to request. Colon-delimited scopes are not accepted. Dot-delimited scopes are validated against available OAuth API scopes; simple identity scopes are allowed. Protocol scopes `offline_access` and `openid` are added or removed automatically based on `grant_types` and `response_types`. |
| token_endpoint_auth_method? | enum | The authentication method the client uses at the token endpoint. |
| tos_uri? | string | URL that points to a terms of service document. |
| visibility? | enum | Promote the OAuth client from private to public visibility. Only `public` is accepted; demotion to `private` is not supported. Promotion requires a non-empty client name, logo URI, verified client URI host, and at least one non-identity scope. |
| apiToken? | string | Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| apiKey? | string | Cloudflare API key for the legacy key+email auth path; overrides the CLOUDFLARE_API_KEY environment variable. Wire with a vault.get(...) expression. Requires email. |
| email? | string | Cloudflare account email for the legacy key+email auth path; overrides the CLOUDFLARE_EMAIL environment variable. Requires apiKey. |
fn create()
Create a Oauth Clients
fn get(id: string)
Get a Oauth Clients
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Oauth Clients |
fn lookup(allowMissing?: boolean)
Look up an existing Oauth Clients by matching global argument values and import it into state
| Argument | Type | Description |
|---|---|---|
| allowMissing? | boolean | Succeed and record found: false in lookupResult when nothing matches, instead of failing |
fn adopt(id: string)
Import an existing Oauth Clients by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Oauth Clients to import |
fn update(identifier?: string)
Update Oauth Clients attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Oauth Clients by id (e.g. one discovered by list) |
fn delete(id: string)
Delete the Oauth Clients
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Oauth Clients |
fn sync(identifier?: string)
Sync Oauth Clients state from Cloudflare
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Oauth Clients by id (e.g. one discovered by list) |
Resources
state(infinite)— Oauth Clients resource state
lookupResult(infinite)— Outcome of the most recent lookup
04Previous Versions
2026.10.20.1AGPL-3.0-or-later
- Updated: oauth_clients
Modified 1 behaviors
2026.10.16.1AGPL-3.0-or-later(was none)
2026.10.13.1
- Updated: oauth_clients
2026.09.29.1
- Updated: oauth_clients
2026.08.26.1
- Updated: oauth_clients
2026.07.21.1
- Updated: oauth_clients
2026.07.18.2
Modified 1 behaviors
2026.06.08.2
- Updated: oauth_clients
05Stats
A
100 / 100
Downloads
25
Archive size
13.8 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
06Platforms
07Labels