Reference

OAUTH clients

An OAuth Client is a relying party of the customer's authorization server: its app, API, or CLI.

Checked 2026-09-28

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.

An OAuth Client is a relying party of the customer's authorization server: its app, API, or CLI. Tokens are signed by a Sylphx Keys handle and verify offline from the published JWKS.

Service Sylphx Auth · Resource type auth.sylphx.com/OauthClient · Name pattern orgs/{org}/projects/{project}/envs/{env}/oauth_clients/{oauth_client} · Shape spec_status

#Fields

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.

#Methods

Every method of the collection, in the registry's order, with the scope it needs. The full request, response and examples are one link away.

Method	Call	What it does
GET	get	Gets an OAuth client.
GET	list	Lists OAuth clients.
POST	create	Creates an OAuth client.
PATCH	update	Updates an OAuth client.
DELETE	delete	Deletes an OAuth client.
POST	roll_secret	Issues a new client secret, returned once; the old one verifies until grace_period ends.

#get

Gets an OAuth client.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/oauth_clients/oauth-client · scope auth:read · effect read · Request, response and examples

#list

Lists OAuth clients.

GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/oauth_clients · scope auth:read · effect read · paginated · Request, response and examples

#create

Creates an OAuth client.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/oauth_clients · scope auth:write · effect write · Request, response and examples

#update

Updates an OAuth client.

PATCH https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/oauth_clients/oauth-client · scope auth:write · effect write · Request, response and examples

#delete

Deletes an OAuth client.

DELETE https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/oauth_clients/oauth-client · scope auth:write · effect destructive · Request, response and examples

#roll_secret

Issues a new client secret, returned once; the old one verifies until grace_period ends.

POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/oauth_clients/oauth-client:rollSecret · scope auth:write · effect write · validate_only · Request, response and examples