Claude Platform Docs

Organisation

Aktuelle Organisation abrufen
OrganizationInfo organization().retrieve(params = OrganizationRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/me

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

Models
class OrganizationInfo { type = "organization"; id; name; }
JsonValue type = "organization"

Object type.

For Organizations, this is always "organization".

String id

ID of the Organization.

formatuuid
String name

Name of the Organization.

enum OrganizationRole
ADMIN("admin")
BILLING("billing")
CLAUDE_CODE_USER("claude_code_user")
DEVELOPER("developer")
MANAGED("managed")
MEMBERSHIP_ADMIN("membership_admin")
OWNER("owner")
PRIMARY_OWNER("primary_owner")
USER("user")

OrganisationAPI-Keys

API-Keys auflisten
ApiKeyListPage organization().apiKeys().list(params = ApiKeyListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/api_keys
API-Key abrufen (Admin API)
ApiKey organization().apiKeys().retrieve(params = ApiKeyRetrieveParams.none(), requestOptions = RequestOptions.none())
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
ApiKey organization().apiKeys().update(params = ApiKeyUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/api_keys/{api_key_id}

OrganisationExterne Keys

Externen Key erstellen
ExternalKey organization().externalKeys().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/external_keys

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

Externe Keys auflisten
ExternalKeyListPage organization().externalKeys().list(params = ExternalKeyListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/external_keys

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

Externen Key abrufen
ExternalKey organization().externalKeys().retrieve(params = ExternalKeyRetrieveParams.none(), requestOptions = RequestOptions.none())
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
ExternalKey organization().externalKeys().update(params = ExternalKeyUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/external_keys/{external_key_id}

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

Externen Key löschen
ExternalKeyDeleteResponse organization().externalKeys().delete(params = ExternalKeyDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/external_keys/{external_key_id}

Löscht eine externe Key-Konfiguration.

Externen Key validieren
ExternalKeyValidateResponse organization().externalKeys().validate(params = ExternalKeyValidateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/external_keys/{external_key_id}/validate

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

OrganisationFöderationIssuer

Federation-Issuer erstellen
FederationIssuer organization().federation().issuers().create(params, requestOptions = RequestOptions.none())
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
IssuerListPage organization().federation().issuers().list(params = IssuerListParams.none(), requestOptions = RequestOptions.none())
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
FederationIssuer organization().federation().issuers().retrieve(params = IssuerRetrieveParams.none(), requestOptions = RequestOptions.none())
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
FederationIssuer organization().federation().issuers().update(params = IssuerUpdateParams.none(), requestOptions = RequestOptions.none())
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
FederationIssuer organization().federation().issuers().archive(params = IssuerArchiveParams.none(), requestOptions = RequestOptions.none())
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
FederationRule organization().federation().rules().create(params, requestOptions = RequestOptions.none())
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
RuleListPage organization().federation().rules().list(params = RuleListParams.none(), requestOptions = RequestOptions.none())
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
FederationRule organization().federation().rules().retrieve(params = RuleRetrieveParams.none(), requestOptions = RequestOptions.none())
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
FederationRule organization().federation().rules().update(params = RuleUpdateParams.none(), requestOptions = RequestOptions.none())
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
FederationRule organization().federation().rules().archive(params = RuleArchiveParams.none(), requestOptions = RequestOptions.none())
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
FederationRuleWorkspace organization().federation().rules().workspaces().add(params, requestOptions = RequestOptions.none())
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
WorkspaceListPage organization().federation().rules().workspaces().list(params = WorkspaceListParams.none(), requestOptions = RequestOptions.none())
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
WorkspaceRemoveResponse organization().federation().rules().workspaces().remove(params, requestOptions = RequestOptions.none())
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
OrganizationInvite organization().invites().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/invites

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

Einladungen auflisten
InviteListPage organization().invites().list(params = InviteListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/invites

Listet die Einladungen der Organisation auf.

Einladung abrufen
OrganizationInvite organization().invites().retrieve(params = InviteRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/invites/{invite_id}

Ruft eine Einladung anhand der ID ab.

Einladung löschen
InviteDeleteResponse organization().invites().delete(params = InviteDeleteParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/invites/{invite_id}

Löscht eine ausstehende Einladung.

OrganisationService-Accounts

Service-Account erstellen
ServiceAccount organization().serviceAccounts().create(params, requestOptions = RequestOptions.none())
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
ServiceAccountListPage organization().serviceAccounts().list(params = ServiceAccountListParams.none(), requestOptions = RequestOptions.none())
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
ServiceAccount organization().serviceAccounts().retrieve(params = ServiceAccountRetrieveParams.none(), requestOptions = RequestOptions.none())
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
ServiceAccount organization().serviceAccounts().update(params = ServiceAccountUpdateParams.none(), requestOptions = RequestOptions.none())
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
ServiceAccount organization().serviceAccounts().archive(params = ServiceAccountArchiveParams.none(), requestOptions = RequestOptions.none())
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
ServiceAccountWorkspaceMember organization().serviceAccounts().workspaces().add(params, requestOptions = RequestOptions.none())
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
WorkspaceListPage organization().serviceAccounts().workspaces().list(params = WorkspaceListParams.none(), requestOptions = RequestOptions.none())
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
WorkspaceRemoveResponse organization().serviceAccounts().workspaces().remove(params, requestOptions = RequestOptions.none())
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
UserListPage organization().users().list(params = UserListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/users

Listet die Mitglieder der Organisation auf.

Benutzer abrufen
OrganizationUser organization().users().retrieve(params = UserRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/users/{user_id}

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

Benutzer aktualisieren
OrganizationUser organization().users().update(params, requestOptions = RequestOptions.none())
POST/v1/organizations/users/{user_id}

Aktualisiert die Organisationsrolle eines Mitglieds.

Benutzer entfernen
UserRemoveResponse organization().users().remove(params = UserRemoveParams.none(), requestOptions = RequestOptions.none())
DELETE/v1/organizations/users/{user_id}

Entfernt ein Mitglied aus der Organisation.

OrganisationWorkspaces

Workspaces auflisten
WorkspaceListPage organization().workspaces().list(params = WorkspaceListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces
Workspace erstellen
Workspace organization().workspaces().create(params, requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces
Workspace abrufen
Workspace organization().workspaces().retrieve(params = WorkspaceRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}
Workspace aktualisieren
Workspace organization().workspaces().update(params = WorkspaceUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}
Workspace archivieren
Workspace organization().workspaces().archive(params = WorkspaceArchiveParams.none(), requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/archive

OrganisationWorkspacesRatenlimits

Workspace-Ratenlimits auflisten
RateLimitListPage organization().workspaces().rateLimits().list(params = RateLimitListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

Listet die Ratenlimits eines Workspace auf.

OrganisationWorkspacesMitglieder

Workspace-Mitglieder auflisten
MemberListPage organization().workspaces().members().list(params = MemberListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/members
Workspace-Mitglied erstellen
WorkspaceMember organization().workspaces().members().add(params, requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/members
Workspace-Mitglied abrufen
WorkspaceMember organization().workspaces().members().retrieve(params, requestOptions = RequestOptions.none())
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Workspace-Mitglied aktualisieren
WorkspaceMember organization().workspaces().members().update(params, requestOptions = RequestOptions.none())
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Workspace-Mitglied löschen
MemberRemoveResponse organization().workspaces().members().remove(params, requestOptions = RequestOptions.none())
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

OrganisationWorkspacesService-Accounts

Service-Account-Mitglieder eines Workspace auflisten
ServiceAccountListPage organization().workspaces().serviceAccounts().list(params = ServiceAccountListParams.none(), requestOptions = RequestOptions.none())
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
ServiceAccountWorkspaceMember organization().workspaces().serviceAccounts().add(params, requestOptions = RequestOptions.none())
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
ServiceAccountWorkspaceMember organization().workspaces().serviceAccounts().retrieve(params, requestOptions = RequestOptions.none())
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
ServiceAccountWorkspaceMember organization().workspaces().serviceAccounts().update(params, requestOptions = RequestOptions.none())
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
ServiceAccountRemoveResponse organization().workspaces().serviceAccounts().remove(params, requestOptions = RequestOptions.none())
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
RateLimitListPage organization().rateLimits().list(params = RateLimitListParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/rate_limits

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

OrganisationCompliance-Einstellungen

Compliance-Einstellungen abrufen
OrganizationComplianceSettings organization().complianceSettings().retrieve(params = ComplianceSettingRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/organizations/compliance_settings

Ruft die Compliance Settings deiner Organisation ab.

Compliance-Einstellungen aktualisieren
OrganizationComplianceSettings organization().complianceSettings().update(params, requestOptions = RequestOptions.none())
POST/v1/organizations/compliance_settings

Aktualisiert die Compliance Settings deiner Organisation.