Admin Orgs

class terrasnek.admin_orgs.TFCAdminOrgs(instance_url, org_name, headers, well_known_paths, verify, log_level)

Admin Orgs API Docs

destroy(org_name)

DELETE /admin/organizations/:name

Admin Destroy Org API Doc Reference

list(include=None)

GET /api/v2/admin/organizations

Admin List Orgs API Doc Reference

This endpoint lists all organizations in the Terraform Cloud installation.

list_org_module_consumers(org_name, page=None, page_size=None)

GET /api/v2/admin/organizations/:name/relationships/module-consumers

Admin List Module Consumers for an Organization API Doc Reference

Query Parameter(s) Details

required_entitlements()

Terraform Cloud Entitlements required for endpoint to work.

show(org_name, include=None)

GET /api/v2/admin/organizations/:name

Admin Show Org API Doc Reference

terraform_cloud_only()

Return True if this endpoint is only for Terraform Cloud, else False.

terraform_enterprise_only()

Return True if this endpoint is only for Terraform Enterprise, else False.

update(org_name, payload)

PATCH /admin/organizations/:name

Admin Orgs Update API Doc Reference

Update Sample Payload

update_org_module_consumers(org_name, payload)

PATCH /admin/organizations/:name/relationships/module-consumers

Admin Orgs Update Module Consumers API Doc Reference

Update Org Module Consumers Sample Payload