Konten und Anmeldung

Anmeldung, Sitzungen, persönliche Zugriffstoken, Benutzer, Gruppen und das Sicherheits-Audit.

Die Vorgänge dieser Gruppe mit ihrer Zugriffsregel, Wiederholungsregel, ihren Parametern und Antworten. Jede Anfrage trägt einen Schlüssel: Authorization: Bearer <Schlüssel> (siehe „Authentifizierung“).

Vorgänge

POST /api/v1/auth/login

Zugriff: Jeder, ohne Schlüssel · Wiederholung: Nicht automatisch wiederholen

Tauscht den name und das password eines Kontos gegen ein Bearer-Sitzungs-token mit 12 Stunden Gültigkeit samt expiresAt und dem Konto; senden Sie es als Authorization: Bearer. Ein unbekannter Name, ein falsches Passwort und ein deaktiviertes Konto ergeben alle dieselbe Antwort 401 invalid_credentials. Versuche werden pro Client-Adresse und pro Konto gedrosselt (429 rate_limited mit Retry-After), und ein Konto behält höchstens 32 Sitzungen: Eine neue beendet die älteste.

Anfragetext (application/json)

Feld	Typ	Erforderlich	Regeln
`name`	string	ja	—
`password`	string (password)	ja	—

Antwort 200

Feld	Typ	Erforderlich	Regeln
`token`	string	ja	—
`expiresAt`	string (date-time)	ja	—
`account`	object	ja	—
`account.id`	string (uuid)	ja	—
`account.name`	string	ja	—
`account.administrator`	boolean	ja	—
`account.enabled`	boolean	ja	—

Antworten: 200, 400, 401, 403, 405, 413, 415, 429, 503

Beispiel

bash

curl -X POST "$ARKVORY_URL/api/v1/auth/login" \
  -H "Content-Type: application/json" \
  -d '{"name":"<name>","password":"<password>"}'

Konto registrieren

POST /api/v1/auth/register

Zugriff: Jeder, ohne Schlüssel · Wiederholung: Nicht automatisch wiederholen

Erstellt ein gewöhnliches Konto (nie einen Administrator) mit name (3–64 Buchstaben, Ziffern oder _.-) und password (12–128 Zeichen) und meldet es an; die Antwort ist 201 mit einer 12-Stunden-Sitzung wie bei login. Funktioniert nur, wenn der Server die Selbstregistrierung erlaubt (siehe getAuthOptions), sonst 403 registration_disabled; ein vergebener Name ergibt 409 already_exists. Versuche werden pro Client-Adresse gedrosselt (429 mit Retry-After), und die Selbstregistrierung endet bei 900 Konten.

Anfragetext (application/json)

Feld	Typ	Erforderlich	Regeln
`name`	string	ja	—
`password`	string (password)	ja	—

Antwort 201

Feld	Typ	Erforderlich	Regeln
`token`	string	ja	—
`expiresAt`	string (date-time)	ja	—
`account`	object	ja	—
`account.id`	string (uuid)	ja	—
`account.name`	string	ja	—
`account.administrator`	boolean	ja	—
`account.enabled`	boolean	ja	—

Antworten: 201, 400, 403, 405, 413, 415, 429, 503

Beispiel

bash

curl -X POST "$ARKVORY_URL/api/v1/auth/register" \
  -H "Content-Type: application/json" \
  -d '{"name":"<name>","password":"<password>"}'

Anmeldeoptionen abrufen

GET HEAD /api/v1/auth/options

Zugriff: Jeder, ohne Schlüssel · Wiederholung: Wiederholen ist sicher (Lesen)

Teilt einer Konsole vor der Anmeldung mit, welche Formulare sie zeigen soll: selfRegistration ist true, wenn registerAccount auf diesem Server offen ist.

Antwort 200

Feld	Typ	Erforderlich	Regeln
`selfRegistration`	boolean	ja	—

Antworten: 200, 400, 403, 503

Beispiel

bash

curl -X GET "$ARKVORY_URL/api/v1/auth/options"

Eigene persönliche Zugriffstoken auflisten

GET HEAD /api/v1/auth/tokens

