Policy Sets¶

class terrasnek.policy_sets.TFCPolicySets(instance_url, org_name, headers, well_known_paths, verify, log_level)¶

Policy Sets API Docs

add_policies_to_set(policy_set_id, payload)¶

POST /policy-sets/:id/relationships/policies

Policy Sets Add Policies to Set API Doc Reference

Add Policies to Set Sample Payload

attach_policy_set_to_projects(policy_id, payload)¶

POST /policy-sets/:id/relationships/projects

Policy Sets Attach Set to Projects API Doc Reference

Attach Policy Set to Projects Sample Payload

attach_policy_set_to_workspaces(policy_id, payload)¶

POST /policy-sets/:id/relationships/workspaces

Policy Sets Attach Set to Workspaces API Doc Reference

Attach Policy Set to Workspaces Sample Payload

create(payload)¶

POST /organizations/:organization_name/policy-sets

Policy Sets Create API Doc Reference

Create Sample Payload

create_policy_set_version(policy_set_id)¶

POST /policy-sets/:id/versions

Policy Sets Create Set Version API Doc Reference

destroy(policy_set_id)¶

DELETE /policies/:policy_set_id

Policy Sets Destroy API Doc Reference

detach_policy_set_from_projects(policy_id, payload)¶

DELETE /policy-sets/:id/relationships/projects

Policy Sets Detach Set from Projects API Doc Reference

Detach Policy Set from Projects Sample Payload

detach_policy_set_from_workspaces(policy_id, payload)¶

DELETE /policy-sets/:id/relationships/workspaces

Policy Sets Detach Set from Workspaces API Doc Reference

Detach Policy Set from Workspaces Sample Payload

exclude_workspaces(policy_set_id, payload)¶

POST /policy-sets/:id/relationships/workspace-exclusions

Policy Sets Exclude Workspace API Doc Reference

Policy Sets Exclude Workspace Sample Payload

list(filters=None, include=None, page=None, page_size=None, search=None)¶

GET /organizations/:organization_name/policy-sets

Policy Sets List API Doc Reference

Query Parameter(s) Details

list_all(search=None, filters=None, include=None)¶

This function does not correlate to an endpoint in the TFC API Docs specifically, but rather is a helper function to wrap the list endpoint, which enumerates out every page so users do not have to implement the paging logic every time they just want to list every policy set for an organization.

Returns an object with two arrays of objects.

reinclude_workspaces(policy_set_id, payload)¶

DELETE /policy-sets/:id/relationships/workspace-exclusions

Policy Sets Re-Include Workspace API Doc Reference

Policy Sets Re-Include Workspace Sample Payload

remove_policies_from_set(policy_id, payload)¶

DELETE /policy-sets/:id/relationships/policies

Policy Sets Remove Policies from Set API Doc Reference

Remove Policies from Set Sample Payload

required_entitlements()¶: Terraform Cloud Entitlements required for endpoint to work.

show(policy_set_id, include=None)¶

GET /policy-sets/:id

Policy Sets Show API Doc Reference

show_policy_set_version(policy_set_version_id)¶

GET /policy-set-versions/:id

Policy Sets Show Policy Set Version 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(policy_set_id, payload)¶

PATCH /policy-sets/:id

Policy Sets Update API Doc Reference

Update Sample Payload

upload(path_to_tarball, policy_set_version_id)¶

PUT {derived_policy_set_upload_url} PUT https://archivist.terraform.io/v1/object/<UNIQUE OBJECT ID>

Policy Sets Upload API Doc Reference