Create oauth client

POST/workspaces/{organizationId}/oauth-clients

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (Authorization: Bearer <key>). Issue keys under Settings → Developer or POST /workspaces/{organizationId}/tokens.

Path parameters

organizationIdstringrequired

Request body

application/json

namestringrequired

min length 1

redirectUrisstring<uri>[]

default: []

scopesstring[]

default: []

permissionsstring

default: "read"

Responses

201

OAuth client created

idstringrequired

organizationIdstringrequired

namestringrequired

redirectUrisstring[]required

scopesstring[]required

permissionsstringrequired

createdAtstringrequired

clientIdstringrequired

clientSecretstringrequired

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*

Bodyapplication/json

Request body

Request

curl -X POST 'https://pile.nyc/workspaces/string/oauth-clients' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "redirectUris": [],
  "scopes": [],
  "permissions": "read"
}'

const response = await fetch("https://pile.nyc/workspaces/string/oauth-clients", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"redirectUris\": [],\n  \"scopes\": [],\n  \"permissions\": \"read\"\n}"
});

import requests

response = requests.post(
    "https://pile.nyc/workspaces/string/oauth-clients",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"redirectUris\": [],\n  \"scopes\": [],\n  \"permissions\": \"read\"\n}",
)

Response

{
  "id": "string",
  "organizationId": "string",
  "name": "string",
  "redirectUris": [
    "string"
  ],
  "scopes": [
    "string"
  ],
  "permissions": "string",
  "createdAt": "string",
  "clientId": "string",
  "clientSecret": "string"
}