Zugriff: Eine angemeldete Kontositzung (kein Schlüssel) · Wiederholung: Wiederholen ist sicher (Lesen)

Listet die persönlichen Zugriffstoken des angemeldeten Kontos auf, aktive zuerst, mit Name, Präfix, Scope, Erstellung, Ablauf, letzter Verwendung und der Angabe, ob das jeweilige Token widerrufen ist; die Geheimnisse werden nie wieder angezeigt.

Antwort 200

Feld	Typ	Erforderlich	Regeln
`items`	Array von object	ja	höchstens 100 Elemente
`items[].id`	string (uuid)	ja	—
`items[].name`	string	ja	—
`items[].prefix`	string	ja	—
`items[].scope`	string	ja	einer von `read`, `read-write`
`items[].createdAt`	string (date-time)	ja	—
`items[].expiresAt`	string (date-time)	nein	darf null sein
`items[].lastUsedAt`	string (date-time)	nein	darf null sein
`items[].revoked`	boolean	ja	—

Antworten: 200, 400, 401, 403, 404, 409, 422, 503, 507

Beispiel

bash

curl -X GET "$ARKVORY_URL/api/v1/auth/tokens" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"

Persönliches Zugriffstoken erstellen

POST /api/v1/auth/tokens

Zugriff: Eine angemeldete Kontositzung (kein Schlüssel) · Wiederholung: Nicht automatisch wiederholen

Erstellt ein Token für Skripte und Tools, das als das angemeldete Konto handelt; das Geheimnis steht nur in dieser Antwort. name hat 1–64 Zeichen, expiresAt ist standardmäßig in 90 Tagen und muss in der Zukunft, aber höchstens 365 Tage entfernt liegen, und scope ist read-write (Standard) oder read, das nie etwas ändern kann. Token tragen nie Administratorrechte, können keine Token erstellen, und ein Konto hat höchstens 50 aktive (507 token_limit).

Anfragetext (application/json)

Feld	Typ	Erforderlich	Regeln
`name`	string	ja	—
`expiresAt`	string (date-time)	nein	—
`scope`	string	nein	einer von `read`, `read-write`

Antwort 201

Feld	Typ	Erforderlich	Regeln
`id`	string (uuid)	ja	—
`name`	string	ja	—
`prefix`	string	ja	—
`scope`	string	ja	einer von `read`, `read-write`
`createdAt`	string (date-time)	ja	—
`expiresAt`	string (date-time)	nein	darf null sein
`lastUsedAt`	string (date-time)	nein	darf null sein
`revoked`	boolean	ja	—
`token`	string	ja	—

Antworten: 201, 400, 401, 403, 404, 405, 409, 413, 415, 422, 503, 507

Beispiel

bash

curl -X POST "$ARKVORY_URL/api/v1/auth/tokens" \
  -H "Authorization: Bearer $ARKVORY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"<name>"}'

Eigenes persönliches Zugriffstoken widerrufen

DELETE /api/v1/auth/tokens/{id}

Zugriff: Eine angemeldete Kontositzung (kein Schlüssel) · Wiederholung: Wiederholen ist sicher: Dieselbe Anfrage hat dieselbe Wirkung

Widerruft ein persönliches Zugriffstoken des angemeldeten Kontos; Anfragen damit schlagen ab sofort fehl. Auch das Widerrufen eines bereits widerrufenen Tokens ist erfolgreich.

Parameter

Name	Ort	Typ	Erforderlich	Regeln
`id`	Pfad	string (uuid)	ja	—

Antworten: 204, 400, 401, 403, 404, 405, 409, 422, 503, 507

Beispiel

bash

curl -X DELETE "$ARKVORY_URL/api/v1/auth/tokens/$ID" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"

Abmelden

POST /api/v1/auth/logout

Zugriff: Jeder gültige Schlüssel oder jede gültige Sitzung · Wiederholung: Wiederholen ist sicher: Dieselbe Anfrage hat dieselbe Wirkung

Beendet die im Header Authorization gesendete Kontositzung; ihr Token funktioniert sofort nicht mehr. Mit anderen Anmeldedaten (einem persönlichen Token oder einem Dienstschlüssel) antwortet sie mit 204 und widerruft nichts.

