public_git/pikvm
1
0
Fork 0
mirror of https://github.com/pikvm/pikvm.git synced 2026-10-18 05:44:19 +02:00
Code Issues Projects Releases Wiki Activity

2fa

Browse Source
This commit is contained in:
Maxim Devaev
2023-01-23 14:44:49 +02:00
parent 4f7e49d595
commit 2c7cf7cc02
6 changed files with 80 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/api.md
+6 -3
View File
@@ -4,11 +4,14 @@ This document describes the PiKVM API. Since the system consists of microservice
-----
## Authorization
## Authentication
All APIs are restricted to authorization. To make requests, you either need to authorize each request individually,
All APIs are restricted to authentication. To make requests, you either need to auth each request individually,
or get a token and pass it as a cookie with each request.
!!! note
With enabled [2FA](auth), you will need to add the one-time code to the password without spaces. That is, if the password is `foobar` and the code is `123456`, then you need to use `foobar123456` as the password.
### Single request auth
@@ -29,7 +32,7 @@ There are two options here:
### Session-based cookie auth
1. Authorize and get token for the user using `POST /api/auth/login`:
1. Get the access token for the user using `POST /api/auth/login`:
```
$ curl -k -v -X POST --data user=admin --data passwd=admin https://pikvm/api/auth/login