Skip to main content

Management Plane onboarding

Onboard a Fully Managed deployment through a one-time Admin Console wizard: organization details, SSO, providers, and models. Complete Steps 1 to 4, then review Step 5 (AI Gateway), which requires no configuration because Tetrate has already provisioned the gateway, and click Complete setup. Data-plane credentials are never created, downloaded, or regenerated during Fully Managed onboarding.


The onboarding wizard

The wizard launches automatically on the first sign-in to the Admin Console; there is no separate onboarding URL. Each step has Next and Previous controls. Next is enabled once the current step's required fields are filled; Previous returns to any earlier step to review or change a value.

Step 5 is a status review, not a form

On Fully Managed, Step 5 is labeled Review AI Gateway, not Configure AI Gateway. It reports whether Tetrate's gateway is ready and asks for nothing: there is no credential to create, regenerate, or download. That credential workflow only appears on Self-Hosted Data Plane installs. Next is enabled regardless of what the status shows, so Complete setup is always reachable.

Plan for 15 to 30 minutes, plus any back-and-forth with the IdP team during Step 2.

Prerequisites

Have the following on hand before launching the wizard. Step 2 is hard to complete without the IdP details:

  • Access to the Admin Console. Tetrate provides the URL during provisioning.
  • Initial admin credentials for the first sign-in. SSO is configured in the wizard; the first login uses these credentials.
  • API credentials for at least one LLM provider, for example an OpenAI API key. At least one API key must be available during onboarding.
  • OIDC IdP details: issuer URL, client ID, client secret, scopes. Agent Router supports OIDC only; SAML and other protocols are not supported. For an evaluation without IdP admin access, use the Set up Auth0 for evaluation path instead.
  • An IdP administrator reachable during Step 2. The wizard shows a redirect URI that must be registered on the IdP side before SSO works.
  • The Gateway URL for the Data plane Tetrate assigned for the deployment, listed in the provisioning email, for example https://proxy.tare-pn-12345678.tetrate.ai. Nothing is entered with it in the wizard; the same value appears automatically as the default project's gateway endpoint once setup completes.

Get started

The onboarding wizard start screen

Click Start setup to begin.

Step 1: configure organization name

Fill in:

FieldRequiredDescriptionSample value
Organization NameYesThe organization's display nameAcme Corp.
Data plane URLNoThe public URL where the gateway (proxy) is reachable. It is provided by Tetrate.https://proxy.tare-pn-12345678.tetrate.ai
Step 1 of the wizard: organization name field
About the data plane URL

Fully Managed does not ask for a data-plane hostname here. Tetrate already operates the data plane and its gateway, so there is nothing to register. Confirm the gateway's endpoint after the first SSO sign-in (see Before the first request below).

Step 2: configure corporate login (single sign-on)

SSO lets users sign in with the organization's existing identity provider.

Step 2 of the wizard: OIDC single sign-on configuration
Evaluating without corporate IdP admin access?

Use Auth0 as a temporary IdP rather than the corporate IdP. The Set up Auth0 for evaluation guide covers the whole sequence: create the tenant, copy the Redirect URI from this step, register the Auth0 app, and paste the credentials back into this form.

About SSO

Agent Router supports OIDC only. SAML, LDAP, and other legacy protocols are not supported.

At Step 2, the wizard displays the OIDC redirect URI for the deployment, following the pattern:

https://dashboard.<your-mp-host>/login

Register Agent Router as an OIDC application in the IdP using that exact URI as an authorized redirect URI. Once the IdP-side application is registered and the issuer URL, client ID, and client secret are in hand, fill in:

FieldRequiredDescriptionSample value
Issuer (IdP URL)YesOIDC issuer URL exposed by the IdPhttps://login.example.com/
Client IDYesOAuth client ID created for Agent Routeragent-router
Client SecretYesOAuth client secret paired with the Client ID••••••••
Discovery URLNoOIDC discovery document URL. If omitted, Agent Router constructs it as <Issuer URL>/.well-known/openid-configuration. Provide it only if the IdP serves discovery at a non-standard path.https://login.example.com/.well-known/openid-configuration
ScopesYesOAuth scopes to requestopenid profile email
Admin emailOptionalSet one or more emails as admin. Emails set here are added as default project Users. If skipped, add members later from the Admin Console (default project → Members).[email protected]
Attribute mappingYesMaps an IdP claim to the Agent Router user's email. The typical value is email.email

See the SSO configuration guide for details.

Recovery

