Claude Platform Docs

Organisation

Obtenir l'organisation actuelle
OrganizationInfo Organization.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/me

Récupérez les informations sur l'organisation associée à la clé API authentifiée.

Models
class OrganizationInfo { Type = "organization"; ID; Name; }
JsonElement Type = "organization"

Object type.

For Organizations, this is always "organization".

required string ID

ID of the Organization.

formatuuid
required string Name

Name of the Organization.

enum OrganizationRole
Admin("admin")
Billing("billing")
ClaudeCodeUser("claude_code_user")
Developer("developer")
Managed("managed")
MembershipAdmin("membership_admin")
Owner("owner")
PrimaryOwner("primary_owner")
User("user")

OrganisationClés API

Lister les clés API
ApiKeyListPage Organization.ApiKeys.List(parameters, cancellationToken = default)
GET/v1/organizations/api_keys
Récupérer une clé API (Admin API)
ApiKey Organization.ApiKeys.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/api_keys/{api_key_id}

Récupérez les informations sur une clé API unique de votre organisation, recherchée par son ID. Ce point de terminaison de l'Admin API nécessite une clé Admin API, est destiné à la gestion programmatique des clés et ne renvoie jamais la valeur secrète de la clé. Pour afficher ou créer vos propres clés API, accédez à Clés API dans la Claude Console.

Mettre à jour une clé API
ApiKey Organization.ApiKeys.Update(parameters, cancellationToken = default)
POST/v1/organizations/api_keys/{api_key_id}

OrganisationClés externes

Créer une clé externe
ExternalKey Organization.ExternalKeys.Create(parameters, cancellationToken = default)
POST/v1/organizations/external_keys

Créez une configuration de clé externe appartenant à l'organisation de l'appelant.

Lister les clés externes
ExternalKeyListPage Organization.ExternalKeys.List(parameters, cancellationToken = default)
GET/v1/organizations/external_keys

Listez les configurations de clés externes de l'organisation de l'appelant.

Obtenir une clé externe
ExternalKey Organization.ExternalKeys.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/external_keys/{external_key_id}

Récupérez une configuration de clé externe unique de l'organisation de l'appelant par son ID.

Mettre à jour une clé externe
ExternalKey Organization.ExternalKeys.Update(parameters, cancellationToken = default)
POST/v1/organizations/external_keys/{external_key_id}

Mettez à jour partiellement une configuration de clé externe. Les champs omis restent inchangés.

Supprimer une clé externe
ExternalKeyDeleteResponse Organization.ExternalKeys.Delete(parameters, cancellationToken = default)
DELETE/v1/organizations/external_keys/{external_key_id}

Supprimez une configuration de clé externe.

Valider une clé externe
ExternalKeyValidateResponse Organization.ExternalKeys.Validate(parameters, cancellationToken = default)
POST/v1/organizations/external_keys/{external_key_id}/validate

Validez une configuration de clé externe auprès du KMS du client.

OrganisationFédérationÉmetteurs

Créer un émetteur de fédération
FederationIssuer Organization.Federation.Issuers.Create(parameters, cancellationToken = default)
POST/v1/organizations/federation_issuers

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Lister les émetteurs de fédération
IssuerListPage Organization.Federation.Issuers.List(parameters, cancellationToken = default)
GET/v1/organizations/federation_issuers

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Obtenir un émetteur de fédération
FederationIssuer Organization.Federation.Issuers.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/federation_issuers/{federation_issuer_id}

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Mettre à jour un émetteur de fédération
FederationIssuer Organization.Federation.Issuers.Update(parameters, cancellationToken = default)
POST/v1/organizations/federation_issuers/{federation_issuer_id}

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Archiver un émetteur de fédération
FederationIssuer Organization.Federation.Issuers.Archive(parameters, cancellationToken = default)
POST/v1/organizations/federation_issuers/{federation_issuer_id}/archive

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

OrganisationFédérationRègles

