Skip to content

Replace all (most) instances of "Bot User" with "Service User" #1635

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

Open
wants to merge 27 commits into
base: main
Choose a base branch
from
Open

Replace all (most) instances of "Bot User" with "Service User" #1635

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
27 commits
Select commit Hold shift + click to select a range
da556d8
first pass
sg-writer Oct 14, 2025
970f3ff
first mention in body text
sg-writer Oct 14, 2025
aaa0b79
service-users.mdx
sg-writer Oct 15, 2025
b4718d6
revert bot users page
sg-writer Oct 15, 2025
2494328
bot users copyediting first pass
sg-writer Oct 15, 2025
779d046
service users copyediting
sg-writer Oct 15, 2025
bb7b239
Merge branch 'main' into sg/doc-408-make-it-so-when-you-search-bot-us…
sg-writer Oct 15, 2025
40f27c4
add service user snippets
sg-writer Oct 15, 2025
eb71f6a
add service user snippets to new doc
sg-writer Oct 15, 2025
7c8d6d4
bot_ -> service_
sg-writer Oct 15, 2025
09f4212
note and warning
sg-writer Oct 15, 2025
57d55e1
another copyediting pass
sg-writer Oct 15, 2025
efc3fc9
another period
sg-writer Oct 15, 2025
4474888
sentence case for snippets
sg-writer Oct 15, 2025
6f80d4f
nav bar
sg-writer Oct 15, 2025
4989f0b
finetuning
sg-writer Oct 15, 2025
0cf3bdb
service user copyediting
sg-writer Oct 15, 2025
f95a5c1
definition
sg-writer Oct 15, 2025
165667b
fka parenthetical not necessary with definition popup
sg-writer Oct 15, 2025
b52eda1
catch all service users with definition
sg-writer Oct 15, 2025
46be338
case sensitive false
sg-writer Oct 15, 2025
c7d7485
service user -> Service User
sg-writer Oct 15, 2025
211179f
definition
sg-writer Oct 15, 2025
5cfb41f
more caps
sg-writer Oct 15, 2025
03461f0
Update api/resources/bot-users.mdx
sg-writer Oct 17, 2025
a10de4f
Apply suggestion from @sg-writer
sg-writer Oct 17, 2025
3ccbbe6
Apply suggestion from @sg-writer
sg-writer Oct 17, 2025
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
16 changes: 8 additions & 8 deletions agent/cli-api.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1258,11 +1258,11 @@ ngrok api backends weighted update <id> [flags]

