Documentation
Sign inGet started

bird auth

Usage

Ejemplo de código
bird auth

Description

Credentials are an OAuth grant from login or a bk_ API key taken from the environment, and either is scoped to one 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 first organization
Sign up passwordlessly with the six-digit code emailed to the address, then create the first 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.
  1. 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-email
  2. bird 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-org
  3. bird auth create-org — Creates the organization and first workspace and stores the minted credential, so subsequent calls are authenticated.

Session

NameDescription
loginAuthenticate with Bird through your browser (OAuth)
logoutRevoke the OAuth grant (if any) and remove the stored credentials file
statusShow current authentication state and validate the token against the API

Onboarding

NameDescription
signupStart a passwordless Bird signup and email a six-digit code
verify-emailConfirm the emailed six-digit code and sign in
create-orgCreate the first organization and workspace and mint your credential