Bot Users

Do not construct this object directly, instead access the bot_users property of an ngrok.Client object.

class ngrok.services.BotUsersClient(client)

create(name='', active=None)

Create a new bot user

Parameters:

• name (str) – human-readable name used to identify the bot

• active (bool) – whether or not the bot is active

https://ngrok.com/docs/api#api-bot-users-create

Return type:

BotUser

delete(id)

Delete a bot user by ID

Parameters:

id (str) – a resource identifier

https://ngrok.com/docs/api#api-bot-users-delete

get(id)

Get the details of a Bot User by ID.

Parameters:

id (str) – a resource identifier

https://ngrok.com/docs/api#api-bot-users-get

Return type:

BotUser

list(before_id=None, limit=None)

List all bot users in this account.

Parameters:

• before_id (str) –

• limit (str) –

https://ngrok.com/docs/api#api-bot-users-list

Return type:

BotUserList

update(id, name=None, active=None)

Update attributes of a bot user by ID.

Parameters:

• id (str) –

• name (str) – human-readable name used to identify the bot

• active (bool) – whether or not the bot is active

https://ngrok.com/docs/api#api-bot-users-update

Return type:

BotUser