Skip to content

Commit c498a6a

Browse files
renzobianchiclaude
andcommitted
docs: rename Team ID to team slug where it refers to the slug (PRE-53)
The dashboard now labels the team slug "Team slug" and reserves "Team ID" for the team's UUID (smallstep/web#3028). Update docs that called the slug "Team ID" to match, including <team-id> placeholders. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
1 parent 8b5201a commit c498a6a

10 files changed

Lines changed: 23 additions & 23 deletions

‎platform/smallstep-agent.mdx‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -488,10 +488,10 @@ Your agent needs to enroll with your team.
488488
To self-enroll a device, run:
489489
490490
```
491-
/Applications/SmallstepAgent.app/Contents/MacOS/SmallstepAgent register <team-id>
491+
/Applications/SmallstepAgent.app/Contents/MacOS/SmallstepAgent register <team-slug>
492492
```
493493
494-
Replace `<team-id>` with your Team ID from the Smallstep UI (found in [Settings → Team](https://smallstep.com/app/?next=/settings/team)).
494+
Replace `<team-slug>` with your team slug from the Smallstep UI (found in [Settings → Team](https://smallstep.com/app/?next=/settings/team)).
495495
496496
## Confirmation
497497
@@ -508,11 +508,11 @@ To uninstall the Smallstep Agent from a macOS system:
508508
509509
```bash
510510
/Applications/SmallstepAgent.app/Contents/MacOS/SmallstepAgent svc uninstall
511-
/Applications/SmallstepAgent.app/Contents/MacOS/SmallstepAgent reset <team-id>
511+
/Applications/SmallstepAgent.app/Contents/MacOS/SmallstepAgent reset <team-slug>
512512
rm /Library/LaunchAgents/com.smallstep.launchd.Agent.plist
513513
```
514514
515-
Replace `<team-id>` with your Team ID from the Smallstep UI (found in [Settings → Team](https://smallstep.com/app/?next=/settings/team)).
515+
Replace `<team-slug>` with your team slug from the Smallstep UI (found in [Settings → Team](https://smallstep.com/app/?next=/settings/team)).
516516
517517
2. Remove the application directory:
518518
@@ -566,7 +566,7 @@ Set-ItemProperty -Path "HKLM:\Software\Policies\Smallstep" -Name "TeamSlug" -Val
566566
Set-ItemProperty -Path "HKLM:\Software\Policies\Smallstep" -Name "CAFingerprint" -Value "<agents-ca-fingerprint>"
567567
```
568568
569-
Replace `<team-slug>` and `<agents-ca-fingerprint>` with your Smallstep [team ID](https://smallstep.com/app/?next=/settings) and the CA fingerprint of your Smallstep Agents CA.
569+
Replace `<team-slug>` and `<agents-ca-fingerprint>` with your Smallstep [team slug](https://smallstep.com/app/?next=/settings) and the CA fingerprint of your Smallstep Agents CA.
570570
571571
2. On the device, navigate to the agent installation directory and obtain the device's TPM fingerprint:
572572

‎ssh/acls.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ Of course, hosts, and groups can have as many tag combinations as you like. Take
3737

3838
### Step 1: Determine host tag combination
3939

40-
Sign in at `https://smallstep.com/app/[Team ID]`
40+
Sign in at `https://smallstep.com/app/[team slug]`
4141
* Choose "SSH Professional" from the top navigation bar
4242
* Choose "Hosts" on the right hand navigation bar
4343
* Find and select a Host that includes the Host Tags you wish to use for access grants.

‎ssh/azure-ad.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ When creating your groups, give them names and accept the defaults on all other
5454

5555
#### Sign in to Smallstep SSH
5656

57-
1. Sign in to Smallstep at `https://smallstep.com/app/[Team ID]`
57+
1. Sign in to Smallstep at `https://smallstep.com/app/[team slug]`
5858
2. Follow the Getting Started workflow.
5959
3. Choose the **Users** tab, and choose **Microsoft Entra ID** as your identity provider.
6060
4. Enter your **Tenant ID** and **Whitelisted Domains**, and **Save**.

‎ssh/client.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,13 +28,13 @@ The Client Quickstart is accessible within the Smallstep UI. When selected, it c
2828

2929
### Sign in to the Smallstep UI
3030

31-
* Sign in at `https://smallstep.com/app/[Team ID]`
31+
* Sign in at `https://smallstep.com/app/[team slug]`
3232
* Select the "Resources" menu item
3333
* A link to the **Client Quickstart Guide** is available under the "Guides" section of this page
3434

3535
### Alternate instructions
3636

37-
You can also modify the following link by replacing `[Team ID]` with your Smallstep SSH Team ID:
37+
You can also modify the following link by replacing `[team slug]` with your Smallstep SSH team slug:
3838

39-
* `https://smallstep.com/app/teams/quickstart?team=[Team ID]`
39+
* `https://smallstep.com/app/teams/quickstart?team=[team slug]`
4040
* For example: smallstep.com/app/teams/quickstart?**team=avengers**

‎ssh/hosts-step-by-step.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ This step will install modules and services.
4444
### Step 4. Configure `step` to connect to your CA
4545

4646
```shell
47-
step ca bootstrap --team="[your smallstep team ID]"
47+
step ca bootstrap --team="[your smallstep team slug]"
4848
```
4949

5050
### Step 5. Get an SSH host certificate
@@ -142,6 +142,6 @@ Before you sign out of your `sudo` session, test your installation by logging in
142142

143143
**This step is especially important if you have made any non-standard changes to your PAM or NSS stacks.**
144144

145-
Now sign in at `https://smallstep.com/app/[Team ID]`
145+
Now sign in at `https://smallstep.com/app/[team slug]`
146146

147147
You should see your host listed under the "**Hosts**" tab.

‎ssh/hosts.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ bash <(curl -sSf https://files.smallstep.com/ssh-host.sh)
9696
```
9797

9898
You'll be prompted for
99-
your team ID,
99+
your team slug,
100100
enrollment token,
101101
hostname,
102102
and a list of space-separated host tags
@@ -106,7 +106,7 @@ and a list of space-separated host tags
106106

107107
The `ssh-host.sh` utility can also be run non-interactively,
108108
as long as you provide the following _required flags_:
109-
* `--team "[your team ID]"`
109+
* `--team "[your team slug]"`
110110
* `--token "[your enrollment token]"`
111111
* `--hostname "[the hostname]"`
112112
* One or more `--tag "key=value"` to assign [host tags](#understanding-host-tags)
@@ -124,7 +124,7 @@ Before you sign out of your `sudo` session, test your installation by logging in
124124

125125
**This step is especially important if you have made any non-standard changes to your PAM or NSS stacks.**
126126

127-
Now sign in at `https://smallstep.com/app/[Team ID]`
127+
Now sign in at `https://smallstep.com/app/[team slug]`
128128

129129
You should see your host listed under the "**Hosts**" tab.
130130

‎ssh/okta.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ In this quickstart, we will:
156156

157157
### Step 4. Sign in to the Smallstep UI
158158

159-
Sign in at `https://smallstep.com/app/[Team ID]`
159+
Sign in at `https://smallstep.com/app/[team slug]`
160160

161161
* Select the **Logs** tab. You should see a list of success messages associated with `SCIM-SYNC` category items.
162162

‎tutorials/connect-intune-to-smallstep.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,7 +135,7 @@ In this step, we’ll tie everything together by creating Windows policy to enro
135135
3. Download the Intermediate Certificate
136136
4. Copy and temporarily save the **SCEP server URL** shown on the page, eg. `https://agents.example.ca.smallstep.com/scep/integration-intune-b967f507`
137137
2. Visit [Team Settings](https://smallstep.com/app/?next=/settings/team)
138-
1. Copy and temporarily save the **Team Name** and **Team ID** values
138+
1. Copy and temporarily save the **Team Name** and **Team slug** values
139139

140140
### 6. Create a policy in Intune
141141

@@ -161,7 +161,7 @@ In this step, we’ll tie everything together by creating Windows policy to enro
161161
3. Choose Setting Name: Smallstep → Settings → Smallstep Enrollment Settings
162162
4. Within the settings pane:
163163
1. Supported on: Enabled
164-
2. Team Slug: (paste the Team ID you saved earlier)
164+
2. Team Slug: (paste the Team slug you saved earlier)
165165
3. Certificate URI:
166166
```
167167
capi:store-location=machine;store=My;issuer=Smallstep (<team-name>) Agents Intermediate CA;cn=step-agent-bootstrap

‎tutorials/connect-workspace-one-to-smallstep-macos.mdx‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@ You’ll need the following values from when you configured your Workspace ONE c
110110

111111
If you need to retrieve these again, you can always visit: **[Settings → Device Management](https://smallstep.com/app/?next=/settings/devices) → Omnissa Workspace ONE**
112112

113-
You’ll also need your **Team ID** (team slug), shown in the Smallstep UI under [Settings → Team](https://smallstep.com/app/?next=/settings/team).
113+
You’ll also need your **Team slug**, shown in the Smallstep UI under [Settings → Team](https://smallstep.com/app/?next=/settings/team).
114114

115115
#### Add a Workspace ONE CA resource
116116

@@ -163,12 +163,12 @@ A new modal screen will be presented with the empty Request Template configurati
163163
3. Certificate Template: choose the `Smallstep Agents` template you created earlier
164164
4. Allow all applications access: ☑️ (so the Smallstep Agent can use the issued identity)
165165
6. Select the **Custom Settings** payload type on the left and choose **Configure**. This delivers the Smallstep Agent configuration as a managed preference in the `com.smallstep.Agent` domain.
166-
- Paste the following, replacing `<team-id>` with the Team ID value you copied from the Smallstep UI earlier:
166+
- Paste the following, replacing `<team-slug>` with the Team slug value you copied from the Smallstep UI earlier:
167167

168168
```xml
169169
<dict>
170170
<key>TeamSlug</key>
171-
<string>&lt;team-id&gt;</string>
171+
<string>&lt;team-slug&gt;</string>
172172
<key>Certificate</key>
173173
<string>mackms:label=$PROFILE_IDENTIFIER;se=false;tag=</string>
174174
</dict>

‎tutorials/connect-workspace-one-to-smallstep.mdx‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ Within a few minutes after adding the connection, you should see all of your Wor
6969
2. Choose **Add** and then **Windows**
7070
1. In the General tab, provide a name for the script, such as “Smallstep Agent Enrollment”
7171
2. On the Details tab, ensure the **Language** is “Powershell” and the **Execution Context & Privileges** is “System Context”
72-
3. Use the following snippet as the **Code**, making sure to replace `<team-id>` with the Team ID value you copied from the Smallstep UI earlier. `<team-name>` should be replaced with your full Team name shown in the Smallstep dashboard.
72+
3. Use the following snippet as the **Code**, making sure to replace `<team-slug>` with the Team slug value you copied from the Smallstep UI earlier. `<team-name>` should be replaced with your full Team name shown in the Smallstep dashboard.
7373

7474
```xml
7575
$RegistryPath = "HKLM:\Software\Policies\Smallstep"
@@ -78,7 +78,7 @@ Within a few minutes after adding the connection, you should see all of your Wor
7878
New-Item -Path $RegistryPath
7979
}
8080

81-
Set-ItemProperty -Path "HKLM:\Software\Policies\Smallstep" -Name "TeamSlug" -Value "<team-id>"
81+
Set-ItemProperty -Path "HKLM:\Software\Policies\Smallstep" -Name "TeamSlug" -Value "<team-slug>"
8282
Set-ItemProperty -Path "HKLM:\Software\Policies\Smallstep" -Name "Certificate" -Value "capi:store-location=machine;store=My;issuer=Smallstep (<team-name>) Agents Intermediate CA;cn=$env:DEVICE_ID"
8383
```
8484

0 commit comments

Comments
 (0)