mirror of
https://github.com/gravitational/teleport.git
synced 2026-10-12 02:15:01 +00:00
Paul Gottschling
b6d992c5ae
We are standardizing docs guides to add a `page_type` frontmatter field, with values for how-to guides, references, etc. We can then use this field to apply linting rules that ensure each guide type follows type-specific docs site conventions. The first convention is that each docs page must have an outcome statement, the structure of which depends on the guide's type. Human and AI agent readers can determine from the outcome statement whether to continue reading the guide or not. This change assigns the `page_type` frontmatter field to 49 guides. Where an outcome statement is missing or incorrect, this change adds or corrects it. Changes include: - Landing pages: added `page_type: landing`, with no outcome statement required - Guides with entirely new outcome statements - Already-compliant guides: intro paragraphs already matched the required pattern, so this adds `page_type` only - Editing outcome statements to use compliant phrasing: a sentence in the introduction mostly matched the expected pattern, but required a small phrasing change
50 lines
2.1 KiB
Plaintext
50 lines
2.1 KiB
Plaintext
---
|
|
title: Using the Teleport API
|
|
description: Guides to writing a client application for the Teleport gRPC API, which makes it possible to programmatically manage dynamic resources.
|
|
template: "no-toc"
|
|
tags:
|
|
- zero-trust
|
|
page_type: landing
|
|
---
|
|
|
|
The Teleport Auth Service provides a gRPC API for remotely interacting with your
|
|
cluster. In this section, we will show you how to use Teleport's API.
|
|
|
|
## Go client
|
|
|
|
Teleport has a public [Go
|
|
client](https://pkg.go.dev/github.com/gravitational/teleport/api/client) to
|
|
programmatically interact with the API. [tsh and tctl](../../reference/cli/cli.mdx) use
|
|
the same API.
|
|
|
|
Here is what you can do with the Go Client:
|
|
|
|
- Integrate with external tools, e.g., to write an [Access Request
|
|
plugin](../../identity-governance/access-requests/plugins/plugins.mdx). Teleport
|
|
maintains Access Request plugins for tools like Slack, Jira, and Mattermost.
|
|
- Perform CRUD actions on resources, such as roles, authentication connectors,
|
|
and provisioning tokens.
|
|
- Dynamically configure Teleport.
|
|
|
|
## Get started
|
|
|
|
Create an API client in 3 minutes with the [Getting Started
|
|
Guide](./getting-started.mdx).
|
|
|
|
## Learn how to use Teleport's API libraries
|
|
|
|
The following guides provide tours of API libraries that are relevant when
|
|
setting up an API client to automate some aspect of setting up Teleport. Read
|
|
these guides to set up a minimal working example and plan your own use of
|
|
Teleport's API client libraries:
|
|
|
|
- [Automatically Register Teleport Agents](./automatically-register-agents.mdx):
|
|
Write a Teleport API client to reconcile the resources in your Teleport
|
|
cluster with an external service discovery API.
|
|
- [Automatically generate Teleport roles](./rbac.mdx) from an external RBAC
|
|
system, making it easier to get started with Teleport-based RBAC and keep your
|
|
Teleport roles up to date.
|
|
- [Write an Access Request Plugin](../../identity-governance/access-requests/plugins/how-to-build.mdx): Follow this guide for a
|
|
minimal working example of a plugin that you can use to manage Access Requests
|
|
through your organization's unique communication workflows.
|