DEdefaulr
OAuthClients

Create an OAuth client

Changed on

Create a new OAuth client application that can be used to authenticate users and access the API on their behalf.

post/oauthClients.create

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/oauthClients.create
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://app.getoutline.com/oauth/authorize
      Token URL: https://app.getoutline.com/oauth/token scopes: read, write

Request body

namestring required

Name of the OAuth client.

descriptionstring

A short description of this OAuth client.

developerNamestring

The name of the developer who created this OAuth client.

developerUrlstring

The URL of the developer who created this OAuth client.

avatarUrlstring

A URL pointing to an image representing the OAuth client.

redirectUrisstring[] required

List of redirect URIs for the OAuth client. Each entry must be an absolute URL that includes a scheme, for example https://example.com/callback. Private-use URI schemes for native applications are also accepted, for example com.example.app:/oauth2redirect (see RFC 8252).

publishedboolean

Whether the OAuth client is available to other workspaces.

Example request

{
  "name": "My App",
  "description": "Integrate Acme Inc's services into Outline.",
  "developerName": "Acme Inc",
  "developerUrl": "https://example.com",
  "redirectUris": [
    "https://example.com/callback",
    "com.example.app:/oauth2redirect"
  ],
  "published": true
}

Response

OK

Example response

{
  "data": {
    "name": "Acme Inc",
    "description": "Integrate Acme Inc's services into Outline.",
    "developerName": "Acme Inc",
    "developerUrl": "https://example.com",
    "clientId": "2bquf8avrpdv31par42a",
    "clientSecret": "ol_sk_rapdv31...",
    "redirectUris": [
      "https://example.com/callback"
    ],
    "published": true
  },
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ]
}

Changes

  • cd18cbbc1706Revision changes
    • warning

      the request property's maxLength was set to 1024

    • warning

      the request property's maxLength was set to 255

    • warning

      the request property's maxLength was set to 100

    • warning

      the request property's maxLength was set to 1024

    • warning

      the request property's maxLength was set to 100

    • warning

      the / request property's maxLength was set to 1024

  • 304cd065561bRevision changes
    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the response property / became nullable for the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status