DEdefaulr
OAuthClients

Retrieve an OAuth client

Changed on

To retrieve information about an OAuth client you must pass either an id or a clientId.

post/oauthClients.info

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/oauthClients.info
  • 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

idstring uuid

Unique identifier for the OAuth client.

clientIdstring

Public identifier for the OAuth client. This may also be the URL of a client ID metadata document, in which case the client's details are resolved from that document.

Example request

{
  "clientId": "2bquf8avrpdv31par42a"
}

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

  • bdcdfdf42d93Revision changes
    • 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