Connections
Register an app
Registers an app that signs in with Plotwork.
POST
/user/apps/registeredTL;DR
| Question | Answer |
|---|---|
| What does it do? | Register an app. |
| What does it take? | A JSON body of type NewAppBody. |
| What does it return? | Status 201 with a body of type AppWithSecret. |
| What can go wrong? | 400 the body is not valid; 401 not signed in; 403 the request came from an origin that may not make changes; 409 you hold the most apps allowed (apps.limit_reached); 422 a redirect address or the homepage breaks the rules (apps.invalid); 429 too many requests. Every failure uses the one error envelope. |
What it does
Registers an app that signs in with Plotwork. A confidential app gets a client secret, shown in this answer only. Redirect addresses are https, or http on a loopback host, matched exactly.
Request body
The body has the type NewAppBody.
| Field | Type | Required | Description |
|---|---|---|---|
name | string | yes | at least 3 characters; at most 60 characters. |
homepage | string | null | no | An https address, shown as a claim. at most 2048 characters. |
clientType | "confidential" | "public" | yes | |
redirectUris | string[] | yes | One to ten addresses a code may be sent to, matched exactly: https, or http on localhost, 127.0.0.1 or [::1] with any port. |
Responses
| Status | Meaning | Body |
|---|---|---|
| 201 | Registered, with the secret shown once. | AppWithSecret |
| 400 | The body is not valid. | ErrorResponse |
| 401 | Not signed in. | ErrorResponse |
| 403 | The request came from an origin that may not make changes. | ErrorResponse |
| 409 | You hold the most apps allowed (apps.limit_reached). | ErrorResponse |
| 422 | A redirect address or the homepage breaks the rules (apps.invalid). | ErrorResponse |
| 429 | Too many requests. | ErrorResponse |
Response body
A 201 answer has the type AppWithSecret.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | yes | The app's id, which is its OAuth client_id. |
name | string | yes | Shown to people as a claim on the consent page. |
homepage | string | null | yes | |
clientType | "confidential" | "public" | yes | confidential holds a client secret on its server; public (a page or a tool with no server) holds none. |
redirectUris | string[] | yes | |
membersOnly | boolean | yes | For an organisation's app: only its members may connect it, to the organisation. |
hasSecret | boolean | yes | |
createdAt | integer | yes | Milliseconds since the epoch. |
updatedAt | integer | yes | Milliseconds since the epoch. |
clientSecret | string | null | yes | The client secret (pws_...), shown once, or null for a public app. Store it on your server. |
See also
| Doc | Why |
|---|---|
| API reference | Every endpoint, and the error envelope |
| Schemas | Every request and response type |
| Tool reference | The operations as callable tools |