bird auth
Usage
Code example
bird authDescription
Credentials are an OAuth grant from login or a bk_ API key taken from the environment,
and either is scoped to your workspace. login opens a browser; --device prints a code for
a headless host. Creating an account needs no browser at all.
Procedure
Sign up and create your organization
Sign up passwordlessly with the six-digit code emailed to the address, then create your organization, which mints and stores your API credential. Fully browserless: no dashboard and no password needed. Signup and verification are region-agnostic; the region is chosen when you create the organization.
bird auth signup— Emails a six-digit code to the address; no password is set. Read the six-digit code from the sign-in email. Next: bird auth verify-emailbird auth verify-email— Signs in with the email and the emailed code; for a brand-new account returns a single-use onboarding_ticket. Next: bird auth create-orgbird auth create-org— Creates the organization and workspace and stores the minted credential, so subsequent calls are authenticated.
Session
| Name | Description |
|---|---|
login | Authenticate with Bird through your browser (OAuth) |
logout | Revoke the OAuth grant (if any) and remove the stored credentials file |
status | Show current authentication state and validate the token against the API |
Onboarding
| Name | Description |
|---|---|
signup | Start a passwordless Bird signup and email a six-digit code |
verify-email | Confirm the emailed six-digit code and sign in |
create-org | Create your organization and workspace and mint your credential |
Related resources
Continue with the documentation, guides and examples for this topic.