Claude Platform Docs

Organisation

Aktuelle Organisation abrufen
GET/v1/organizations/me

Ruft Informationen über die Organisation ab, die mit dem authentifizierten API-Key verknüpft ist.

Models
OrganizationInfo object{ type: "organization", id, name }
type: "organization"

Object type.

For Organizations, this is always "organization".

defaultorganization
id: string

ID of the Organization.

formatuuid
name: string

Name of the Organization.

OrganizationRole = "admin" or "billing" or "claude_code_user" or 6 more
One of the following:
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"

OrganisationAPI-Keys

API-Keys auflisten
GET/v1/organizations/api_keys
API-Key abrufen (Admin API)
GET/v1/organizations/api_keys/{api_key_id}

Ruft Informationen über einen einzelnen API-Key in deiner Organisation ab, nachgeschlagen anhand seiner ID. Dieser Admin-API-Endpunkt erfordert einen Admin-API-Key, ist für die programmatische Schlüsselverwaltung gedacht und gibt niemals den geheimen Wert des Keys zurück. Um deine eigenen API-Keys anzuzeigen oder zu erstellen, gehe zu API-Keys in der Claude Console.

API-Key aktualisieren
POST/v1/organizations/api_keys/{api_key_id}

OrganisationExterne Schlüssel

Externen Schlüssel erstellen
POST/v1/organizations/external_keys

Erstellt eine externe Schlüsselkonfiguration, die der Organisation des Aufrufers gehört.

Externe Schlüssel auflisten
GET/v1/organizations/external_keys

Listet externe Schlüsselkonfigurationen in der Organisation des Aufrufers auf.

Externen Schlüssel abrufen
GET/v1/organizations/external_keys/{external_key_id}

Ruft eine einzelne externe Schlüsselkonfiguration in der Organisation des Aufrufers anhand ihrer ID ab.

Externen Schlüssel aktualisieren
POST/v1/organizations/external_keys/{external_key_id}

Aktualisiert eine externe Schlüsselkonfiguration teilweise. Ausgelassene Felder bleiben unverändert.

Externen Schlüssel löschen
DELETE/v1/organizations/external_keys/{external_key_id}

Löscht eine externe Schlüsselkonfiguration.

Externen Schlüssel validieren
POST/v1/organizations/external_keys/{external_key_id}/validate

Validiert eine externe Schlüsselkonfiguration gegen das KMS des Kunden.

OrganisationFöderationIssuer

Federation-Issuer erstellen
POST/v1/organizations/federation_issuers

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Federation-Issuer auflisten
GET/v1/organizations/federation_issuers

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Federation-Issuer abrufen
GET/v1/organizations/federation_issuers/{federation_issuer_id}

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Federation-Issuer aktualisieren
POST/v1/organizations/federation_issuers/{federation_issuer_id}

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Federation-Issuer archivieren
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

OrganisationFöderationRegeln

Federation-Regel erstellen
POST/v1/organizations/federation_rules

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Federation-Regeln auflisten
GET/v1/organizations/federation_rules

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Federation-Regel abrufen
GET/v1/organizations/federation_rules/{federation_rule_id}

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Federation-Regel aktualisieren
POST/v1/organizations/federation_rules/{federation_rule_id}

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Federation-Regel archivieren
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

OrganisationFöderationRegelnWorkspaces

Workspace zu Federation-Regel hinzufügen
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Workspaces einer Federation-Regel auflisten
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Workspace aus Federation-Regel entfernen
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

OrganisationEinladungen

Einladung erstellen
POST/v1/organizations/invites

Lädt einen Benutzer per E-Mail ein, der Organisation beizutreten.

Einladungen auflisten
GET/v1/organizations/invites

Listet die Einladungen der Organisation auf.

Einladung abrufen
GET/v1/organizations/invites/{invite_id}

Ruft eine Einladung anhand ihrer ID ab.

Einladung löschen
DELETE/v1/organizations/invites/{invite_id}

Löscht eine ausstehende Einladung.

OrganisationService-Accounts

Service-Account erstellen
POST/v1/organizations/service_accounts

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Service-Accounts auflisten
GET/v1/organizations/service_accounts

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Service-Account abrufen
GET/v1/organizations/service_accounts/{service_account_id}

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Service-Account aktualisieren
POST/v1/organizations/service_accounts/{service_account_id}

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Service-Account archivieren
POST/v1/organizations/service_accounts/{service_account_id}/archive

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

OrganisationService-AccountsWorkspaces

Workspace zu Service-Account hinzufügen
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Workspaces für Service-Account auflisten
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Workspace aus Service-Account entfernen
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

OrganisationBenutzer

Benutzer auflisten
GET/v1/organizations/users

Listet die Mitglieder der Organisation auf.

Benutzer abrufen
GET/v1/organizations/users/{user_id}

Ruft ein Mitglied der Organisation anhand der Benutzer-ID ab.

Benutzer aktualisieren
POST/v1/organizations/users/{user_id}

Aktualisiert die Organisationsrolle eines Mitglieds.

Benutzer entfernen
DELETE/v1/organizations/users/{user_id}

Entfernt ein Mitglied aus der Organisation.

OrganisationWorkspaces

Workspaces auflisten
GET/v1/organizations/workspaces
Workspace erstellen
POST/v1/organizations/workspaces
Workspace abrufen
GET/v1/organizations/workspaces/{workspace_id}
Workspace aktualisieren
POST/v1/organizations/workspaces/{workspace_id}
Workspace archivieren
POST/v1/organizations/workspaces/{workspace_id}/archive

OrganisationWorkspacesRatenlimits

Workspace-Ratenlimits auflisten
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

Listet die Ratenlimits eines Workspace auf.

OrganisationWorkspacesMitglieder

Workspace-Mitglieder auflisten
GET/v1/organizations/workspaces/{workspace_id}/members
Workspace-Mitglied erstellen
POST/v1/organizations/workspaces/{workspace_id}/members
Workspace-Mitglied abrufen
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Workspace-Mitglied aktualisieren
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Workspace-Mitglied löschen
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

OrganisationWorkspacesService-Accounts

Service-Accounts als Workspace-Mitglieder auflisten
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

Erfordert ein OAuth-Access-Token mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Service-Account als Workspace-Mitglied erstellen
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

Erfordert ein OAuth-Zugriffstoken mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Service-Account als Workspace-Mitglied abrufen
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Erfordert ein OAuth-Zugriffstoken mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Service-Account als Workspace-Mitglied aktualisieren
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Erfordert ein OAuth-Zugriffstoken mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

Service-Account als Workspace-Mitglied löschen
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Erfordert ein OAuth-Zugriffstoken mit dem Scope org:admin, aus ant auth login --scope org:admin oder einer Workload-Identity-Federation-Regel; Admin-API-Keys werden nicht akzeptiert. Siehe WIF mit der Admin API verwalten.

OrganisationRatenlimits

Ratenlimits der Organisation auflisten
GET/v1/organizations/rate_limits

Liste die Messages-API-Ratenlimits (rate limits) für deine Organisation auf.

Compliance-Einstellungen abrufen
GET/v1/organizations/compliance_settings

Rufe die Compliance-Einstellungen deiner Organisation ab.

Compliance-Einstellungen aktualisieren
POST/v1/organizations/compliance_settings

Aktualisiere die Compliance-Einstellungen deiner Organisation.