APIReferenz
Organization Admin API
Generierte OpenAPI-Referenz für die Organization Admin-API-Oberfläche.
Überblick
Organization Admin-Endpoints gehören zur öffentlichen Everyn-API. Browser-Admin-Endpunkte für Organisationen, Mitglieder, Einladungen, API-Schlüsselverwaltung und Audit-Ereignisse. API-Schlüssel können diese Admin-Endpunkte nicht aufrufen.
Endpunkte
Die generierte OpenAPI-Komponente unten enthält Request-Parameter, Request Bodies, Response Bodies, Statuscodes und Schemas für dieses Tag. Die statische Zusammenfassung hält Zweck, Authentifizierung, Schemanamen und Hinweise zur API-Fehlerbehandlung verfügbar, bevor die interaktive Referenz geladen ist.
Die Details unten sind statisches HTML aus demselben OpenAPI-Schema und bleiben ohne clientseitiges JavaScript lesbar. Die interaktive Komponente danach ergänzt ausklappbare Beispiele und Schema-Browsing.
Endpoint-Zusammenfassung für den schnellen Überblick vor der generierten Referenz:
| Methode | Pfad | Zweck | Authentifizierung | Request Body / Schema | Erfolgs-Response / Schema | Fehler |
|---|---|---|---|---|---|---|
POST | /v1/invitations/{invitation_token}/accept | Organisationseinladung annehmen | Bearer-Token (BearerAuth) | Keine. | 200 application/json: OrganizationMemberResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/me | Eigenes Profil abrufen | Bearer-Token (BearerAuth) | Keine. | 200 application/json: MeResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
PATCH | /v1/me | Eigenes Profil aktualisieren | Bearer-Token (BearerAuth) | application/json: UserProfileUpdateRequest | 200 application/json: HumanUserResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/organizations | Organisationen auflisten | Bearer-Token (BearerAuth) | Keine. | 200 application/json: Page_OrganizationResponse_ | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/organizations | Organisation erstellen | Bearer-Token (BearerAuth) | application/json: OrganizationCreateRequest | 201 application/json: OrganizationResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/organizations/{organization_id} | Organisation abrufen | Bearer-Token (BearerAuth) | Keine. | 200 application/json: OrganizationResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
PATCH | /v1/organizations/{organization_id} | Organisation aktualisieren | Bearer-Token (BearerAuth) | application/json: OrganizationUpdateRequest | 200 application/json: OrganizationResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/organizations/{organization_id}/api-keys | API-Schlüssel der Organisation auflisten | Bearer-Token (BearerAuth) | Keine. | 200 application/json: Page_ApiKeyResponse_ | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/organizations/{organization_id}/api-keys | API-Schlüssel der Organisation erstellen | Bearer-Token (BearerAuth) | application/json: ApiKeyCreateRequest | 201 application/json: CreatedApiKeyResponse oder ApiKeyResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/organizations/{organization_id}/api-keys/{api_key_id} | API-Schlüssel der Organisation abrufen | Bearer-Token (BearerAuth) | Keine. | 200 application/json: ApiKeyResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/organizations/{organization_id}/api-keys/{api_key_id}/revoke | API-Schlüssel der Organisation widerrufen | Bearer-Token (BearerAuth) | Keine. | 200 application/json: ApiKeyResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/organizations/{organization_id}/api-keys/{api_key_id}/rotate | API-Schlüssel der Organisation rotieren | Bearer-Token (BearerAuth) | application/json: ApiKeyRotateRequest oder null | 200 application/json: CreatedApiKeyResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/organizations/{organization_id}/audit-events | Audit-Ereignisse der Organisation auflisten | Bearer-Token (BearerAuth) | Keine. | 200 application/json: Page_AuditEventResponse_ | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/organizations/{organization_id}/audit-events/{audit_event_id} | Audit-Ereignis der Organisation abrufen | Bearer-Token (BearerAuth) | Keine. | 200 application/json: AuditEventResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/organizations/{organization_id}/invitations | Einladungen der Organisation auflisten | Bearer-Token (BearerAuth) | Keine. | 200 application/json: Page_OrganizationInvitationResponse_ | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/organizations/{organization_id}/invitations | Einladung der Organisation erstellen | Bearer-Token (BearerAuth) | application/json: OrganizationInvitationCreateRequest | 201 application/json: CreatedOrganizationInvitationResponse oder OrganizationInvitationResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
POST | /v1/organizations/{organization_id}/invitations/{invitation_id}/revoke | Einladung der Organisation widerrufen | Bearer-Token (BearerAuth) | Keine. | 200 application/json: OrganizationInvitationResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/organizations/{organization_id}/members | Mitglieder der Organisation auflisten | Bearer-Token (BearerAuth) | Keine. | 200 application/json: Page_OrganizationMemberResponse_ | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
GET | /v1/organizations/{organization_id}/members/{user_id} | Mitglied der Organisation abrufen | Bearer-Token (BearerAuth) | Keine. | 200 application/json: OrganizationMemberResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
PATCH | /v1/organizations/{organization_id}/members/{user_id} | Mitglied der Organisation aktualisieren | Bearer-Token (BearerAuth) | application/json: OrganizationMemberUpdateRequest | 200 application/json: OrganizationMemberResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
DELETE | /v1/organizations/{organization_id}/members/{user_id} | Mitglied aus der Organisation entfernen | Bearer-Token (BearerAuth) | Keine. | 200 application/json: OrganizationMemberResponse | API-Fehler: 400, 401, 403, 404, 409, 422, 429 |
API-Referenz wird geladen...