mirror of
https://github.com/gravitational/teleport.git
synced 2026-09-21 05:55:42 +08:00
Paul GottschlingandSteven Martin
e667486c31
* Support spellchecking in docs content In gravitational/docs#261, we will add a script that checks the spelling of each version of the docs. This change edits one version of the docs content to support this, including: - A cspell configuration file - A new step in the GitHub Actions in the "Lint (Docs)" workflow that runs the spellcheck script we will add in `gravitational/docs` - Fix mispellings so this passes the lint job. The mispellings are in a file that we generated automatically, but there are few enough of them, and we haven't merged the auto-generation script yet, that I think it makes sense to fix them in the generated file for now. * Respond to PR feedback - Remove misspellings from the ignore list - Sort the ignore list (and format it via prettier) * Use the new yarn spellcheck command * Spelling fixes * spell fixes and add words to cspell.json --------- Co-authored-by: Steven Martin <steven@goteleport.com>
47 lines
1.9 KiB
Plaintext
47 lines
1.9 KiB
Plaintext
---
|
|
title: Teleport API Introduction
|
|
description: Introduction to the Teleport gRPC API.
|
|
layout: tocless-doc
|
|
---
|
|
|
|
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
|
|
programatically interact with the API. [tsh and tctl](../reference/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](../access-controls/access-request-plugins/index.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](./access-plugin.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.
|