Claude Platform Docs

Organisation

Aktuelle Organisation abrufen
$ ant organization retrieve
GET/v1/organizations/me

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

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

Object type.

For Organizations, this is always "organization".

id: string

ID of the Organization.

formatuuid
name: string

Name of the Organization.

organization_role: "admin" or "billing" or "claude_code_user" or 6 more
"admin"
"billing"
"claude_code_user"
"developer"
"managed"
"membership_admin"
"owner"
"primary_owner"
"user"

OrganisationAPI-Keys

API-Keys auflisten
$ ant organization:api-keys list
GET/v1/organizations/api_keys
API-Key abrufen (Admin API)
$ ant organization:api-keys retrieve
GET/v1/organizations/api_keys/{api_key_id}

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

API-Key aktualisieren
$ ant organization:api-keys update
POST/v1/organizations/api_keys/{api_key_id}

OrganisationExterne Keys

Externen Key erstellen
$ ant organization:external-keys create
POST/v1/organizations/external_keys

Erstellt eine externe Key-Konfiguration, die der Organisation des Aufrufers gehört.

Externe Keys auflisten
$ ant organization:external-keys list
GET/v1/organizations/external_keys

Listet externe Key-Konfigurationen in der Organisation des Aufrufers auf.

Externen Key abrufen
$ ant organization:external-keys retrieve
GET/v1/organizations/external_keys/{external_key_id}

Ruft eine einzelne externe Key-Konfiguration in der Organisation des Aufrufers anhand der ID ab.

Externen Key aktualisieren
$ ant organization:external-keys update
POST/v1/organizations/external_keys/{external_key_id}

Aktualisiert eine externe Key-Konfiguration teilweise. Ausgelassene Felder bleiben unverändert.

Externen Key löschen
$ ant organization:external-keys delete
DELETE/v1/organizations/external_keys/{external_key_id}

Löscht eine externe Key-Konfiguration.

Externen Key validieren
$ ant organization:external-keys validate
POST/v1/organizations/external_keys/{external_key_id}/validate

Validiert eine externe Key-Konfiguration gegen das KMS des Kunden.

OrganisationFöderationIssuer

Federation-Issuer erstellen
$ ant organization:federation:issuers create
POST/v1/organizations/federation_issuers

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

Federation-Issuer auflisten
$ ant organization:federation:issuers list
GET/v1/organizations/federation_issuers

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

Federation-Issuer abrufen
$ ant organization:federation:issuers retrieve
GET/v1/organizations/federation_issuers/{federation_issuer_id}

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

Federation-Issuer aktualisieren
$ ant organization:federation:issuers update
POST/v1/organizations/federation_issuers/{federation_issuer_id}

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

Federation-Issuer archivieren
$ ant organization:federation:issuers archive
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

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

OrganisationFöderationRegeln

Federation-Regel erstellen
$ ant organization:federation:rules create
POST/v1/organizations/federation_rules

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

Federation-Regeln auflisten
$ ant organization:federation:rules list
GET/v1/organizations/federation_rules

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

Federation-Regel abrufen
$ ant organization:federation:rules retrieve
GET/v1/organizations/federation_rules/{federation_rule_id}

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

Federation-Regel aktualisieren
$ ant organization:federation:rules update
POST/v1/organizations/federation_rules/{federation_rule_id}

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

Federation-Regel archivieren
$ ant organization:federation:rules archive
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

Erfordert ein OAuth-Zugriffstoken mit dem Scope org:admin, über ant auth login --scope org:admin oder eine 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
$ ant organization:federation:rules:workspaces add
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

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

Workspaces einer Federation-Regel auflisten
$ ant organization:federation:rules:workspaces list
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

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

Workspace aus Federation-Regel entfernen
$ ant organization:federation:rules:workspaces remove
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

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

OrganisationEinladungen

Einladung erstellen
$ ant organization:invites create
POST/v1/organizations/invites

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

Einladungen auflisten
$ ant organization:invites list
GET/v1/organizations/invites

Listet die Einladungen der Organisation auf.

Einladung abrufen
$ ant organization:invites retrieve
GET/v1/organizations/invites/{invite_id}

Ruft eine Einladung anhand der ID ab.

Einladung löschen
$ ant organization:invites delete
DELETE/v1/organizations/invites/{invite_id}

