Skip to content

Cleanup of stray API example #388

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

Merged
tashian merged 1 commit into from
Mar 12, 2025
Merged

Cleanup of stray API example #388

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
37 changes: 1 addition & 36 deletions platform/smallstep-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,41 +25,8 @@ You can get an API token in two ways:

### API Clients

- [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)

### Getting Started

Output:

```bash
[
{
"active": true,
"displayName": "Alice T",
"emails": [
{
"email": "[email protected]",
"primary": true
}
],
"familyName": "T",
"givenName": "Alice",
"groups": [
{
"id": "a1028765-3d67-44b0-b51b-f7d76727f181",
"name": "admin"
},
{
"id": "eb4b75f0-a341-4dac-a52a-12d90d91b97d",
"name": "super-admin"
}
],
"id": "4510f372-f4ba-4dc7-b6c2-ad22fdaaadb1",
"posixUsers": []
}
]
```
- [Smallstep Terraform Provider](https://github.com/smallstep/terraform-provider-smallstep) ([Documentation](https://registry.terraform.io/providers/smallstep/smallstep/latest/docs))

### Example: Add devices via the API

Expand All @@ -69,8 +36,6 @@ Devices added via API are automatically approved.
but they will not be marked as high-assurance
until Smallstep receives an attestation from the device.

#### Example: I have a list of device identifiers

For each device, use the [Save Collection Instance](https://gateway.smallstep.com/v2023-11-01/operations/PutCollectionInstance) endpoint to create a device.
- For the `collectionSlug`, use `default`
- For Apple devices, the `instanceID` must be the device's serial number.
Expand Down