documentation
Sign-in tools
The auth_login, auth_complete and auth_status tools for Bud and Bloom.
Six tools sign the server in to Bud and Bloom through the browser. See Sign in for the flow.
6 tools: 2 read-only, 4 that change data.
Sign-in
Section titled “Sign-in”bud_auth_login
Section titled “bud_auth_login”Sign in to Bud
changes data
Start browser authorization for an instance. When BUD_URL is set, sign-in always goes to that instance: url may be left out, and a different url is refused. When BUD_URL is not set, pass the instance URL to sign in to as url, or leave url out to sign in again to the instance of the profile in use. Sign-in stores its tokens in the profile set by BUD_PROFILE, else in the default profile; a profile keeps its instance. Returns a link and a request code: open the link, check that the approval page shows the same request code, and approve with your existing account permissions. The default callback mode receives the approval on a loopback port of this machine. In code mode the approval page shows a one-time code instead; code mode works only on an instance whose operator has enabled it.
| Input | Type | Required | Notes |
|---|---|---|---|
url |
string | ||
mode |
callback \ |
code |
|
client_name |
string |
bud_auth_complete
Section titled “bud_auth_complete”Complete Bud sign-in
changes data
Complete a pending browser authorization after approval in the browser; in code mode, pass the one-time code from the approval page. A request denied in the browser ends here and needs a new sign-in. Credentials stay in the local private store.
| Input | Type | Required | Notes |
|---|---|---|---|
session_id |
string | yes | |
code |
string |
bud_auth_status
Section titled “bud_auth_status”Bud sign-in status
read-only
Show the configured instance and local sign-in state without exposing credentials.
No input.
bloom_auth_login
Section titled “bloom_auth_login”Sign in to Bloom
changes data
Start browser authorization for an instance. When BLOOM_URL is set, sign-in always goes to that instance: url may be left out, and a different url is refused. When BLOOM_URL is not set, pass the instance URL to sign in to as url, or leave url out to sign in again to the instance of the profile in use. Sign-in stores its tokens in the profile set by BLOOM_PROFILE, else in the default profile; a profile keeps its instance. Returns a link and a request code: open the link, check that the approval page shows the same request code, and approve with your existing account permissions. The default callback mode receives the approval on a loopback port of this machine. In code mode the approval page shows a one-time code instead; code mode works only on an instance whose operator has enabled it.
| Input | Type | Required | Notes |
|---|---|---|---|
url |
string | ||
mode |
callback \ |
code |
|
client_name |
string |
bloom_auth_complete
Section titled “bloom_auth_complete”Complete Bloom sign-in
changes data
Complete a pending browser authorization after approval in the browser; in code mode, pass the one-time code from the approval page. A request denied in the browser ends here and needs a new sign-in. Credentials stay in the local private store.
| Input | Type | Required | Notes |
|---|---|---|---|
session_id |
string | yes | |
code |
string |
bloom_auth_status
Section titled “bloom_auth_status”Bloom sign-in status
read-only
Show the configured instance and local sign-in state without exposing credentials.
No input.