tenancy_hierarchy.go (package eai)

Source : sdks/go/tenancy_hierarchy.go. Retour à l'index de la référence du SDK Go.

remarque

Cette page est générée par tools/docs/gen_sdk_reference.py depuis les sources du SDK et les dossiers de textes OpenAPI. Ne la modifiez pas à la main : changez la source et régénérez.

Classe OrganizationsService

Tenants et organisation. Les tenants, leur hiérarchie, les projets, les environnements et les membres.

OrganizationsService.Create

Create(ctx context.Context, body any, opts ...CallOption) (json.RawMessage, error)

Créer une organisation. Crée une organisation dans le tenant. Exige tenant_admin. Un identifiant court déjà utilisé répond 409 conflict. Écrit l'événement d'audit organization.create.

Route : /v1/organizations (POST).

Nom	Type	Défaut	Requis	Description
ctx	context.Context		oui	Contexte de l'appel : annulation et échéance.
body	any		oui	Identifiant court, nom, description et métadonnées de l'organisation.
opts	...CallOption		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Créer une organisation ». L'error est une erreur typée du SDK, nil en cas de succès.

Erreurs levées : error, les erreurs typées du transport (Erreurs).

OrganizationsService.List

List(ctx context.Context, opts ...CallOption) (*Page, error)

Lister les organisations. Liste les organisations du tenant, paginées. Ouvert à tout membre du tenant.

Route : /v1/organizations (GET).

Nom	Type	Défaut	Requis	Description
ctx	context.Context		oui	Contexte de l'appel : annulation et échéance.
opts	...CallOption		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Retour : (*Page, error). Réponse JSON décodée de l'opération « Lister les organisations ». L'error est une erreur typée du SDK, nil en cas de succès.

Erreurs levées : error, les erreurs typées du transport (Erreurs).

OrganizationsService.Update

Update(ctx context.Context, organizationID string, body any, opts ...CallOption) (json.RawMessage, error)

Modifier une organisation. Modifie le nom, la description, le statut (active ou archived) ou les métadonnées d'une organisation. Exige tenant_admin. Envoyez expected_version pour détecter une modification concurrente (409 version_conflict). Écrit l'événement d'audit organization.update.

Route : /v1/organizations/{organization_id} (PATCH).

Nom	Type	Défaut	Requis	Description
ctx	context.Context		oui	Contexte de l'appel : annulation et échéance.
organizationID	string		oui	Identifiant (UUID) de l'organisation.
body	any		oui	Champs à modifier ; les champs omis gardent leur valeur.
opts	...CallOption		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Modifier une organisation ». L'error est une erreur typée du SDK, nil en cas de succès.

Erreurs levées : error, les erreurs typées du transport (Erreurs).

Classe BusinessUnitsService

Tenants et organisation. Les tenants, leur hiérarchie, les projets, les environnements et les membres.

BusinessUnitsService.Create

Create(ctx context.Context, body any, opts ...CallOption) (json.RawMessage, error)

Créer une unité métier. Crée une unité métier dans une organisation, éventuellement sous une unité parente de la même organisation (422 invalid_hierarchy sinon). Exige tenant_admin. Un identifiant court déjà utilisé répond 409 conflict. Écrit l'événement d'audit business_unit.create.

Route : /v1/business-units (POST).

Nom	Type	Défaut	Requis	Description
ctx	context.Context		oui	Contexte de l'appel : annulation et échéance.
body	any		oui	Organisation, parent, identifiant court, nom et description de l'unité.
opts	...CallOption		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Créer une unité métier ». L'error est une erreur typée du SDK, nil en cas de succès.

Erreurs levées : error, les erreurs typées du transport (Erreurs).

BusinessUnitsService.List

List(ctx context.Context, opts ...CallOption) (*Page, error)

Lister les unités métier. Liste les unités métier du tenant, paginées, éventuellement filtrées par organisation ou par unité parente. Ouvert à tout membre du tenant.

Route : /v1/business-units (GET).

Nom	Type	Défaut	Requis	Description
ctx	context.Context		oui	Contexte de l'appel : annulation et échéance.
opts	...CallOption		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Retour : (*Page, error). Réponse JSON décodée de l'opération « Lister les unités métier ». L'error est une erreur typée du SDK, nil en cas de succès.

Erreurs levées : error, les erreurs typées du transport (Erreurs).

BusinessUnitsService.Update

Update(ctx context.Context, businessUnitID string, body any, opts ...CallOption) (json.RawMessage, error)

Modifier une unité métier. Modifie le nom, la description, le statut (active ou archived) ou les métadonnées d'une unité métier. Son organisation et son parent ne peuvent pas changer. Exige tenant_admin. Envoyez expected_version pour détecter une modification concurrente (409 version_conflict). Écrit l'événement d'audit business_unit.update.

Route : /v1/business-units/{business_unit_id} (PATCH).

Nom	Type	Défaut	Requis	Description
ctx	context.Context		oui	Contexte de l'appel : annulation et échéance.
businessUnitID	string		oui	Identifiant (UUID) de l'unité métier.
body	any		oui	Champs à modifier ; les champs omis gardent leur valeur.
opts	...CallOption		non	Options de l'appel (requête, clé d'idempotence, traceparent, en-têtes).

Retour : (json.RawMessage, error). Réponse JSON décodée de l'opération « Modifier une unité métier ». L'error est une erreur typée du SDK, nil en cas de succès.

Erreurs levées : error, les erreurs typées du transport (Erreurs).