Antworten: 204, 400, 401, 403, 404, 405, 409, 422, 503, 507

Beispiel

bash

curl -X POST "$ARKVORY_URL/api/v1/auth/logout" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"

Eigenes Passwort ändern

POST /api/v1/auth/password

Zugriff: Eine angemeldete Kontositzung (kein Schlüssel) · Wiederholung: Nicht automatisch wiederholen

Setzt newPassword (12–128 Zeichen), nachdem currentPassword geprüft wurde; ein falsches aktuelles Passwort ergibt 401 current_password_invalid und zählt für das Backoff bei der Anmeldung mit. Bei Erfolg werden alle Sitzungen und alle persönlichen Zugriffstoken des Kontos widerrufen, auch die aktuelle Sitzung; melden Sie sich daher erneut an.

Anfragetext (application/json)

Feld	Typ	Erforderlich	Regeln
`currentPassword`	string (password)	ja	—
`newPassword`	string (password)	ja	—

Antworten: 204, 400, 401, 403, 404, 405, 409, 413, 415, 422, 429, 503, 507

Beispiel

bash

curl -X POST "$ARKVORY_URL/api/v1/auth/password" \
  -H "Authorization: Bearer $ARKVORY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"currentPassword":"<currentPassword>","newPassword":"<newPassword>"}'

Aktuelle Identität abrufen

GET HEAD /api/v1/auth/me

Zugriff: Jeder gültige Schlüssel oder jede gültige Sitzung · Wiederholung: Wiederholen ist sicher (Lesen)

Liefert, wem die Anmeldedaten gehören: ihre id, ob es ein Administrator ist, die Art der Anmeldedaten (session, personal-token, service-key oder file-key), den Scope eines persönlichen Tokens und die Repositorys, auf die sie read- oder write-Zugriff haben. Verwenden Sie sie, um den angemeldeten Benutzer anzuzeigen und ein Repository zu wählen; für die genauen Berechtigungen eines verwalteten Dienstschlüssels verwenden Sie getOwnPermissions.

Antwort 200

Feld	Typ	Erforderlich	Regeln
`id`	string	ja	—
`administrator`	boolean	ja	—
`credential`	string	nein	einer von `session`, `personal-token`, `service-key`, `file-key`
`tokenScope`	string	nein	einer von `read`, `read-write`
`grants`	Array von object	ja	—
`grants[].repository`	string	ja	—
`grants[].permissions`	Array von string	ja	jedes Element: einer von `read`, `write`

Antworten: 200, 400, 401, 403, 404, 409, 422, 503, 507

Beispiel

bash

curl -X GET "$ARKVORY_URL/api/v1/auth/me" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"

Konten auflisten

GET HEAD /api/v1/users

Zugriff: Administrator · Wiederholung: Wiederholen ist sicher (Lesen)

Listet alle Benutzerkonten nach Namen geordnet auf, mit ID, Name, Administratorkennzeichen und der Angabe, ob sie aktiviert sind. Ein Server kann höchstens 1000 Konten haben.

Antwort 200

Feld	Typ	Erforderlich	Regeln
`items`	Array von object	nein	—
`items[].id`	string (uuid)	ja	—
`items[].name`	string	ja	—
`items[].administrator`	boolean	ja	—
`items[].enabled`	boolean	ja	—

Antworten: 200, 400, 401, 403, 404, 409, 422, 503, 507

Beispiel

bash

curl -X GET "$ARKVORY_URL/api/v1/users" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"

Konto erstellen

POST /api/v1/users

Zugriff: Administrator · Wiederholung: Nicht automatisch wiederholen

Erstellt ein Konto mit name (3–64 Buchstaben, Ziffern oder _.-), password (12–128 Zeichen) und administrator (Standard false) und antwortet mit 201 und dem Konto. Ein vergebener Name ergibt 409 already_exists; der Server kann höchstens 1000 Konten haben (507 account_limit).

Anfragetext (application/json)

Feld	Typ	Erforderlich	Regeln
`name`	string	ja	—
`password`	string (password)	ja	—
`administrator`	boolean	nein	—

