Skip to main content

OAuth Clients API

Manage the OAuth 2.0 / OIDC clients (applications) within your workspaces.

Create Client​

Create a new OAuth 2.0 client application.

Request

curl -X POST https://api.syauth.com/e/v1/developer/clients/ \
  -H "X-Developer-Token: syat_..." \
  -H "Content-Type: application/json" \
  -d '{
    "name": "My New App",
    "client_type": "public",
    "response_types": ["code"],
    "redirect_uris": ["https://localhost:3000/callback"],
    "allowed_grant_types": ["authorization_code"],
    "allowed_response_types": ["code"],
    "allowed_scopes": ["openid", "profile"],
    "workspace": "78047707-5f8f-472b-a065-3d3dc48ba80a"
  }'

redirect_uris, allowed_grant_types, allowed_response_types, and allowed_scopes may be sent as JSON arrays. Comma-separated or whitespace-separated strings are also accepted for backwards compatibility.

Response

{
  "id": "10e3a0f2-488b-47aa-84b0-5c933db93a75",
  "name": "My New App",
  "client_id": "dc4d9176-37...",
  "client_secret": "***HIDDEN***",
  "client_type": "public",
  "workspace": "78047707-5f8f-472b-a065-3d3dc48ba80a",
  "redirect_uris": "https://localhost:3000/callback",
  "allowed_grant_types": "authorization_code",
  "allowed_response_types": "code",
  "allowed_scopes": "openid,profile",
  "auto_approve": false,
  "is_active": true,
  "created_at": "2026-01-07T10:05:00Z"
}

List Clients​

List all OAuth clients.

Request

curl -X GET https://api.syauth.com/e/v1/developer/clients/ \
  -H "X-Developer-Token: syat_..."

Response

[
  {
    "id": "10e3a0f2-488b-47aa-84b0-5c933db93a75",
    "name": "Main Application",
    "client_id": "dc4d9176-37...",
    "client_secret": "***HIDDEN***",
    "client_type": "confidential",
    "workspace": "78047707-5f8f-472b-a065-3d3dc48ba80a",
    "redirect_uris": "https://app.example.com/callback",
    "allowed_grant_types": "authorization_code",
    "allowed_response_types": "code",
    "allowed_scopes": "openid,profile",
    "is_active": true
  }
]

Get Client Details​

Request

curl -X GET https://api.syauth.com/e/v1/developer/clients/10e3a0f2-488b-47aa-84b0-5c933db93a75/ \
  -H "X-Developer-Token: syat_..."

Response

{
  "id": "10e3a0f2-488b-47aa-84b0-5c933db93a75",
  "name": "My New App",
  "client_id": "dc4d9176-37...",
  "client_secret": "***HIDDEN***",
  "client_type": "public",
  "workspace": "78047707-5f8f-472b-a065-3d3dc48ba80a",
  "redirect_uris": "https://localhost:3000/callback",
  "allowed_grant_types": "authorization_code",
  "allowed_response_types": "code",
  "allowed_scopes": "openid,profile",
  "is_active": true,
  "created_at": "2026-01-07T10:05:00Z"
}

Update Client​

Update an existing OAuth client.

Request

curl -X PUT https://api.syauth.com/e/v1/developer/clients/10e3a0f2-488b-47aa-84b0-5c933db93a75/ \
  -H "X-Developer-Token: syat_..." \
  -H "Content-Type: application/json" \
  -d '{"name": "My New App Updated", "redirect_uris": ["https://app.example.com/callback"]}'

Response

{
  "id": "10e3a0f2-488b-47aa-84b0-5c933db93a75",
  "name": "My New App Updated",
  "client_id": "dc4d9176-37...",
  "client_secret": "***HIDDEN***",
  "client_type": "public",
  "workspace": "78047707-5f8f-472b-a065-3d3dc48ba80a",
  "redirect_uris": "https://app.example.com/callback",
  "allowed_grant_types": "authorization_code",
  "allowed_response_types": "code",
  "allowed_scopes": "openid,profile",
  "is_active": true,
  "created_at": "2026-01-07T10:05:00Z"
}

Delete Client​

Permanently delete an OAuth client.

Request

curl -X DELETE https://api.syauth.com/e/v1/developer/clients/10e3a0f2-488b-47aa-84b0-5c933db93a75/ \
  -H "X-Developer-Token: syat_..."

Response 204 No Content