Files
teleport/docs/pages/api/introduction.mdx
T
Paul Gottschling c553fa7d66 Add a guide to writing an Access Request plugin (#22441)
* Add a guide to writing an Access Request plugin

Closes #22227

This guide uses a minimal working example of an Access Request plugin to
demonstrate some of the key libraries that Teleport makes available to
plugin developers. The guide is based on a 270-line plugin that manages
Access Requests using Google Sheets.

* Respond to hugoShaka feedback

* Respond to zmb3 feedback

* Add some minor tweaks

- Update the line of code count in the demo program
- Mention Machine ID

* Respond to alexfornuto PR feedback
2023-03-14 17:35:05 +00:00

28 lines
1.2 KiB
Plaintext

---
title: Teleport API Introduction
description: Introduction to the Teleport gRPC API.
layout: tocless-doc
---
The Teleport Auth API provides a gRPC API for remotely interacting with a Teleport Auth server.
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.
## Go client
Here is what you can do with the Go Client:
- Integrating with external tools, which we have already done
for [several tools](../access-controls/access-request-plugins/index.mdx),
such as Slack, Jira, and Mattermost.
- Writing a program/bot to manage Access Requests automatically, based on your use case. One idea
is to allow/deny developer requests based on their currently assigned tasks.
- Performing CRUD actions on resources, such as `roles`, `auth connectors`, and `provisioning tokens`.
- Dynamically configuring Teleport.
Create an API client in 3 minutes with the [Getting Started
Guide](./getting-started.mdx).
Follow our [Access Request Plugin Guide](./access-plugin.mdx) for a tour of
Teleport's API libraries and develop a minimal working example.