Skip to navigation

Setup and identity commands

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

-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.

--endpoint <hostname>

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

--ttl <seconds>
Defaults to 300

Certificate validity period in seconds.

--management-url <url>

Certificate management HTTPS origin. Defaults to --proxy-url or the effective proxy URL.

--proxy-url <url>

Data-plane proxy HTTPS origin.

--proxy-server-name <host>

TLS server name (SNI) for the proxy connection. Defaults to the proxy host.

--namespace-id <id>

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

--gateway-url <url>

Override the Bifrost gateway URL. Advanced use only.

--passport-service-url <url>

Override the passport-service base URL. Advanced use only.

--no-daemon

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

--verbose

Show the full endpoint resolution priority chain. Also enabled by setting PASSPORT_DEBUG=1.

Examples

Run passport setup after passport login:

passport setup --endpoint api.stripe.com

Skip passport-service discovery by specifying a manual proxy endpoint:

passport setup --proxy-url https://my-proxy.example.com:8443

To use separate management and proxy endpoints:

passport setup --management-url https://mgmt.example.com \
--proxy-url https://proxy.example.com:8443

Exit codes

CodeDescription
0Full success. Credentials are ready and the daemon is running.
1Hard failure. Credential setup failed.
2Partial success. Credentials are ready, but the daemon failed to start.

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.

You can also view this information in the terminal dashboard.

Usage

passport whoami

Example

passport whoami