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_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_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

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):

filter[versioned] (Optional)
include (Optional)
page (Optional)
page_size (Optional)
search (Optional)

Example filter(s):

filters = [
    {
        "keys": ["versioned"],
        "value": "foo"
    }
]

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 array of objects.

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