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 routes for organizations, members, invitations, API-key management, and audit events. API keys cannot call these admin routes.
Endpunkte
Die generierte OpenAPI-Komponente unten enthält Request-Parameter, Request Bodies, Response Bodies, Statuscodes und Schemas für dieses Tag.
Endpoint-Zusammenfassung für den schnellen Überblick vor der generierten Referenz:
Fehler nutzen die PublicErrorEnvelope-Form mit einem X-Request-Id-Header. Die meisten Endpoints unten liefern 400, 401, 403, 404, 409, 422, 429; die wenigen Abweichungen listen ihre eigenen Statuscodes in der Tabelle, die sonst nur Erfolgs-Responses zeigt. Siehe API-Fehler für Envelope und Recovery-Muster.
| Methode | Pfad | Zusammenfassung | Request Body | Erfolgs-Response |
|---|---|---|---|---|
POST | /v1/invitations/{invitation_token}/accept | Accept Organization Invitation | Keine. | 200 application/json: OrganizationMemberResponse |
GET | /v1/me | Get Me | Keine. | 200 application/json: MeResponse |
PATCH | /v1/me | Update Me Profile | application/json: UserProfileUpdateRequest | 200 application/json: HumanUserResponse |
GET | /v1/organizations | List Organizations | Keine. | 200 application/json: Page_OrganizationResponse_ |
POST | /v1/organizations | Create Organization | application/json: OrganizationCreateRequest | 201 application/json: OrganizationResponse |
GET | /v1/organizations/{organization_id} | Get Organization | Keine. | 200 application/json: OrganizationResponse |
PATCH | /v1/organizations/{organization_id} | Update Organization | application/json: OrganizationUpdateRequest | 200 application/json: OrganizationResponse |
GET | /v1/organizations/{organization_id}/api-keys | List Organization Api Keys | Keine. | 200 application/json: Page_ApiKeyResponse_ |
POST | /v1/organizations/{organization_id}/api-keys | Create Organization Api Key | application/json: ApiKeyCreateRequest | 201 application/json: CreatedApiKeyResponse or ApiKeyResponse |
GET | /v1/organizations/{organization_id}/api-keys/{api_key_id} | Get Organization Api Key | Keine. | 200 application/json: ApiKeyResponse |
POST | /v1/organizations/{organization_id}/api-keys/{api_key_id}/revoke | Revoke Organization Api Key | Keine. | 200 application/json: ApiKeyResponse |
POST | /v1/organizations/{organization_id}/api-keys/{api_key_id}/rotate | Rotate Organization Api Key | application/json: ApiKeyRotateRequest or null | 200 application/json: CreatedApiKeyResponse |
GET | /v1/organizations/{organization_id}/audit-events | List Organization Audit Events | Keine. | 200 application/json: Page_AuditEventResponse_ |
GET | /v1/organizations/{organization_id}/audit-events/{audit_event_id} | Get Organization Audit Event | Keine. | 200 application/json: AuditEventResponse |
GET | /v1/organizations/{organization_id}/invitations | List Organization Invitations | Keine. | 200 application/json: Page_OrganizationInvitationResponse_ |
POST | /v1/organizations/{organization_id}/invitations | Create Organization Invitation | application/json: OrganizationInvitationCreateRequest | 201 application/json: CreatedOrganizationInvitationResponse or OrganizationInvitationResponse |
POST | /v1/organizations/{organization_id}/invitations/{invitation_id}/revoke | Revoke Organization Invitation | Keine. | 200 application/json: OrganizationInvitationResponse |
GET | /v1/organizations/{organization_id}/members | List Organization Members | Keine. | 200 application/json: Page_OrganizationMemberResponse_ |
GET | /v1/organizations/{organization_id}/members/{user_id} | Get Organization Member | Keine. | 200 application/json: OrganizationMemberResponse |
PATCH | /v1/organizations/{organization_id}/members/{user_id} | Update Organization Member | application/json: OrganizationMemberUpdateRequest | 200 application/json: OrganizationMemberResponse |
DELETE | /v1/organizations/{organization_id}/members/{user_id} | Remove Organization Member | Keine. | 200 application/json: OrganizationMemberResponse |
API-Referenz wird geladen...