index.md

API index

This page maps TFEClient attributes to pyTFE resource services, examples, and upstream HCP Terraform or Terraform Enterprise API docs. It is intentionally a high-signal map, not a duplicate of every method signature.

For complete wire-level behavior, use the upstream API docs linked in the last column.

Core organization and workspace resources

Client attribute	Resource class	Common methods	Example	Upstream API docs
client.organizations	Organizations	list, read, create, update, delete, capacity, entitlements, data retention	org.py	Organizations
client.projects	Projects	list, read, create, update, delete, move_workspaces, tag bindings	project.py	Projects
client.workspaces	Workspaces	list, read, create, update, delete, lock/unlock, tags, remote state consumers, data retention	workspace.py	Workspaces
client.workspace_resources	WorkspaceResourcesService	list	workspace_resources.py	Workspace resources
client.ssh_keys	SSHKeys	list, read, create, update, delete	ssh_keys.py	SSH keys
client.reserved_tag_key	ReservedTagKeys	list, create, update, delete	reserved_tag_key.py	Reserved tag keys

Runs, plans, applies, and state

Client attribute	Resource class	Common methods	Example	Upstream API docs
client.configuration_versions	ConfigurationVersions	list, read, create, upload, download, backing-data actions	configuration_version.py	Configuration versions
client.runs	Runs	list, list_for_organization, read, create, apply, cancel, force_cancel, force_execute, discard	run.py	Runs
client.plans	Plans	read, read_for_run, logs, read_json_output, read_json_output_for_run, read_json_schema_for_run	plan.py	Plans
client.applies	Applies	read, logs, errored_state	apply.py	Applies
client.assessment_results	AssessmentResults	read, json_output, json_schema, log_output	assessment_result.py	Assessment results
client.run_events	RunEvents	list, read, read_with_options	run_events.py	Runs
client.query_runs	QueryRuns	list, read, create, logs, cancel, force_cancel	query_run.py	Query runs
client.state_versions	StateVersions	list, read, read_current, create, upload, download, rollback, backing-data actions	state_versions.py	State versions
client.state_version_outputs	StateVersionOutputs	read, read_current	state_versions.py	State version outputs

Variables and variable sets

Client attribute	Resource class	Common methods	Example	Upstream API docs
client.variables	Variables	list, list_all, read, create, update, delete	variables.py	Workspace variables
client.variable_sets	VariableSets	list, list_for_workspace, list_for_project, read, create, update, delete, apply/remove relationships	variable_sets.py	Variable sets
client.variable_set_variables	VariableSetVariables	list, read, create, update, delete	variable_sets.py	Variable sets

Teams, users, and access

Client attribute	Resource class	Common methods	Example	Upstream API docs
client.users	Users	read, read_current, update_current	user.py	Users
client.teams	Teams	list, read, create, update, delete, membership helpers	team.py	Teams
client.team_workspace_accesses	TeamWorkspaceAccesses	list, read, add, update, remove	team_workspace_access.py	Team access
client.team_project_accesses	TeamProjectAccesses	list, read, add, update, remove	team_project_access.py	Project team access
client.team_tokens	TeamTokens	list, read, create, delete	team_token.py	Team tokens
client.organization_memberships	OrganizationMemberships	list, read, create, delete	organization_membership.py	Organization memberships
client.organization_tokens	OrganizationTokens	read, create, delete	organization_token.py	Organization tokens
client.subscriptions	Subscriptions	read_for_organization, read	billing.py	Subscriptions
client.invoices	Invoices	list, read_next	billing.py	Invoices

Policies and policy results

Client attribute	Resource class	Common methods	Example	Upstream API docs
client.policies	Policies	list, read, create, update, delete, upload, download	policy.py	Policies
client.policy_sets	PolicySets	list, read, create, update, delete, add/remove policies, projects, workspaces, exclusions	policy_set.py	Policy sets
client.policy_set_parameters	PolicySetParameters	list, read, create, update, delete	policy_set_parameter.py	Policy sets
client.policy_set_versions	PolicySetVersions	create, read, upload	policy_set.py	Policy set versions
client.policy_set_outcomes	PolicySetOutcomes	list, read	policy_set.py	Policy evaluations
client.policy_checks	PolicyChecks	list, read, override, logs	policy_check.py	Policy checks
client.policy_evaluations	PolicyEvaluations	list	policy_evaluation.py	Policy evaluations

Run tasks

Client attribute	Resource class	Common methods	Example	Upstream API docs
client.run_tasks	RunTasks	list, read, create, update, delete	run_task.py	Run tasks
client.workspace_run_tasks	WorkspaceRunTasks	list, read, create, update, delete	workspace_run_task.py	Run tasks
client.run_task_integrations	RunTaskIntegrations	callback	run_task_integration.py	Run task integration
client.task_stages	TaskStages	list, read, override	task_stage_example.py	Run task stages and results
client.task_results	TaskResults	read	task_result.py	Run task stages and results