Créer une règle de fédération
FederationRule Organization.Federation.Rules.Create(parameters, cancellationToken = default)
POST/v1/organizations/federation_rules

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Lister les règles de fédération
RuleListPage Organization.Federation.Rules.List(parameters, cancellationToken = default)
GET/v1/organizations/federation_rules

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Obtenir une règle de fédération
FederationRule Organization.Federation.Rules.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/federation_rules/{federation_rule_id}

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Mettre à jour une règle de fédération
FederationRule Organization.Federation.Rules.Update(parameters, cancellationToken = default)
POST/v1/organizations/federation_rules/{federation_rule_id}

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Archiver une règle de fédération
FederationRule Organization.Federation.Rules.Archive(parameters, cancellationToken = default)
POST/v1/organizations/federation_rules/{federation_rule_id}/archive

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

OrganisationFédérationRèglesEspaces de travail

Ajouter un espace de travail à une règle de fédération
FederationRuleWorkspace Organization.Federation.Rules.Workspaces.Add(parameters, cancellationToken = default)
POST/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Lister les espaces de travail d'une règle de fédération
WorkspaceListPage Organization.Federation.Rules.Workspaces.List(parameters, cancellationToken = default)
GET/v1/organizations/federation_rules/{federation_rule_id}/workspaces

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Retirer un espace de travail d'une règle de fédération
WorkspaceRemoveResponse Organization.Federation.Rules.Workspaces.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/federation_rules/{federation_rule_id}/workspaces/{workspace_id}

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

OrganisationInvitations

Créer une invitation
OrganizationInvite Organization.Invites.Create(parameters, cancellationToken = default)
POST/v1/organizations/invites

Invitez un utilisateur à rejoindre l'organisation par e-mail.

Lister les invitations
InviteListPage Organization.Invites.List(parameters, cancellationToken = default)
GET/v1/organizations/invites

Listez les invitations de l'organisation.

Obtenir une invitation
OrganizationInvite Organization.Invites.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/invites/{invite_id}

Récupérez une invitation par son ID.

Supprimer une invitation
InviteDeleteResponse Organization.Invites.Delete(parameters, cancellationToken = default)
DELETE/v1/organizations/invites/{invite_id}

Supprimez une invitation en attente.

OrganisationComptes de service

Créer un compte de service
ServiceAccount Organization.ServiceAccounts.Create(parameters, cancellationToken = default)
POST/v1/organizations/service_accounts

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Lister les comptes de service
ServiceAccountListPage Organization.ServiceAccounts.List(parameters, cancellationToken = default)
GET/v1/organizations/service_accounts

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Obtenir un compte de service
ServiceAccount Organization.ServiceAccounts.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/service_accounts/{service_account_id}

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Mettre à jour un compte de service
ServiceAccount Organization.ServiceAccounts.Update(parameters, cancellationToken = default)
POST/v1/organizations/service_accounts/{service_account_id}

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Archiver un compte de service
ServiceAccount Organization.ServiceAccounts.Archive(parameters, cancellationToken = default)
POST/v1/organizations/service_accounts/{service_account_id}/archive

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

OrganisationComptes de serviceEspaces de travail

Ajouter un espace de travail à un compte de service
ServiceAccountWorkspaceMember Organization.ServiceAccounts.Workspaces.Add(parameters, cancellationToken = default)
POST/v1/organizations/service_accounts/{service_account_id}/workspaces

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Lister les espaces de travail d'un compte de service
WorkspaceListPage Organization.ServiceAccounts.Workspaces.List(parameters, cancellationToken = default)
GET/v1/organizations/service_accounts/{service_account_id}/workspaces

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Retirer un espace de travail d'un compte de service
WorkspaceRemoveResponse Organization.ServiceAccounts.Workspaces.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/service_accounts/{service_account_id}/workspaces/{workspace_id}

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

OrganisationUtilisateurs

Lister les utilisateurs
UserListPage Organization.Users.List(parameters, cancellationToken = default)
GET/v1/organizations/users

Listez les membres de l'organisation.

Obtenir un utilisateur
OrganizationUser Organization.Users.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/users/{user_id}

Récupérez un membre de l'organisation par son ID utilisateur.

