Skip to main content
POST
/
deployments
/
{deployment_id}
/
oauth
/
apps
Create OAuth app
curl --request POST \
  --url https://api.wacht.dev/deployments/{deployment_id}/oauth/apps \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'slug=<string>' \
  --form 'name=<string>' \
  --form 'description=<string>' \
  --form 'fqdn=<string>' \
  --form 'supported_scopes=<string>' \
  --form 'scope_definitions={
  "scope": "<string>",
  "display_name": "<string>",
  "description": "<string>",
  "archived": true,
  "category": "",
  "organization_permission": "<string>",
  "workspace_permission": "<string>"
}' \
  --form allow_dynamic_client_registration=true \
  --form logo='@example-file'
{
  "id": "<string>",
  "slug": "<string>",
  "name": "<string>",
  "description": "<string>",
  "logo_url": "<string>",
  "fqdn": "<string>",
  "supported_scopes": [
    "<string>"
  ],
  "scope_definitions": [
    {
      "scope": "<string>",
      "display_name": "<string>",
      "description": "<string>",
      "archived": true,
      "category": "",
      "organization_permission": "<string>",
      "workspace_permission": "<string>"
    }
  ],
  "allow_dynamic_client_registration": true,
  "is_active": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization
string
header
required

API key authentication (format: Bearer {api_key})

Path Parameters

deployment_id
string
required

Deployment ID

Body

slug
string
required

Unique slug for the OAuth app

name
string
required

Display name

description
string | null
fqdn
string | null

Domain used by the OAuth app

supported_scopes
string[]
scope_definitions
object[]
allow_dynamic_client_registration
boolean

Optional logo upload (multipart/form-data only)

Response

200 - application/json

OAuth app created

id
string
slug
string
name
string
description
string | null
logo_url
string | null
fqdn
string
supported_scopes
string[]
scope_definitions
object[]
allow_dynamic_client_registration
boolean
is_active
boolean
created_at
string<date-time>
updated_at
string<date-time>