Agents, registry, integrations, and other resources

Two registry surfaces: client.registry reads the public Terraform Registry (registry.terraform.io, unauthenticated), while client.registry_modules / client.registry_providers (and their version / platform sub-resources) manage your organization's private registry on HCP Terraform / TFE. See registry.md.

Client attribute	Resource class	Common methods	Example	Upstream API docs
client.agent_pools	AgentPools	list, read, create, update, delete, assign/remove workspaces/projects	agent_pool.py	Agents
client.agents	Agents	list, read, delete	agent.py	Agents
client.agent_tokens	AgentTokens	list, read, create, delete	agent.py	Agent tokens
client.registry	Registry	list_modules, search_modules, list_latest_for_all_providers, latest_for_provider, get_module, list_versions, download_url, latest_download_url, downloads_summary	registry.py	Registry API (public, unauthenticated)
client.registry_modules	RegistryModules	list, read, create, update, delete, version and upload helpers	registry_module.py	Registry modules (private)
client.no_code_modules	NoCodeModules	create, read, update, delete, read_variables, create_workspace, upgrade_workspace, read_workspace_upgrade, confirm_workspace_upgrade	no_code_provisioning.py	No-code provisioning
client.aws_oidc_configurations	AWSOIDCConfigurations	create, read, update, delete	oidc_configurations.py	AWS OIDC
client.azure_oidc_configurations	AzureOIDCConfigurations	create, read, update, delete	oidc_configurations.py	Azure OIDC
client.gcp_oidc_configurations	GCPOIDCConfigurations	create, read, update, delete	oidc_configurations.py	GCP OIDC
client.vault_oidc_configurations	VaultOIDCConfigurations	create, read, update, delete	oidc_configurations.py	Vault OIDC
client.hyok_configurations	HYOKConfigurations	list, create, read, delete, test, revoke	hyok_configuration.py	HYOK configurations
client.registry_providers	RegistryProviders	list, read, create, delete	registry_provider.py	Registry providers
client.registry_provider_versions	RegistryProviderVersions	list, read, create, delete	registry_provider_version.py	Registry providers
client.registry_provider_platforms	RegistryProviderPlatforms	list, read, create, delete	registry_provider_platform.py	Registry providers
client.oauth_clients	OAuthClients	list, read, create, update, delete, project relationships	oauth_client.py	OAuth clients
client.oauth_tokens	OAuthTokens	list, read, update, delete	oauth_token.py	OAuth tokens
client.notification_configurations	NotificationConfigurations	list, read, create, update, delete, verify	notification_configuration.py	Notification configurations
client.organization_audit_configurations	OrganizationAuditConfigurations	read, test, update	organization_audit_configuration.py	Audit trail
client.organization_tags	OrganizationTags	list, delete, add_workspaces	organization_tags.py	Organization tags
client.comments	Comments	list, read, create	comment.py	Comments
client.explorer	Explorer	query and saved-view helpers	explorer.py	Explorer
client.stacks	Stacks	list, read, create, update, delete, force_delete, VCS fetch	stack.py	Stacks
client.stack_configurations	StackConfigurations	list, read, create	stack_configuration.py	Stacks
client.github_app_installations	GitHubAppInstallations	list, read	github_app_installations.py	GitHub App installations
client.organization_token_ttl_policies	OrganizationTokenTTLPolicies	list, update, reset_to_defaults	org_token_ttl.py	Org token TTL settings

TFE admin (site-admin only)

These endpoints require TFE site-admin permission and return 404 on HCP Terraform (SaaS).

Client attribute	Resource class	Common methods	Example	Upstream API docs
client.admin.saml_settings	_AdminSAMLSettings	read, update, revoke_idp_cert	admin_identity.py	SAML settings
client.admin.scim_settings	_AdminSCIMSettings	read, update, delete	admin_identity.py	SCIM settings
client.admin.scim_tokens	_AdminSCIMTokens	list, create, read, delete	admin_identity.py	SCIM tokens
client.admin.smtp_settings	_AdminSMTPSettings	read, update	admin_smtp.py	SMTP settings

Focused guides

• workspaces.md
• runs-plans-applies.md
• state-versions.md
• variables-and-variable-sets.md
• teams-and-access.md
• policies.md
• run-tasks.md
• no-code-provisioning.md
• registry.md — public Terraform Registry vs. the private registry
• oidc-configurations.md
• admin-identity.md
• organization-defaults-and-token-ttl.md