Löscht eine ausstehende Einladung.

OrganisationService-Accounts

Service-Account erstellen
$ ant organization:service-accounts create
POST/v1/organizations/service_accounts

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

Service-Accounts auflisten
$ ant organization:service-accounts list
GET/v1/organizations/service_accounts

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

Service-Account abrufen
$ ant organization:service-accounts retrieve
GET/v1/organizations/service_accounts/{service_account_id}

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

Service-Account aktualisieren
$ ant organization:service-accounts update
POST/v1/organizations/service_accounts/{service_account_id}

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

Service-Account archivieren
$ ant organization:service-accounts archive
POST/v1/organizations/service_accounts/{service_account_id}/archive

Erfordert ein OAuth-Zugriffstoken mit dem Scope org:admin, über ant auth login --scope org:admin oder eine 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
$ ant organization:service-accounts:workspaces add
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

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

Workspaces eines Service-Accounts auflisten
$ ant organization:service-accounts:workspaces list
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

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

Workspace aus Service-Account entfernen
$ ant organization:service-accounts:workspaces remove
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

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

OrganisationBenutzer

Benutzer auflisten
$ ant organization:users list
GET/v1/organizations/users

Listet die Mitglieder der Organisation auf.

Benutzer abrufen
$ ant organization:users retrieve
GET/v1/organizations/users/{user_id}

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

Benutzer aktualisieren
$ ant organization:users update
POST/v1/organizations/users/{user_id}

Aktualisiert die Organisationsrolle eines Mitglieds.

Benutzer entfernen
$ ant organization:users remove
DELETE/v1/organizations/users/{user_id}

Entfernt ein Mitglied aus der Organisation.

OrganisationWorkspaces

Workspaces auflisten
$ ant organization:workspaces list
GET/v1/organizations/workspaces
Workspace erstellen
$ ant organization:workspaces create
POST/v1/organizations/workspaces
Workspace abrufen
$ ant organization:workspaces retrieve
GET/v1/organizations/workspaces/{workspace_id}
Workspace aktualisieren
$ ant organization:workspaces update
POST/v1/organizations/workspaces/{workspace_id}
Workspace archivieren
$ ant organization:workspaces archive
POST/v1/organizations/workspaces/{workspace_id}/archive

OrganisationWorkspacesRatenlimits

Workspace-Ratenlimits auflisten
$ ant organization:workspaces:rate-limits list
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

Listet die Ratenlimits eines Workspace auf.

OrganisationWorkspacesMitglieder

Workspace-Mitglieder auflisten
$ ant organization:workspaces:members list
GET/v1/organizations/workspaces/{workspace_id}/members
Workspace-Mitglied erstellen
$ ant organization:workspaces:members add
POST/v1/organizations/workspaces/{workspace_id}/members
Workspace-Mitglied abrufen
$ ant organization:workspaces:members retrieve
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Workspace-Mitglied aktualisieren
$ ant organization:workspaces:members update
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Workspace-Mitglied löschen
$ ant organization:workspaces:members remove
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

OrganisationWorkspacesService-Accounts

Service-Account-Mitglieder eines Workspace auflisten
$ ant organization:workspaces:service-accounts list
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

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

Service-Account-Mitglied eines Workspace erstellen
$ ant organization:workspaces:service-accounts add
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

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

Service-Account-Mitglied eines Workspace abrufen
$ ant organization:workspaces:service-accounts retrieve
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

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

Service-Account-Mitglied eines Workspace aktualisieren
$ ant organization:workspaces:service-accounts update
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

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

Service-Account-Mitglied eines Workspace löschen
$ ant organization:workspaces:service-accounts remove
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

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

OrganisationRatenlimits

Ratenlimits der Organisation auflisten
$ ant organization:rate-limits list
GET/v1/organizations/rate_limits

Listet die Ratenlimits der Messages API für deine Organisation auf.

OrganisationCompliance-Einstellungen

Compliance-Einstellungen abrufen
$ ant organization:compliance-settings retrieve
GET/v1/organizations/compliance_settings

Ruft die Compliance Settings deiner Organisation ab.

Compliance-Einstellungen aktualisieren
$ ant organization:compliance-settings update
POST/v1/organizations/compliance_settings

Aktualisiert die Compliance Settings deiner Organisation.