Espaces de travail

Lister les espaces de travail

$client->organization->workspaces->list(?string afterID, ?string beforeID, ?bool includeArchived, ?bool includeDefault, ?int limit): Page<Workspace>

GET/v1/organizations/workspaces

$client->organization->workspaces->create(string name, ?DataResidencyCreateConfig dataResidency, ?string displayColor, ?string externalKeyID, ?array<string,string> tags, ?string userProfileID): Workspace

POST/v1/organizations/workspaces

Obtenir un espace de travail

$client->organization->workspaces->retrieve(string workspaceID): Workspace

GET/v1/organizations/workspaces/{workspace_id}

Mettre à jour un espace de travail

$client->organization->workspaces->update(string workspaceID, ?DataResidencyUpdateConfig dataResidency, ?string displayColor, ?string externalKeyID, ?string name, ?array<string,string> tags, ?string userProfileID): Workspace

POST/v1/organizations/workspaces/{workspace_id}

Archiver un espace de travail

$client->organization->workspaces->archive(string workspaceID): Workspace

POST/v1/organizations/workspaces/{workspace_id}/archive

Models

enum AllowedInferenceGeo

One of the following:

"global"

"us"

class DataResidency { $allowedInferenceGeos; $defaultInferenceGeo; $workspaceGeo; }

AllowedInferenceGeos allowedInferenceGeos

Permitted inference geo values. 'unrestricted' means all geos are allowed.

DefaultInferenceGeo defaultInferenceGeo

Default inference geo applied when requests omit the parameter.

WorkspaceGeo workspaceGeo

Geographic region for workspace data storage. Immutable after creation.

class DataResidencyCreateConfig { $allowedInferenceGeos; $defaultInferenceGeo; $workspaceGeo; }

?AllowedInferenceGeos allowedInferenceGeos

Permitted inference geo values. Defaults to 'unrestricted' if omitted, which allows all geos. Use the string 'unrestricted' to allow all geos, or a list of specific geos.

?DefaultInferenceGeo defaultInferenceGeo

Default inference geo applied when requests omit the parameter. Defaults to 'global' if omitted. Must be a member of allowed_inference_geos unless allowed_inference_geos is "unrestricted".

?WorkspaceGeo workspaceGeo

Geographic region for workspace data storage. Immutable after creation. Defaults to 'us' if omitted.

class DataResidencyUpdateConfig { $allowedInferenceGeos; $defaultInferenceGeo; }

?AllowedInferenceGeos allowedInferenceGeos

Permitted inference geo values. Use 'unrestricted' to allow all geos, or a list of specific geos.

?DefaultInferenceGeo defaultInferenceGeo

Default inference geo applied when requests omit the parameter. Must be a member of allowed_inference_geos unless allowed_inference_geos is "unrestricted".

enum NoBillingWorkspaceRole

One of the following:

"workspace_admin"

"workspace_developer"

"workspace_restricted_developer"

"workspace_user"

class Workspace { $type = 'workspace'; $id; $archivedAt; /* 8 more */ }

class WorkspaceMember { $type = 'workspace_member'; $userID; $workspaceID; $workspaceRole; }

"workspace_member" type

Object type.

For Workspace Members, this is always "workspace_member".

string userID

ID of the User.

string workspaceID

ID of the Workspace.

WorkspaceRole workspaceRole

Role of the Workspace Member.

enum WorkspaceRole

One of the following:

"workspace_admin"

"workspace_billing"

"workspace_developer"

"workspace_restricted_developer"

"workspace_user"

Espaces de travailLimites de débit

Lister les limites de débit d'un espace de travail

$client->organization->workspaces->rateLimits->list(string workspaceID, ?GroupType groupType, ?bool includeInherited, ?int limit, ?string page): PageCursor<WorkspaceRateLimit>

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

$client->organization->workspaces->rateLimits->update(string rateLimitID, string workspaceID, list<WorkspaceRateLimitUpdateValue> limits): WorkspaceRateLimit

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.

Espaces de travailMembres

Lister les membres d'un espace de travail

$client->organization->workspaces->members->list(string workspaceID, ?string afterID, ?string beforeID, ?int limit): Page<WorkspaceMember>

GET/v1/organizations/workspaces/{workspace_id}/members

Créer un membre d'espace de travail

$client->organization->workspaces->members->add(string workspaceID, string userID, NoBillingWorkspaceRole workspaceRole): WorkspaceMember

POST/v1/organizations/workspaces/{workspace_id}/members

Obtenir un membre d'espace de travail

$client->organization->workspaces->members->retrieve(string userID, string workspaceID): WorkspaceMember

GET/v1/organizations/workspaces/{workspace_id}/members/{user_id}

Mettre à jour un membre d'espace de travail

$client->organization->workspaces->members->update(string userID, string workspaceID, WorkspaceRole workspaceRole): WorkspaceMember

POST/v1/organizations/workspaces/{workspace_id}/members/{user_id}

Supprimer un membre d'espace de travail

$client->organization->workspaces->members->remove(string userID, string workspaceID): MemberRemoveResponse

DELETE/v1/organizations/workspaces/{workspace_id}/members/{user_id}

Espaces de travailComptes de service

Lister les comptes de service membres d'un espace de travail

$client->organization->workspaces->serviceAccounts->list(string workspaceID, ?int limit, ?string page): PageCursor<ServiceAccountWorkspaceMember>

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

$client->organization->workspaces->serviceAccounts->add(string workspaceID, string serviceAccountID, NoBillingWorkspaceRole workspaceRole): ServiceAccountWorkspaceMember

POST/v1/organizations/workspaces/{workspace_id}/service_accounts

Obtenir un compte de service membre d'un espace de travail

$client->organization->workspaces->serviceAccounts->retrieve(string serviceAccountID, string workspaceID): ServiceAccountWorkspaceMember

GET/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Mettre à jour un compte de service membre d'un espace de travail

$client->organization->workspaces->serviceAccounts->update(string serviceAccountID, string workspaceID, NoBillingWorkspaceRole workspaceRole): ServiceAccountWorkspaceMember

POST/v1/organizations/workspaces/{workspace_id}/service_accounts/{service_account_id}

Supprimer un compte de service membre d'un espace de travail

$client->organization->workspaces->serviceAccounts->remove(string serviceAccountID, string workspaceID): ServiceAccountRemoveResponse

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.

Espaces de travail

Models

Espaces de travailLimites de débit

Espaces de travailMembres

Espaces de travailComptes de service

Espaces de travailLimites de débit

Espaces de travailMembres

Espaces de travailComptes de service