Finding Your Tenant Name
Finding Your Tenant Name
Overview
Every Britive tool needs to know which tenant it’s talking to. Your tenant is the subdomain of your Britive console URL:
https://acme.britive-app.com
└──┬─┘
tenant nameIf you log in at https://acme.britive-app.com, your tenant name is acme.
Default: use the subdomain only
Unless a specific field says otherwise, use just the subdomain (acme) — not the full URL. The pybritive CLI and Britive SDKs accept the full URL too, but normalize it down to the subdomain internally. Passing the subdomain directly avoids relying on that normalization and matches what most config fields expect.
| Context | Value to use | Example |
|---|---|---|
pybritive configure tenant | Subdomain only | acme |
BRITIVE_TENANT environment variable | Subdomain only | export BRITIVE_TENANT=acme |
Terraform provider "britive" tenant argument | Full URL | tenant = "https://acme.britive-app.com" |
Bridge auth.britive.tenant config | Either — subdomain or full URL | tenant: "acme" |
Direct REST API calls (curl, etc.) | Full URL — required | https://acme.britive-app.com/api/... |
The REST API row is the one exception: a raw HTTP request needs the actual host, so the full URL is not optional there. Everywhere else, default to the subdomain.
Next Steps
- Getting Started with pybritive — configure the CLI with your tenant
- Bridge Authentication — configure Bridge login against your tenant
Last updated on