Antwort 201

Feld	Typ	Erforderlich	Regeln
`id`	string (uuid)	ja	—
`name`	string	ja	—
`administrator`	boolean	ja	—
`enabled`	boolean	ja	—

Antworten: 201, 400, 401, 403, 404, 405, 409, 413, 415, 422, 503, 507

Beispiel

bash

curl -X POST "$ARKVORY_URL/api/v1/users" \
  -H "Authorization: Bearer $ARKVORY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"<name>","password":"<password>"}'

Konto aktivieren, deaktivieren oder Passwort zurücksetzen

PATCH /api/v1/users/{id}

Zugriff: Administrator · Wiederholung: Nicht automatisch wiederholen

Ändert enabled und/oder setzt ein neues password eines Kontos; das Administratorkennzeichen lässt sich hier nicht ändern. Das Deaktivieren beendet alle Sitzungen des Kontos, und seine persönlichen Token funktionieren nicht, solange es deaktiviert bleibt; ein Zurücksetzen des Passworts beendet alle Sitzungen und widerruft jedes persönliche Token.

Parameter

Name	Ort	Typ	Erforderlich	Regeln
`id`	Pfad	string (uuid)	ja	—

Anfragetext (application/json)

Feld	Typ	Erforderlich	Regeln
`enabled`	boolean	nein	—
`password`	string (password)	nein	—

Antwort 200

Feld	Typ	Erforderlich	Regeln
`id`	string (uuid)	ja	—
`name`	string	ja	—
`administrator`	boolean	ja	—
`enabled`	boolean	ja	—

Antworten: 200, 400, 401, 403, 404, 405, 409, 413, 415, 422, 503, 507

Beispiel

bash

curl -X PATCH "$ARKVORY_URL/api/v1/users/$ID" \
  -H "Authorization: Bearer $ARKVORY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{}'

Persönliche Zugriffstoken eines Kontos auflisten

GET HEAD /api/v1/users/{id}/tokens

Zugriff: Administrator · Wiederholung: Wiederholen ist sicher (Lesen)

Listet die persönlichen Zugriffstoken eines beliebigen Kontos auf, aktive zuerst, mit Name, Präfix, Scope, Erstellung, Ablauf, letzter Verwendung und Widerruf; nie die Geheimnisse. Verwenden Sie die Liste, um Automatisierung zu prüfen, bevor Sie das Konto deaktivieren oder zurücksetzen.

Parameter

Name	Ort	Typ	Erforderlich	Regeln
`id`	Pfad	string (uuid)	ja	—

Antwort 200

Feld	Typ	Erforderlich	Regeln
`items`	Array von object	ja	höchstens 100 Elemente
`items[].id`	string (uuid)	ja	—
`items[].name`	string	ja	—
`items[].prefix`	string	ja	—
`items[].scope`	string	ja	einer von `read`, `read-write`
`items[].createdAt`	string (date-time)	ja	—
`items[].expiresAt`	string (date-time)	nein	darf null sein
`items[].lastUsedAt`	string (date-time)	nein	darf null sein
`items[].revoked`	boolean	ja	—

Antworten: 200, 400, 401, 403, 404, 409, 422, 503, 507

Beispiel

bash

curl -X GET "$ARKVORY_URL/api/v1/users/$ID/tokens" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"

Persönliches Zugriffstoken eines Kontos widerrufen

DELETE /api/v1/users/{id}/tokens/{tokenId}

Zugriff: Administrator · Wiederholung: Wiederholen ist sicher: Dieselbe Anfrage hat dieselbe Wirkung

Widerruft ein persönliches Zugriffstoken des Kontos id; Anfragen damit schlagen ab sofort fehl, und das Ereignis wird im Sicherheits-Audit festgehalten. Auch das Widerrufen eines bereits widerrufenen Tokens ist erfolgreich.

Parameter

Name	Ort	Typ	Erforderlich	Regeln
`id`	Pfad	string (uuid)	ja	—
`tokenId`	Pfad	string (uuid)	ja	—

Antworten: 204, 400, 401, 403, 404, 405, 409, 422, 503, 507

