Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document step API token command #351

Merged
merged 2 commits into from
Sep 27, 2024
Merged

Document step API token command #351

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8661227
Document step API token command
tashian Sep 26, 2024
dae6a2e
Only one trusted root
tashian Sep 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions platform/smallstep-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,16 @@ With the Smallstep API, you can:

The Smallstep API is [OpenAPI conformant](https://www.openapis.org/), with JSON requests and responses.

### TL;DR Links
### Smallstep API Setup and Usage

👉 [Smallstep API Specification and Playground](https://gateway.smallstep.com)

You can get an API token in two ways:
- In your [Smallstep settings](https://smallstep.com/app?next=/settings). Under **API Tokens**, choose **+ Add Token.**
- On the command line, using the [`step` CLI](https://smallstep.com/docs/step-cli/). The [`step api token create`](https://smallstep.com/docs/step-cli/reference/api/token/create/index.html) command accepts a client certificate and private key to authenticate with Smallstep and issue a temporary API token. To use this option, you must first configure a trusted root CA in your [Smallstep settings](https://smallstep.com/app?next=/settings). The trusted root can be a Smallstep CA or an external CA. Only one trusted root CA may be configured.

### API Clients

- Get an API token in your [Smallstep dashboard](https://smallstep.com/app). In the bottom-left **⋮** menu, go to **Settings**. Under **API Tokens**, choose **+ Add Token.**
- Visit the [Smallstep API Specification and Playground](https://gateway.smallstep.com).
- [Smallstep Terraform Provider](https://github.com/smallstep/terraform-provider-smallstep) ([Documentation](https://registry.terraform.io/providers/smallstep/smallstep/latest/docs))
- [Smallstep API Python Client](https://github.com/smallstep/smallstep-python)

Expand Down