Create an OAuth app

Settings module

POST/oauth-appsoauthApps.create

An OAuth 2.1 client using PKCE. Creates an OAuth app. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

Requires the capability org.integrations.manage.
OAuth scopes: org.
Send an Idempotency-Key header. A replay with the same key returns the original response.
Error statuses: 400, 401, 409, 422, 429. Errors are RFC 9457 problem details.

Request body: OauthAppCreate

oauthApps.create: OauthAppCreate
Field	Type	Required	Description
name	string	Yes	App name.Constraints: length 1 to 300
redirect_uri	string (uri)	Yes	Registered redirect URI.

{
  "name": "Show Planner",
  "redirect_uri": "https://northwindlive.example/files/site-plan.pdf"
}

Response 201: OauthApp

oauthApps.create: OauthApp
Field	Type	Required	Description
id	string (uuid)	Yes	Identifier of the oauth app.
org_id	string (uuid)	Yes	Identifier of the owning organization, derived from the parent row and never accepted from the caller.
created_at	string (date-time)	Yes	When the row was created.
created_by	string (uuid) \| null	Yes	Identifier of the person who created the row; null when a seed, platform or system process created it.
updated_at	string (date-time)	Yes	When the row was last updated.
updated_by	string (uuid) \| null	Yes	Identifier of the person who last updated the row; null when a seed, platform or system process updated it.
name	string	Yes	App name.Constraints: length 1 to 300
client_id	string	Yes	OAuth client identifier.Constraints: pattern ^[A-Za-z0-9][A-Za-z0-9._-]{0,63}$
redirect_uri	string (uri)	Yes	Registered redirect URI.

{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "name": "Show Planner",
  "client_id": "xos_client_31f9",
  "redirect_uri": "https://northwindlive.example/files/site-plan.pdf"
}

Code samples

curl -X POST "$XOS_BASE_URL/oauth-apps" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"name":"Show Planner","redirect_uri":"https://northwindlive.example/files/site-plan.pdf"}'

const { data } = await xos.oauthApps.create({
    "name": "Show Planner",
    "redirect_uri": "https://northwindlive.example/files/site-plan.pdf"
  });

response = xos.oauth_apps.create({"name": "Show Planner", "redirect_uri": "https://northwindlive.example/files/site-plan.pdf"})

xos oauth-apps create --data '{"name":"Show Planner","redirect_uri":"https://northwindlive.example/files/site-plan.pdf"}'