vcfa_organization

VCF Automation — tenants / organizations (CSP gateway).

Organizations are the top-level tenancy boundary in VCFA / Aria Automation 9.x. Every project, catalog item, cloud-account, and role binding is scoped inside an org. This client owns the org lifecycle (create / read / update / delete) and the service-definition attach-points that determine which VCFA microservices the org can consume.

For per-user role bindings inside an org see saltext.vcf.clients.vcfa_iam; for the per-project membership arrays see saltext.vcf.clients.vcfa_project_user.

Endpoints (CSP gateway):

  • GET    /csp/gateway/am/api/orgs — list orgs

  • GET    /csp/gateway/am/api/orgs/{orgId} — get one

  • POST   /csp/gateway/am/api/orgs — create tenant

  • PATCH  /csp/gateway/am/api/orgs/{orgId} — update

  • DELETE /csp/gateway/am/api/orgs/{orgId} — delete

  • GET    /csp/gateway/am/api/orgs/{orgId}/service-definitions — list attached services

  • POST   /csp/gateway/am/api/orgs/{orgId}/service-definitions — enable a service

  • DELETE /csp/gateway/am/api/orgs/{orgId}/service-definitions/{id} — disable a service

saltext.vcf.clients.vcfa_organization.list_(opts, profile=None)[source]

List all orgs the caller can see.

The CSP gateway returns the collection under either items or content depending on release; we normalise both.

saltext.vcf.clients.vcfa_organization.get(opts, org_id, profile=None)[source]

Get one org by id.

saltext.vcf.clients.vcfa_organization.get_or_none(opts, org_id, profile=None)[source]

Get one org by id, or None on 404.

saltext.vcf.clients.vcfa_organization.create(opts, spec, profile=None)[source]

Create a new tenant / organization.

spec keys: displayName (required), description, name (short slug), plus any tenant-specific properties the deployment accepts (parentRefLink, customPropertyGroups etc.).

saltext.vcf.clients.vcfa_organization.update(opts, org_id, spec, profile=None)[source]

Patch an existing org.

saltext.vcf.clients.vcfa_organization.delete(opts, org_id, profile=None)[source]

Delete an org.

saltext.vcf.clients.vcfa_organization.list_services(opts, org_id, profile=None)[source]

List service definitions attached to org_id.

saltext.vcf.clients.vcfa_organization.enable_service(opts, org_id, service_definition_id, profile=None)[source]

Enable service_definition_id on the org.

The gateway accepts either {"serviceDefinitionId": "..."} or {"serviceDefinitionLink": "..."}; we send the id form.

saltext.vcf.clients.vcfa_organization.disable_service(opts, org_id, service_definition_id, profile=None)[source]

Detach service_definition_id from the org.