Org Memberships

class terrasnek.org_memberships.TFCOrgMemberships(instance_url, org_name, headers, well_known_paths, verify, log_level)

Org Memberships API Docs

invite(payload)

POST /organizations/:organization_name/organization-memberships

Org Memberships Invite API Doc Reference

Invite Sample Payload

list_all_for_org(query=None, filters=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 org membership for an organization.

Returns an array of objects.

list_for_org(query=None, filters=None, page=None, page_size=None)

GET /organizations/:organization_name/organization-memberships

Org Memberships List for Org API Doc Reference

Query Parameter(s) (details):

• query (Optional)
• filter[status] (Optional)
• page (Optional)
• page_size (Optional)

Example filter(s):

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

list_for_user()

GET /organization-memberships

Org Memberships List for User API Doc Reference

remove(org_membership_id)

DELETE /organization-memberships/:organization_membership_id

Org Memberships Remove API Doc Reference

required_entitlements()

Terraform Cloud Entitlements required for endpoint to work.

show(org_membership_id)

GET /organization-memberships/:organization_membership_id

Org Memberships 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.