Authorize a Client

Called by the web consent page once the signed-in user approves a native client or app. Stores a single-use code bound to the PKCE challenge and returns the URL to send the user back to. Browser session only. Include platform to register the client as a device.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

redirect_uri*string

Where to send the user afterwards: a custom URL scheme, a loopback http URL (127.0.0.1, [::1], localhost, any port), or a configured https universal link.

code_challenge*string

Base64url SHA-256 of the client's secret code_verifier (PKCE S256).

state?string

Opaque client value echoed back on the redirect.

name*string

Shown to the user and in the Devices/Apps list, e.g. "Platrium for iPhone" or "Platrium CLI".

platform?string

IOS, MACOS, ANDROID, ... When present the client is registered as a device; when absent it is an app.

app_version?string

Response Body

`application/json`

curl -X POST "https://example.com/auth/authorize" \  -H "Content-Type: application/json" \  -d '{    "redirect_uri": "string",    "code_challenge": "string",    "name": "string"  }'

{  "redirect_to": "string"}

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`