diff options
| author | techknowlogick <techknowlogick@gitea.io> | 2019-05-07 16:53:45 -0400 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-05-07 16:53:45 -0400 |
| commit | 36bde02841f0736acb4529a6ce453ff694934e6a (patch) | |
| tree | 8837ca6973ab7c75fe2b2bcddda35f9955ce1cc1 /docs | |
| parent | 91c2c237f96fe5a7d902406a4b9fe908bf53d526 (diff) | |
| download | gitea-36bde02841f0736acb4529a6ce453ff694934e6a.tar.gz gitea-36bde02841f0736acb4529a6ce453ff694934e6a.zip | |
Add documentation for OTP/2FA header in API for basic auth (#6872)
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/content/doc/advanced/api-usage.en-us.md | 6 |
1 files changed, 6 insertions, 0 deletions
diff --git a/docs/content/doc/advanced/api-usage.en-us.md b/docs/content/doc/advanced/api-usage.en-us.md index c5db817fdb..8e0b43ec24 100644 --- a/docs/content/doc/advanced/api-usage.en-us.md +++ b/docs/content/doc/advanced/api-usage.en-us.md @@ -82,6 +82,12 @@ $ curl --request GET --url https://yourusername:yourpassword@gitea.your.host/api [{"name":"test","sha1":"..."},{"name":"dev","sha1":"..."}] ``` +As of v1.8.0 of Gitea, if using basic authentication with the API and your user has two factor authentication enabled, you'll need to send an additional header that contains the one time password (6 digit rotating token). An example of the header is `X-Gitea-OTP: 123456` where `123456` is where you'd place the code from your authenticator. Here is how the request would look like in curl: + +``` +$ curl -H "X-Gitea-OTP: 123456" --request GET --url https://yourusername:yourpassword@gitea.your.host/api/v1/users/yourusername/tokens +``` + ## Sudo The API allows admin users to sudo API requests as another user. Simply add either a `sudo=` parameter or `Sudo:` request header with the username of the user to sudo. |