Outline · Example Payload

Oauthclientscreate

OAuthClients

Oauthclientscreate is an example object payload from Outline, with 6 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

operationIdpathmethodsummarytagsrequestSchema

Example Payload

Raw ↑ 
{
  "operationId": "oauthClientsCreate",
  "path": "/oauthClients.create",
  "method": "POST",
  "summary": "Create an OAuth client",
  "tags": [
    "OAuthClients"
  ],
  "requestSchema": {
    "type": "object",
    "properties": {
      "name": {
        "type": "string",
        "description": "Name of the OAuth client.",
        "example": "My App"
      },
      "description": {
        "type": "string",
        "description": "A short description of this OAuth client.",
        "example": "Integrate Acme Inc's services into Outline."
      },
      "developerName": {
        "type": "string",
        "description": "The name of the developer who created this OAuth client.",
        "example": "Acme Inc"
      },
      "developerUrl": {
        "type": "string",
        "description": "The URL of the developer who created this OAuth client.",
        "example": "https://example.com"
      },
      "avatarUrl": {
        "type": "string",
        "description": "A URL pointing to an image representing the OAuth client."
      },
      "redirectUris": {
        "type": "array",
        "items": {
          "type": "string"
        },
        "description": "List of redirect URIs for the OAuth client.",
        "example": [
          "https://example.com/callback"
        ]
      },
      "published": {
        "type": "boolean",
        "description": "Whether the OAuth client is available to other workspaces.",
        "example": true
      }
    },
    "required": [
      "name",
      "redirectUris"
    ]
  }
}