mirror of
https://github.com/scm-manager/scm-manager.git
synced 2026-08-04 23:59:20 +02:00
Add api key documentation
This commit is contained in:
@@ -4,3 +4,4 @@
|
||||
- /user/user/
|
||||
- /user/group/
|
||||
- /user/admin/
|
||||
- /user/profile/
|
||||
|
||||
BIN
docs/de/user/profile/assets/api-key-created.png
Normal file
BIN
docs/de/user/profile/assets/api-key-created.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 46 KiB |
BIN
docs/de/user/profile/assets/api-key-overview.png
Normal file
BIN
docs/de/user/profile/assets/api-key-overview.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 199 KiB |
50
docs/de/user/profile/index.md
Normal file
50
docs/de/user/profile/index.md
Normal file
@@ -0,0 +1,50 @@
|
||||
---
|
||||
title: Profil
|
||||
partiallyActive: true
|
||||
---
|
||||
|
||||
Über den Link zum Profil im Footer können Einstellungen zum eigenen Konto vorgenommen werden.
|
||||
|
||||
## Passwort ändern
|
||||
|
||||
Hier kann das Passwort für das Konto geändert werden, wenn es sich um ein lokales Konto handelt (wenn die Anmeldung
|
||||
also nicht über ein Fremdsystem erfolgt). Um die Änderung zu autorisieren, muss zunächst das aktuelle Passwort
|
||||
eingegeben werden. Danach muss das neue Passwort zweimal eingegeben werden.
|
||||
|
||||
## Öffentliche Schlüssel
|
||||
|
||||
Zum Prüfen von Signaturen für z. B. Commits können hier die entsprechenden öffentlichen Schlüssel hinterlegt werden.
|
||||
Zudem können hier die vom SCM-Manager erstellten Signaturschlüssel heruntergeladen werden.
|
||||
|
||||
## API Schlüssel
|
||||
|
||||
Zur Nutzung in anderen Systemen wie z. B. CI Systemen können sogenannte API Schlüssel erstellt werden. Sie können für
|
||||
den Zugriff auf Repositories über die REST API sowie über SCM-Clients genutzt werden. Dazu wird ein Anzeigename sowie
|
||||
eine [Rolle](../admin/roles/) ausgewählt. Der Anzeigename ist ausschließlich zur Verwaltung gedacht und hat keine
|
||||
weitere technische Bewandnis. Mithilfe der Rolle können die Berechtigungen eingeschränkt werden, die bei einer Anmeldung
|
||||
zur Verfügung stehen.
|
||||
|
||||
Hat z. B. ein Konto schreibende Rechte für ein Repository und wird ein API-Schlüssel mit der Rolle "READ" erzeugt, so
|
||||
kann über diesen Schlüssel nur lesend auf das Repository zugegriffen werden. Eine Ausweitung der Rechte hingegen ist
|
||||
selbstverständlich nicht möglich. Es kann also mithilfe eines API-Schlüssels mit der Rolle "WRITE" nicht schreibend auf
|
||||
ein Repository zugegriffen werden, für das bei dem Konto nur ein lesender Zugriff gestattet ist.
|
||||
|
||||

|
||||
|
||||
Nach der Erstellung eines Schlüssels, wird dieser **einmalig** angezeigt. Nachdem dieses Fenster
|
||||
geschlossen wurde, kann der Schlüssel nicht mehr abgerufen und nicht wiederhergestellt werden.
|
||||
|
||||

|
||||
|
||||
### Beispiel REST API
|
||||
|
||||
Um einen Schlüssel mit der REST API zu nutzen, muss der Schlüssel als Cookie mit dem Namen „X-Bearer-Token“
|
||||
übergeben werden. Für die Nutzung mit curl sieht ein Aufruf z. B. wie folgt aus:
|
||||
|
||||
```
|
||||
curl -v localhost:8081/scm/api/v2/repositories/ -H "Cookie: X-Bearer-Token=eyJhcGlLZXlJZCI...RTRHeCJ9"
|
||||
```
|
||||
|
||||
### Zugriff mit SCM-Client
|
||||
|
||||
Für einen Zugriff mit einem SCM-Client (z. B. `git`, `hg` oder `svn`) muss der Schlüssel als Passwort übergeben werden.
|
||||
@@ -12,6 +12,7 @@
|
||||
- /user/user/
|
||||
- /user/group/
|
||||
- /user/admin/
|
||||
- /user/profile/
|
||||
|
||||
- section: Administration
|
||||
entries:
|
||||
|
||||
BIN
docs/en/user/profile/assets/api-key-created.png
Normal file
BIN
docs/en/user/profile/assets/api-key-created.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 46 KiB |
BIN
docs/en/user/profile/assets/api-key-overview.png
Normal file
BIN
docs/en/user/profile/assets/api-key-overview.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 199 KiB |
49
docs/en/user/profile/index.md
Normal file
49
docs/en/user/profile/index.md
Normal file
@@ -0,0 +1,49 @@
|
||||
---
|
||||
title: Profile
|
||||
partiallyActive: true
|
||||
---
|
||||
|
||||
Settings for the active user account can be managed with the link "Profile" in the footer.
|
||||
|
||||
## Change password
|
||||
|
||||
Here the password for the current account can be changed when it is a local account (when the login is not managed by an
|
||||
external system). To authorize the change, the current password has to be put first. Then the new password has to be
|
||||
entered twice.
|
||||
|
||||
## Öffentliche Schlüssel
|
||||
|
||||
To check signatures for example for commits, public keys can be stored here. Additionally the keys created by
|
||||
SCM-Manager can be accessed here, too.
|
||||
|
||||
## API keys
|
||||
|
||||
To access SCM-Manager from other systems like for example CI servers, API keys can be created. They can be used to call
|
||||
the REST APi and for the access with SCM clients. To create a key you have to specify a display name and a
|
||||
[role](../admin/roles/). The display name is solely to keep track of your keys. The role limits the permissions granted
|
||||
when the SCM-Manager is accessed with such a key.
|
||||
|
||||
If, for exapmple, an account has write access for a repository and an API key with the role "READ" is created for this
|
||||
account, this repository can only be accessed read only using this key. Of course it is not possible to extend
|
||||
permissions. So you cannot create an API key with the role "WRITE" to get write access to a repository, where the
|
||||
original account has only read access for.
|
||||
|
||||

|
||||
|
||||
After the creation of a key, it will be displayed **once only**. After the window has been closed, the key cannot be
|
||||
retrieved or reconstructed again.
|
||||
|
||||

|
||||
|
||||
### Example for the REST API
|
||||
|
||||
To use an API key for the REST API, the key has to sent as a cookie with the name “X-Bearer-Token”. Using curl, this
|
||||
can be done like this:
|
||||
|
||||
```
|
||||
curl -v localhost:8081/scm/api/v2/repositories/ -H "Cookie: X-Bearer-Token=eyJhcGlLZXlJZCI...RTRHeCJ9"
|
||||
```
|
||||
|
||||
### Access with an SCM-Client
|
||||
|
||||
For access with an SCM client like `git`, `hg`, or `svn` the key simply has to be passed as a password.
|
||||
Reference in New Issue
Block a user