If SSO is misconfigured and blocks sign-in, sign back in with the initial admin credentials and reset the SSO configuration from the Admin Console settings panel.

Step 3: configure LLM provider keys

Connect Agent Router to one or more customer-managed LLM providers. At least one enabled provider is required to advance to Step 4.

Step 3 of the wizard: provider list

The wizard shows a list of supported providers, and the set varies by deployment; see Provisioning models and providers for the authoritative list. Click Enable next to a provider to open its form, then fill in:

FieldRequiredDescriptionSample value
Display NameNoOptional label shown in tables and filtersOpenAI
API Base URLYesBase URL for the provider API. Pre-filled for supported providers.https://api.openai.com/v1
Auth methodYesAuthentication method. Pre-filled per provider.API Key
Secret TypeYesPassword for single-string API keys; Service Account JSON for providers that authenticate with a JSON credential file.Password
Provider SecretYesAPI key, token, or service-account JSON. Use Rotate in the UI to replace a stored secret without clearing the rest of the form.sk-proj-...
Enable providerYesOff by default. Switch it on before clicking Save.toggle
Enable provider is off by default

Clicking Enable in the provider list only opens the form; it does not itself enable the provider. Inside the form, the Enable provider toggle starts off. Filling in the secret and clicking Save without switching it on saves the provider but leaves it hidden and disabled, and Step 3's "at least one provider" requirement is still not met.

Repeat for each provider to expose. The wizard returns to the provider selection screen after each one is saved.

Step 4: configure LLM models

The wizard shows a single list of all models Agent Router supports, maintained by Tetrate. By default, a selective set of common models is enabled. Deselect models to control cost, meet data-handling requirements, or scope to the intended use case. Models remain configurable later from the Admin Console. If a required model is missing, contact Tetrate support.

Step 4 of the wizard: model selection
About models

Models can be added during onboarding, or at a later stage using the Admin Console. Models selected here are automatically added to the default project, while models added after onboarding are not added automatically to the default project (or any other project). That has to be done manually.

Custom model entries are not configurable in onboarding.

Step 5: review AI Gateway

On Self-Hosted Data Plane, Step 5 is Configure AI Gateway and downloads a service-account.json credential used to install a customer-operated data plane. Fully Managed shows a different step: Review AI Gateway. There is no credential form, because Tetrate already provisioned the gateway, so the step only reports its status. The first column quotes the wizard's own wording:

Status shownMeaningWhat to do
Checking your gateway status…The wizard is querying the gateway for the first time.Wait a moment.
Your AI gateway is provisioned and ready.Managed by Tetrate, no action needed.Click Next.
Your AI gateway is still being provisioned.Normal shortly after the tenant is created. The page checks again automatically.Click Next and continue; check back later if needed.
Your AI gateway isn't ready.Something is wrong on Tetrate's side.Click Next to continue onboarding, and contact a Tetrate representative.
We couldn't check your AI gateway status.The status check itself failed, likely transient.Click Next to continue onboarding; contact a Tetrate representative if it persists.

Next is enabled for every status above, so Step 5 never blocks onboarding on Fully Managed. If the gateway is still provisioning at this step, finish onboarding and check its status again later from the Admin Console's project Gateway tab (see Before the first request below).

Step 5 of the wizard: review AI gateway

Complete the process

After Steps 1 to 4, and reviewing Step 5, click Complete setup to finish onboarding.

The wizard completion screen with the Complete setup button

The Admin Console can now be accessed by signing in with SSO.

The Admin Console SSO login window

The account that completed the wizard holds the Super Admin role, which carries full access to every resource and setting. It is not the only one the deployment can have: Super Admin is granted to further users from Directory → Access at any time, and granting it to at least one colleague early is worth doing, because a lone holder leaves no route back into administration if that account is lost. The grant, edit, and revoke flow is covered in Manage roles and permissions.

Before the first request

Onboarding sets up the default project automatically: by the time Complete setup finishes, the gateway endpoint, the providers connected in Step 3, and the models selected in Step 4 are already in place. Project membership comes from Step 2's Admin email field; add members from the Admin Console (default project → Members) if that was left blank.

Once project access is in place, continue in the Developer Console:

  • In the Console, create an Inference key for gateway requests. Do not use an Admin Console organization/API key for inference traffic.
  • The Base URL shown alongside the key is the project's gateway endpoint, already set, with nothing to configure.

If something looks wrong, for example an expected provider is not listed, the default project's Gateway, Members, Providers, and project-scoped Models pages in the Admin Console show its current state.


Where to go next