Skip to main content

Update

Endpoint

PUT  /api/v1/users/:user

Parameters

The following parameters are used to configure the endpoint:

NameDescription
username of user

Permissions

COMING SOON!

Responses

Status CodeDescription
200indicates the request has succeeded
401indicates the user does not have proper permissions

Sample

warning

This section assumes you already know how to authenticate to the API.

To authenticate to the API, please review the authentication documentation.

File

{
"admin": true
}

Request

curl \
-X PUT \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json" \
-d "@data.json" \
"http://127.0.0.1:8080/api/v1/users/OctoKitty"

Response

{
"id": 1,
"name": "OctoKitty",
"token": null,
"favorites": ["github/octocat"],
"active": true,
"admin": true
}