Beispiel

bash

curl -X DELETE "$ARKVORY_URL/api/v1/users/$ID/tokens/$TOKENID" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"

Zugriffsgruppen auflisten

GET HEAD /api/v1/access-groups

Zugriff: Administrator · Wiederholung: Wiederholen ist sicher (Lesen)

Listet alle Zugriffsgruppen mit den Konto-IDs ihrer Mitglieder und ihren Repository-Zuweisungen (read oder write) auf. Ein Server kann höchstens 100 Gruppen sowie jeweils 10.000 Mitgliedschaften und Zuweisungen haben.

Antwort 200

Feld	Typ	Erforderlich	Regeln
`items`	Array von object	nein	—
`items[].id`	string (uuid)	ja	—
`items[].name`	string	ja	—
`items[].members`	Array von string (uuid)	ja	—
`items[].grants`	Array von object	ja	—
`items[].grants[].repository`	string	ja	—
`items[].grants[].access`	string	ja	einer von `read`, `write`

Antworten: 200, 400, 401, 403, 404, 409, 422, 503, 507

Beispiel

bash

curl -X GET "$ARKVORY_URL/api/v1/access-groups" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"

Zugriffsgruppe erstellen

POST /api/v1/access-groups

Zugriff: Administrator · Wiederholung: Nicht automatisch wiederholen

Erstellt eine leere Gruppe mit name (2–64 Buchstaben, Ziffern oder _.-) und antwortet mit 201 und der Gruppe; ein vergebener Name ergibt 409 already_exists. Fügen Sie Mitglieder mit addGroupMember und Repositorys mit setGroupGrant hinzu.

Anfragetext (application/json)

Feld	Typ	Erforderlich	Regeln
`name`	string	ja	—

Antwort 201

Feld	Typ	Erforderlich	Regeln
`id`	string (uuid)	ja	—
`name`	string	ja	—
`members`	Array von string (uuid)	ja	—
`grants`	Array von object	ja	—
`grants[].repository`	string	ja	—
`grants[].access`	string	ja	einer von `read`, `write`

Antworten: 201, 400, 401, 403, 404, 405, 409, 413, 415, 422, 503, 507

Beispiel

bash

curl -X POST "$ARKVORY_URL/api/v1/access-groups" \
  -H "Authorization: Bearer $ARKVORY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"name":"<name>"}'

Ein Konto zu einer Gruppe hinzufügen

PUT /api/v1/access-groups/{id}/members/{userId}

Zugriff: Administrator · Wiederholung: Wiederholen ist sicher: Dieselbe Anfrage hat dieselbe Wirkung

Macht das Konto userId zum Mitglied der Gruppe; es erhält den Repository-Zugriff der Gruppe mit seiner nächsten Anfrage. Ein bereits vorhandenes Mitglied erneut hinzuzufügen ändert nichts; insgesamt sind höchstens 10.000 Mitgliedschaften möglich (507 membership_limit).

Parameter

Name	Ort	Typ	Erforderlich	Regeln
`id`	Pfad	string (uuid)	ja	—
`userId`	Pfad	string (uuid)	ja	—

Antworten: 204, 400, 401, 403, 404, 405, 409, 422, 503, 507

Beispiel

bash

curl -X PUT "$ARKVORY_URL/api/v1/access-groups/$ID/members/$USERID" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"

Ein Konto aus einer Gruppe entfernen

DELETE /api/v1/access-groups/{id}/members/{userId}

Zugriff: Administrator · Wiederholung: Wiederholen ist sicher: Dieselbe Anfrage hat dieselbe Wirkung

Entfernt das Konto userId aus der Gruppe; der Zugriff, den es über die Gruppe hatte, endet mit seiner nächsten Anfrage. Auch das Entfernen eines Kontos, das kein Mitglied ist, ist erfolgreich.

Parameter

Name	Ort	Typ	Erforderlich	Regeln
`id`	Pfad	string (uuid)	ja	—
`userId`	Pfad	string (uuid)	ja	—

Antworten: 204, 400, 401, 403, 404, 405, 409, 422, 503, 507

Beispiel

bash

