Setup and identity commands

Beta

Use the setup command to connect your machine to the Passport Proxy, and the whoami command to verify the identity stored in your client certificate.

passport setup

Provision a client certificate for the current user. Running this command connects your machine to the Passport Proxy by generating a keypair, obtaining a signed bundle from Passport Cloud, and requesting a CA-signed certificate from the proxy. The certificate encodes your identity, machine identity, approved APIs and their secret references, and access duration. For a walkthrough, see Set up the Passport Proxy.

This command is safe to re-run. Each run generates a fresh keypair and certificate.

You must run passport login before running passport setup.

Usage

$passport setup [options]

Options

--requested-refs <csv>

Comma-separated list of secret references to request access for.

--endpoint <hostname>

Target hostname the certificate will be used against (for example, api.stripe.com).

--ttl <seconds>
Defaults to 3600

Certificate validity period in seconds.

--namespace-id <id>

Namespace UUID. Passport Cloud verifies you have view access to the namespace before issuing the bundle.

--no-daemon

Skip installing and starting the daemon and setting HTTPS_PROXY. Use for headless or CI environments.

--proxy-host <host>

Override the data-plane hostname from dynamic discovery. Advanced use only.

--proxy-port <port>

Override the data-plane port from dynamic discovery. Advanced use only.

--gateway-url <url>

Override the Bifrost gateway URL. Advanced use only.

-e, --email <email>

Override the identity email. Defaults to the logged-in profile.

--user-id <id>

Override the user ID. Defaults to the logged-in profile.

--team-id <id>

Override the team ID. Defaults to the logged-in profile.

Examples

$passport setup
$
$passport setup --requested-refs JOKE_CHANNEL,API_KEY

passport whoami

Display the identity stored in the client certificate on your machine. Use this to verify your certificate is valid and confirm which identity and API permissions it encodes. For more information, see Check your access.

Usage

$passport whoami

Example

$passport whoami