From 8661227014d56e08548d52f49f41701de60db195 Mon Sep 17 00:00:00 2001 From: Carl Tashian Date: Thu, 26 Sep 2024 16:41:24 -0700 Subject: [PATCH 1/2] Document step API token command --- platform/smallstep-api.mdx | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/platform/smallstep-api.mdx b/platform/smallstep-api.mdx index 68da05b4..f268b006 100644 --- a/platform/smallstep-api.mdx +++ b/platform/smallstep-api.mdx @@ -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 at least one 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. + +### 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) From dae6a2e07ea0a827200945e511d57c864bdf0616 Mon Sep 17 00:00:00 2001 From: Carl Tashian Date: Thu, 26 Sep 2024 16:42:59 -0700 Subject: [PATCH 2/2] Only one trusted root --- platform/smallstep-api.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/platform/smallstep-api.mdx b/platform/smallstep-api.mdx index f268b006..788d1a58 100644 --- a/platform/smallstep-api.mdx +++ b/platform/smallstep-api.mdx @@ -18,7 +18,7 @@ The Smallstep API is [OpenAPI conformant](https://www.openapis.org/), with JSON 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 at least one 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. +- 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