curl -X DELETE "$ARKVORY_URL/api/v1/access-groups/$ID/members/$USERID" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"

Einer Gruppe Zugriff auf ein Repository gewähren

PUT /api/v1/access-groups/{id}/grants/{repository}

Zugriff: Administrator · Wiederholung: Wiederholen ist sicher: Dieselbe Anfrage hat dieselbe Wirkung

Gibt den Mitgliedern der Gruppe access read oder write auf repository und ersetzt eine frühere Zuweisung der Gruppe dort; sie gilt ab ihrer nächsten Anfrage. Ein Repository muss nicht gesondert angelegt werden: Die Zuweisung macht es für sie sichtbar. Insgesamt sind höchstens 10.000 Zuweisungen möglich (507 grant_limit).

Parameter

Name	Ort	Typ	Erforderlich	Regeln
`id`	Pfad	string (uuid)	ja	—
`repository`	Pfad	string	ja	—

Anfragetext (application/json)

Feld	Typ	Erforderlich	Regeln
`access`	string	ja	einer von `read`, `write`

Antworten: 204, 400, 401, 403, 404, 405, 409, 413, 415, 422, 503, 507

Beispiel

bash

curl -X PUT "$ARKVORY_URL/api/v1/access-groups/$ID/grants/$REPOSITORY" \
  -H "Authorization: Bearer $ARKVORY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"access":"read"}'

Zugriff einer Gruppe auf ein Repository entziehen

DELETE /api/v1/access-groups/{id}/grants/{repository}

Zugriff: Administrator · Wiederholung: Wiederholen ist sicher: Dieselbe Anfrage hat dieselbe Wirkung

Entfernt die Zuweisung der Gruppe für repository; ihre Mitglieder behalten nur den Zugriff, den sie über andere Gruppen haben. Auch das Entfernen einer nicht vorhandenen Zuweisung ist erfolgreich.

Parameter

Name	Ort	Typ	Erforderlich	Regeln
`id`	Pfad	string (uuid)	ja	—
`repository`	Pfad	string	ja	—

Antworten: 204, 400, 401, 403, 404, 405, 409, 422, 503, 507

Beispiel

bash

curl -X DELETE "$ARKVORY_URL/api/v1/access-groups/$ID/grants/$REPOSITORY" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"

Sicherheits-Audit lesen

GET HEAD /api/v1/security/audit

Zugriff: Administrator · Wiederholung: Wiederholen ist sicher (Lesen)

Liefert das Journal, an das nur angehängt wird (append-only), mit Anmeldungen, Registrierungen sowie Änderungen an Konten, Gruppen, Zuweisungen, Passwörtern und persönlichen Token, neueste zuerst, jeweils mit Akteur, Art der Anmeldedaten, Ziel, Ergebnis und Client-Adresse; gedrosselte Versuche werden nicht protokolliert. Seiten enthalten limit Einträge (1–100, Standard 50); weiter mit after = next.

Parameter

Name	Ort	Typ	Erforderlich	Regeln
`after`	Query	string	nein	eine ganze Zahl in Dezimalziffern, als String gesendet
`limit`	Query	integer	nein	1–100

Antwort 200

Feld	Typ	Erforderlich	Regeln
`items`	Array von object	ja	höchstens 100 Elemente
`items[].id`	string	ja	eine ganze Zahl in Dezimalziffern, als String gesendet
`items[].occurredAt`	string (date-time)	ja	—
`items[].actor`	string	ja	darf null sein
`items[].credential`	string	ja	einer von `session`, `personal-token`, `service-key`, `file-key`; darf null sein
`items[].clientIp`	string	ja	darf null sein
`items[].action`	string	ja	—
`items[].target`	string	ja	darf null sein
`items[].outcome`	string	ja	einer von `success`, `failure`, `denied`
`items[].code`	string	ja	darf null sein
`items[].details`	object	ja	—
`next`	string	ja	darf null sein

Antworten: 200, 400, 401, 403, 404, 409, 422, 503, 507

Beispiel

bash

curl -X GET "$ARKVORY_URL/api/v1/security/audit" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"

Eigene wirksame Berechtigungen abrufen

