This repository has been archived by the owner on Jun 4, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 78
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Fix typos, use specific titles, add pointers to the official documentation * Update access/README.md Co-authored-by: Marco André Dinis <marco.dinis@goteleport.com> --------- Co-authored-by: Marco André Dinis <marco.dinis@goteleport.com>
- Loading branch information
1 parent
ad74a5d
commit bf32a9d
Showing
1 changed file
with
21 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,11 +1,26 @@ | ||
# Access Plugins | ||
# Access request plugins | ||
|
||
The various plugins within this directory allow teleport users the ability to intergrate access request notifications and approval workflows with third party technologies. They also serve as examples for building your own integration. For more information on the plugins available visit the `README.md` within each plugins respective directory. | ||
The access request plugins in this directory allow Teleport users to integrate access request notifications and approval workflows with third party messaging, project management, and scheduling solutions. These plugins also serve as examples for building your own integration. | ||
If you have a self-hosted Teleport deployment, you can find information for configuring these access | ||
request plugins in [Just-in-Time Access Request Plugins](https://goteleport.com/docs/access-controls/access-request-plugins/). | ||
|
||
For more information on Access Requests with Teleport, check out this [blog post](https://goteleport.com/blog/access-requests/) | ||
For an overview of the complete workflow for access requests and how messaging, project management, and scheduling solutions integrate with Teleport, see the [Access Requests for Cloud Infrastructure](https://goteleport.com/blog/access-requests/) blog post. | ||
|
||
### Access API | ||
## Access API | ||
|
||
The Teleport Access API has been moved into the main Teleport repo, and can be imported from `github.com/gravitational/teleport/api`. To see examples of how to get started with the Teleport API, take a look at our [go-client example](https://github.com/gravitational/teleport/tree/master/examples/go-client) or read the [API docs](https://goteleport.com/docs/api/introduction/). | ||
The Teleport Access API has been moved into the main Teleport repository. | ||
You can import it from `github.com/gravitational/teleport/api`. To see examples of how to get started with the Teleport API, see the [go-client example](https://github.com/gravitational/teleport/tree/master/examples/go-client) or read the [API docs](https://goteleport.com/docs/api/introduction/). | ||
For more specific examples of how to build a custom access request workflow with the Teleport API, see [How to Build an Access Request Plugin](https://goteleport.com/docs/api/access-plugin/). | ||
|
||
For more specific examples of how to manage workflows with the Teleport API, take a look at the [Plugin example](https://goteleport.com/docs/api/access-plugin/). | ||
## Existing plugin guides | ||
|
||
The Teleport documentation includes access request plugins guides for integration | ||
with the following solutions: | ||
|
||
- [Discord](https://goteleport.com/docs/access-controls/access-request-plugins/ssh-approval-discord/) | ||
- [Email](https://goteleport.com/docs/access-controls/access-request-plugins/ssh-approval-email/) | ||
- [JIRA](https://goteleport.com/docs/access-controls/access-request-plugins/ssh-approval-jira/) | ||
- [Mattermost](https://goteleport.com/docs/access-controls/access-request-plugins/ssh-approval-mattermost/) | ||
- [Microsoft Teams](https://goteleport.com/docs/access-controls/access-request-plugins/ssh-approval-msteams/) | ||
- [PagerDuty](https://goteleport.com/docs/access-controls/access-request-plugins/ssh-approval-pagerduty/) | ||
- [Slack](https://goteleport.com/docs/access-controls/access-request-plugins/ssh-approval-slack/) |