Teams

class terrasnek.teams.TFCTeams(instance_url, org_name, headers, well_known_paths, verify, log_level)

Teams API Docs

create(payload)

POST /organizations/:organization_name/teams

Teams Create API Doc Reference

Create Sample Payload

destroy(team_id)

DELETE /teams/:team_id

Teams Destroy API Doc Reference

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

GET organizations/:organization_name/teams

Teams List API Doc Reference

Query Parameter(s) Details

list_all(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 run for a workspace.

Returns an object with two arrays of objects.

required_entitlements()

Terraform Cloud Entitlements required for endpoint to work.

show(team_id, include=None)

GET /teams/:team_id

Teams Show 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(team_id, payload)

PATCH /teams/:team_id

Teams Update API Doc Reference

Update Sample Payload