GET HEAD /api/v1/auth/permissions

Zugriff: Jeder gültige Schlüssel oder jede gültige Sitzung · Wiederholung: Wiederholen ist sicher (Lesen)

Liefert das profile des Aufrufers (managed für einen verwalteten Dienstschlüssel, sonst legacy), seine Schlüssel-ID, seine wirksamen Bindungen (jedes Repository mit den dort genau erlaubten Aktionen) und ob er der Bootstrap-Dienstadministrator ist. Verwenden Sie die Operation, um einen Client anzupassen; der Server prüft weiterhin jede Anfrage, daher gilt eine Änderung der Berechtigungen sofort.

Antwort 200

Feld	Typ	Erforderlich	Regeln
`id`	string	ja	—
`profile`	string	ja	einer von `legacy`, `managed`
`bindings`	Array von object	ja	höchstens 10000 Elemente
`bindings[].resource`	object	ja	—
`bindings[].resource.kind`	string	ja	einer von `repository`
`bindings[].resource.id`	string	ja	entspricht `^[a-z0-9][a-z0-9_-]{0,63}$`
`bindings[].actions`	Array von string	ja	1–24 Elemente; keine wiederholten Elemente; jedes Element: einer von `repository.read`, `storage.read`, `storage.manage`, `diagnostics.read`, `artifact.read`, `artifact.list`, `artifact.delete`, `artifact.promote`, `content.read`, `upload.create`, `upload.read`, `upload.write`, `upload.complete`, `upload.cancel`, `job.read`, `package.read`, `package.publish`, `asset.read`, `asset.write`, `asset.restore`, `annotation.read`, `annotation.write`, `reference.write`, `audit.read`
`serviceAdministration`	boolean	ja	—
`credentialId`	string (uuid)	nein	darf null sein

Antworten: 200, 400, 401, 403, 404, 409, 422, 503, 507

Beispiel

bash

curl -X GET "$ARKVORY_URL/api/v1/auth/permissions" \
  -H "Authorization: Bearer $ARKVORY_TOKEN"

Konten und Anmeldung ​

Vorgänge ​

Anmelden ​

Konto registrieren ​

Anmeldeoptionen abrufen ​

Eigene persönliche Zugriffstoken auflisten ​

Persönliches Zugriffstoken erstellen ​

Eigenes persönliches Zugriffstoken widerrufen ​

Abmelden ​

Eigenes Passwort ändern ​

Aktuelle Identität abrufen ​

Konten auflisten ​

Konto erstellen ​

Konto aktivieren, deaktivieren oder Passwort zurücksetzen ​

Persönliche Zugriffstoken eines Kontos auflisten ​

Persönliches Zugriffstoken eines Kontos widerrufen ​

Zugriffsgruppen auflisten ​

Zugriffsgruppe erstellen ​

Ein Konto zu einer Gruppe hinzufügen ​

Ein Konto aus einer Gruppe entfernen ​

Einer Gruppe Zugriff auf ein Repository gewähren ​

Zugriff einer Gruppe auf ein Repository entziehen ​

Sicherheits-Audit lesen ​

Eigene wirksame Berechtigungen abrufen ​

Konten und Anmeldung

Vorgänge

Anmelden

Konto registrieren

Anmeldeoptionen abrufen

Eigene persönliche Zugriffstoken auflisten

Persönliches Zugriffstoken erstellen

Eigenes persönliches Zugriffstoken widerrufen

Abmelden

Eigenes Passwort ändern

Aktuelle Identität abrufen

Konten auflisten

Konto erstellen

Konto aktivieren, deaktivieren oder Passwort zurücksetzen

Persönliche Zugriffstoken eines Kontos auflisten

Persönliches Zugriffstoken eines Kontos widerrufen

Zugriffsgruppen auflisten

Zugriffsgruppe erstellen

Ein Konto zu einer Gruppe hinzufügen

Ein Konto aus einer Gruppe entfernen

Einer Gruppe Zugriff auf ein Repository gewähren

Zugriff einer Gruppe auf ein Repository entziehen

Sicherheits-Audit lesen

Eigene wirksame Berechtigungen abrufen