`bird auth verify-email`

Usage

Code example

bird auth verify-email <email> [flags]

Description

Confirm the emailed six-digit code and sign in

Consumes the code from "bird auth signup" and signs you in. For a brand-new account it returns a single-use onboarding_ticket; pass it to "bird auth create-org" to create your organization and workspace. An account that already has an organization signs in with no ticket.

Build the request from the <email> argument and flags, a JSON MagicLinkVerifyCodeRequest body via --body-file ("-" reads stdin), or both — an inline value overrides the matching body field. Run --example to print a ready-to-edit body, or --dry-run to print the resolved request without sending it.

Procedure

Step 2 of 3 of "Sign up and create your organization". Previous: bird auth signup. Next: bird auth create-org.

Examples

Code example

# print the body shape (no credentials needed)
bird auth verify-email --example

# the body it prints:

Code example

{
  "code": "123456",
  "email": "alice@example.com"
}

Code example

# verify with the email you used and the emailed code
bird auth verify-email me@acme.com --code 123456

Options

Verification

Name	Description
`--code`	The six-digit code from the sign-in email

Request

Name	Description
`--body-file`	Read the JSON request body from this file; "-" reads stdin
`--example`	Print a complete example request body, then exit
`--dry-run`	Print the resolved request without sending it, then exit
`--idempotency-key`	Deduplication key; a retry with the same key won't act twice

Options

Name	Description
`--response-schema`	Print the fields this command returns, then exit

Name	Description
`bird auth create-org`	Create your organization and workspace and mint your credential
`bird auth login`	Authenticate with Bird through your browser (OAuth)
`bird auth logout`	Revoke the OAuth grant (if any) and remove the stored credentials file
`bird auth signup`	Start a passwordless Bird signup and email a six-digit code
`bird auth status`	Show current authentication state and validate the token against the API

Continue with the documentation, guides and examples for this topic.

Get an implementation brief

Related resources