| Command | Description |
| ------------------------------------- | -------------------------------------- |
| [create](#ngrok-api-bot-users-create) | Create a new bot user |
| [delete](#ngrok-api-bot-users-delete) | Delete a bot user by ID |
| [create](#ngrok-api-bot-users-create) | Create a new Bot User |
| [delete](#ngrok-api-bot-users-delete) | Delete a Bot User by ID |
| [get](#ngrok-api-bot-users-get) | Get the details of a Bot User by ID. |
| [list](#ngrok-api-bot-users-list) | List all bot users in this account. |
| [update](#ngrok-api-bot-users-update) | Update attributes of a bot user by ID. |
| [list](#ngrok-api-bot-users-list) | List all Bot Users in this account. |
| [update](#ngrok-api-bot-users-update) | Update attributes of a Bot User by ID. |

### Flags

Expand All @@ -1276,7 +1276,7 @@ ngrok api backends weighted update <id> [flags]

## ngrok api bot-users create

Create a new bot user
Create a new Bot User

### Usage

Expand All @@ -1298,7 +1298,7 @@ ngrok api bot-users create [flags]

## ngrok api bot-users delete

Delete a bot user by ID
Delete a Bot User by ID

### Usage

Expand Down Expand Up @@ -1338,7 +1338,7 @@ ngrok api bot-users get <id> [flags]

## ngrok api bot-users list

List all bot users in this account.
List all Bot Users in this account.

### Usage

Expand All @@ -1360,7 +1360,7 @@ ngrok api bot-users list [flags]

## ngrok api bot-users update

Update attributes of a bot user by ID.
Update attributes of a Bot User by ID.

### Usage

Expand Down
89 changes: 48 additions & 41 deletions api/resources/bot-users.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
---
title: Bot Users
description: Bot Users API reference.
---

import BotUsersCreateRequest from "/snippets/api/resources/examples/_bot_users_create_request.mdx";
Expand All @@ -13,123 +14,129 @@ import BotUsersListResponse from "/snippets/api/resources/examples/_bot_users_li
import BotUsersUpdateRequest from "/snippets/api/resources/examples/_bot_users_update_request.mdx";
import BotUsersUpdateResponse from "/snippets/api/resources/examples/_bot_users_update_response.mdx";

<Warning>
Bot Users are now known as Service Users.

The Bot User API endpoint is still available but will be deprecated in the future.
If you're currently using the Bot User endpoint, you should migrate to the Service User endpoint.

See the [Service Users API reference](/api/resources/service-users/) to make the switch.
</Warning>

## Create Bot User

Create a new bot user
Create a new Bot User.

### Request

POST /bot_users
POST `/bot_users`

<BotUsersCreateRequest />

#### Parameters

| Name | Type | Description |
| -------- | ------- | -------------------------------------------- |
| `name` | string | human-readable name used to identify the bot |
| `active` | boolean | whether or not the bot is active |
| `name` | string | Human-readable name used to identify the bot. |
| `active` | boolean | Whether or not the bot is active. |

### Response

Returns a 201 response on success
Returns a 201 response on success.

<BotUsersCreateResponse />

#### Fields

| Name | Type | Description |
| ------------ | ------- | ------------------------------------------------------- |
| `id` | string | unique API key resource identifier |
| `uri` | string | URI to the API resource of this bot user |
| `name` | string | human-readable name used to identify the bot |
| `active` | boolean | whether or not the bot is active |
| `created_at` | string | timestamp when the api key was created, RFC 3339 format |
| `id` | string | Unique API key resource identifier. |
| `uri` | string | URI to the API resource of this Bot User. |
| `name` | string | Human-readable name used to identify the bot. |
| `active` | boolean | Whether or not the bot is active. |
| `created_at` | string | Timestamp when the API key was created, in RFC 3339 format. |

## Delete Bot User

Delete a bot user by ID
Delete a Bot User by ID.

### Request

DELETE /bot_users/\{id\}
DELETE `/bot_users/\{id\}`

<BotUsersDeleteRequest />

### Response

Returns a 204 response with no body on success
Returns a 204 response with no body on success.

## Get Bot User

Get the details of a Bot User by ID.

### Request

GET /bot_users/\{id\}
GET `/bot_users/\{id\}`

<BotUsersGetRequest />

### Response

Returns a 200 response on success
Returns a 200 response on success.

<BotUsersGetResponse />

#### Fields

| Name | Type | Description |
| ------------ | ------- | ------------------------------------------------------- |
| `id` | string | unique API key resource identifier |
| `uri` | string | URI to the API resource of this bot user |
| `name` | string | human-readable name used to identify the bot |
| `active` | boolean | whether or not the bot is active |
| `created_at` | string | timestamp when the api key was created, RFC 3339 format |
| `id` | string | Unique API key resource identifier. |
| `uri` | string | URI to the API resource of this Bot User. |
| `name` | string | Human-readable name used to identify the bot. |
| `active` | boolean | Whether or not the bot is active. |
| `created_at` | string | Timestamp when the API key was created, in RFC 3339 format. |

## List Bot Users

List all bot users in this account.
List all Bot Users in this account.

### Request

GET /bot_users
GET `/bot_users`

<BotUsersListRequest />

### Response

Returns a 200 response on success
Returns a 200 response on success.

<BotUsersListResponse />

#### Fields

| Name | Type | Description |
| --------------- | -------------------------- | ------------------------------------------------------ |
| `bot_users` | [BotUser](#botuser-fields) | the list of all bot users on this account |
| `uri` | string | URI of the bot users list API resource |
| `next_page_uri` | string | URI of the next page, or null if there is no next page |
| `bot_users` | [BotUser](#botuser-fields) | List of all Bot Users on this account. |
| `uri` | string | URI of the Bot Users list API resource. |
| `next_page_uri` | string | URI of the next page, or null if there is no next page. |

#### BotUser fields

| Name | Type | Description |
| ------------ | ------- | ------------------------------------------------------- |
| `id` | string | unique API key resource identifier |
| `uri` | string | URI to the API resource of this bot user |
| `name` | string | human-readable name used to identify the bot |
| `active` | boolean | whether or not the bot is active |
| `created_at` | string | timestamp when the api key was created, RFC 3339 format |
| `id` | string | Unique API key resource identifier. |
| `uri` | string | URI to the API resource of this Bot User. |
| `name` | string | Human-readable name used to identify the bot. |
| `active` | boolean | Whether or not the bot is active. |
| `created_at` | string | Timestamp when the API key was created, in RFC 3339 format. |

## Update Bot User

Update attributes of a bot user by ID.
Update attributes of a Bot User by ID.

### Request

PATCH /bot_users/\{id\}
PATCH `/bot_users/\{id\}`

<BotUsersUpdateRequest />

Expand All @@ -138,21 +145,21 @@ PATCH /bot_users/\{id\}
| Name | Type | Description |
| -------- | ------- | -------------------------------------------- |
| `id` | string | |
| `name` | string | human-readable name used to identify the bot |
| `active` | boolean | whether or not the bot is active |
| `name` | string | Human-readable name used to identify the bot. |
| `active` | boolean | Whether or not the bot is active. |

### Response

Returns a 200 response on success
Returns a 200 response and a copy of the updated entity on success.

<BotUsersUpdateResponse />

#### Fields

| Name | Type | Description |
| ------------ | ------- | ------------------------------------------------------- |
| `id` | string | unique API key resource identifier |
| `uri` | string | URI to the API resource of this bot user |
| `name` | string | human-readable name used to identify the bot |
| `active` | boolean | whether or not the bot is active |
| `created_at` | string | timestamp when the api key was created, RFC 3339 format |
| `id` | string | Unique API key resource identifier. |
| `uri` | string | URI to the API resource of this Bot User. |
| `name` | string | Human-readable name used to identify the bot. |
| `active` | boolean | Whether or not the bot is active. |
| `created_at` | string | Timestamp when the API key was created, in RFC 3339 format. |
Loading