DEdefaulr
Users

Suspend a user

Changed on

Suspending a user prevents the user from signing in. Users that are suspended are also not counted against billing totals in the hosted version.

post/users.suspend

Request

  • Base URL
    https://app.getoutline.com/api
  • URL
    https://app.getoutline.com/api/users.suspend
  • 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 required

Unique identifier for the user.

Response

OK

Example response

{
  "data": {
    "name": "Jane Doe"
  },
  "policies": [
    {
      "abilities": {
        "read": true,
        "update": true,
        "delete": false
      }
    }
  ]
}

Changes

  • 9a99ee93e11dRevision changes
    • info

      added the optional property / to the response with the status

  • 304cd065561bRevision changes
    • 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

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status