Mettre à jour un utilisateur
OrganizationUser Organization.Users.Update(parameters, cancellationToken = default)
POST/v1/organizations/users/{user_id}

Mettez à jour le rôle d'un membre dans l'organisation.

Retirer un utilisateur
UserRemoveResponse Organization.Users.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/users/{user_id}

Retirez un membre de l'organisation.

OrganisationEspaces de travail

Lister les espaces de travail
WorkspaceListPage Organization.Workspaces.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces
Créer un espace de travail
Workspace Organization.Workspaces.Create(parameters, cancellationToken = default)
POST/v1/organizations/workspaces
Obtenir un espace de travail
Workspace Organization.Workspaces.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}
Mettre à jour un espace de travail
Workspace Organization.Workspaces.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}
Archiver un espace de travail
Workspace Organization.Workspaces.Archive(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/archive

OrganisationEspaces de travailLimites de débit

Lister les limites de débit d'un espace de travail
RateLimitListPage Organization.Workspaces.RateLimits.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/rate_limits

Listez les « rate limits » (limites de débit) d'un espace de travail.

Définir les limites de débit d'un espace de travail
WorkspaceRateLimit Organization.Workspaces.RateLimits.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/rate_limits/{rate_limit_id}

Définit ou efface les surcharges de limites de débit pour un groupe de limites de débit dans un espace de travail.

OrganisationEspaces de travailMembres

Lister les membres d'un espace de travail
MemberListPage Organization.Workspaces.Members.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/members
Créer un membre d'espace de travail
WorkspaceMember Organization.Workspaces.Members.Add(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/members
Obtenir un membre d'espace de travail
WorkspaceMember Organization.Workspaces.Members.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Mettre à jour un membre d'espace de travail
WorkspaceMember Organization.Workspaces.Members.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}
Supprimer un membre d'espace de travail
MemberRemoveResponse Organization.Workspaces.Members.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

OrganisationEspaces de travailComptes de service

Lister les comptes de service membres d'un espace de travail
ServiceAccountListPage Organization.Workspaces.ServiceAccounts.List(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/service_accounts

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Créer un compte de service membre d'un espace de travail
ServiceAccountWorkspaceMember Organization.Workspaces.ServiceAccounts.Add(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/service_accounts

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Obtenir un compte de service membre d'un espace de travail
ServiceAccountWorkspaceMember Organization.Workspaces.ServiceAccounts.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Mettre à jour un compte de service membre d'un espace de travail
ServiceAccountWorkspaceMember Organization.Workspaces.ServiceAccounts.Update(parameters, cancellationToken = default)
POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de workload identity federation (fédération d'identité de charge de travail) ; les clés Admin API ne sont pas acceptées. Consultez Gérer WIF avec l'Admin API.

Supprimer un compte de service membre d'un espace de travail
ServiceAccountRemoveResponse Organization.Workspaces.ServiceAccounts.Remove(parameters, cancellationToken = default)
DELETE/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Nécessite un jeton d'accès OAuth avec la portée org:admin, obtenu via ant auth login --scope org:admin ou une règle de fédération d'identité de charge de travail ; les clés API Admin ne sont pas acceptées. Consultez Gérer WIF avec l'API Admin.

OrganisationLimites de débit

Lister les limites de débit de l'organisation
RateLimitListPage Organization.RateLimits.List(parameters, cancellationToken = default)
GET/v1/organizations/rate_limits

Liste les limites de débit de l'API Messages pour votre organisation.

OrganisationParamètres de conformité

Obtenir les paramètres de conformité
OrganizationComplianceSettings Organization.ComplianceSettings.Retrieve(parameters, cancellationToken = default)
GET/v1/organizations/compliance_settings

Récupère les paramètres de conformité (Compliance Settings) de votre organisation.

Mettre à jour les paramètres de conformité
OrganizationComplianceSettings Organization.ComplianceSettings.Update(parameters, cancellationToken = default)
POST/v1/organizations/compliance_settings

Update your organization's Compliance Settings.