POST /admin/oauth to Enable or Disable

POST https://example.com/admin/oauth

Description

Enables or disables OAuth, the setting of the OAuth enabled / OAuth disabled switch on the Security Profiles page of the admin portal. See Enable OAuth.

DS Server stores the new setting at once, and GET /admin/oauth and the admin portal show it, but the running server keeps checking access tokens as before until it is restarted. The switch in the admin portal takes effect at once.

Examples

The following sample enables OAuth.

# Request:
curl --request POST 'https://trial.dsserver.io/admin/oauth' \
    --header 'Authorization: Basic YWRtaW46YWRtaW5hZG1pbg==' \
    --header 'Content-Type: application/json' \
    --data-raw '{ "active": true }'

# Result:
true

Authorization

This endpoint supports the Basic authorization method:

Basic

Header field	Description
Authorization	The username "admin" and your admin password are combined into a string separated by a colon, e.g.: admin:password. The resulting string is encoded using the RFC2045-MIME variant of Base64, except not limited to 76 char/line. The authorization method and a space i.e. "Basic " is then put before the encoded string. For example: `Authorization: Basic QWxhZGRpbjpPcGVuU2VzYW1l`

Request Payload

Type	Value
Object	A JSON object (`application/json`) with the Boolean field `active`: `true` enables OAuth, `false` disables it. An empty object `{}` disables OAuth.

Success Response

Status	Description
200	On success, the HTTP status code in the response header is 200 (OK). The return value is the new setting, `true` or `false`.

Error Response

Status	Description
401	A 401 (Unauthorized) is returned, if the user is not authorized.
500	A 500 (Internal Server Error) is returned, if the body is missing or is not a JSON object, for example the bare value `false`.