Skip to main content
Unlisted page
This page is unlisted. Search engines will not index it, and only users having a direct link can access it.
Version: 11.3.0

Prerequisites

This page lists what HYPR AgentPass™ asks for before you begin, with a link to the guide that covers each item. You can gather them in any order. The one firm sequence is that a connector's own prerequisites come before the connector.

What You Need for the Gateway​

Every other part of setup depends on these:

  • The gateway's public origin, its public base URL. Connectors and identity providers are configured against it, and your agents point at it.
  • Administration console access. Every setting in this guide lives in the console.

The administration console is served from the same origin at /admin/ui/, and the bare origin redirects to it.

The origin must be reachable from outside your network, not only from inside it. Your identity provider redirects a browser back to it after sign-in, and each supervisor's phone reaches it to act on approvals.

The Agent Portal is served from the same origin at /portal/. A gateway at https://gateway.example.com puts the portal at https://gateway.example.com/portal/. Microsoft Entra needs that portal address as a redirect URI, so settle the origin before you register anything with an identity provider.

Two more items apply only if you author policies with AI:

  • An Anthropic API key. The Author with AI wizard drafts a policy from a goal written in plain English. It needs a drafting model configured under Advanced → Gateway Settings → Policy Authoring. Writing policies by hand needs nothing extra. See Setting Up AI Authoring.
  • A cloud agent tagged as a policy author, if drafting must run in your own provider account instead of the built-in author. See Choosing Who Drafts Your Policies.

What You Need for Console Sign-In​

You configure console single sign-on (SSO) entirely in the console, with no restart and no configuration files. Have these ready before you open Advanced → Gateway Settings → Authentication:

  • An identity provider that supports OpenID Connect (OIDC). AgentPass works with any OIDC provider.
  • An application registered with that provider, and its client ID. A confidential client also needs a client secret. A public client using PKCE does not.
  • Permission to register a redirect URI with the provider. The console shows the exact URI to register. The provider refuses the sign-in if it does not recognize the return address.
  • The provider's issuer URL. AgentPass reads the provider's published configuration from it and finds the authorization, token, userinfo, JWKS, end-session and revocation endpoints. Deployments behind a proxy that rewrites those addresses can enter them individually instead.

To assign AgentPass roles from your provider instead of by hand, decide which claim carries them before you configure the connection.

See Signing In to the Console for each field, and Roles and Permissions for what the roles grant.

What You Need for the People Involved​

Each person needs a different starting point.

PersonWhat they need in place
AdministratorConsole access, and a role that permits the settings they will change
SupervisorA gateway account with a role assigned. Supervisors approve agent onboarding, so the supervisor must exist before the agent
UserThe gateway URL, from you, and console access as the supervisor of their own agent so they can approve its first connection

A service agent's accountable owner must already be a supervisor with a role. You choose the owner when you create the service agent, not afterward. See Creating a Service Agent.

What Supervisor Approvals Need​

Supervisors approve with a passkey from the HYPR mobile app. That path draws on your HYPR Authenticate tenant as well as the gateway. Have these in place before you expect approvals to work:

  • An active HYPR tenant, and Control Center admin access to it.
  • An application in Control Center for the gateway, plus an API access token scoped to it. Control Center shows the token once, when you generate it, so keep it in a password manager. See Access Tokens.
  • FIDO2 enabled on that application. See FIDO2 Settings.
  • The HYPR mobile app on each supervisor's device, signed in as that supervisor, so they can enroll a passkey and receive approval requests. Android phones need Android 14 or later, with HYPR set as the passkey provider. See Getting the HYPR App on Android.
  • Gateway console access with a role that can edit gateway settings, for the person connecting the two.

Connect them in Connecting to Your HYPR Tenant.

What Each Connector Asks For​

Connectors come in five kinds, and each has its own requirements. Set those up first, because the connector form asks for values you get from the target system.

Connector kindSet up first
AI provider: Anthropic or OpenAIAn account with the provider and an admin API key. OpenAI also needs the project ID the gateway serves. See Anthropic and OpenAI
AI provider: AWS BedrockAn AWS account, the region you will serve, and two IAM policies created in that same account. See Connecting AWS Bedrock
AI provider: AWS Bedrock MantleAn AWS account, a region outside the China and GovCloud partitions, and one IAM permission policy created in that same account. The connector form shows the policy once you choose a region. See Connecting AWS Bedrock Mantle
MCP serverThe server's endpoint and how it authenticates. See MCP Servers
REST APIThe endpoints you intend to expose to agents as MCP tools. See REST APIs
Cloud agent: AnthropicAn Anthropic account with API access. AgentPass creates and runs the agents on it. See Anthropic Cloud Agents
Cloud agent: AWS Bedrock AgentCoreThe AWS account your agents already run in, plus one of an IAM role, the gateway's deployment identity for same-account use, or an IAM access key. See AWS Bedrock AgentCore Agents
Channel: Slack AgentA Slack workspace where you can install an app, the app's signing secret and bot token, and a cloud agent to answer the workspace. See Slack Agent
Cloud agent: Microsoft 365 CopilotA Microsoft Entra tenant with Copilot licenses assigned, and two Entra app registrations. Granting tenant-wide consent needs Global Administrator, or Application Administrator plus Cloud Application Administrator. See Microsoft Entra Setup

What You Need for Workstations​

Two features act on enrolled workstations, not on the gateway alone.

Agent Observability issues the enrollment tokens workstations use to enroll. You can keep one token per rollout. See Enabling Agent Observability.

Managed Desktop Tools applies only to workstations already enrolled through Agent Observability. Turning managed mode on has no effect on a workstation until it enrolls. Routing a tool also needs an enabled connector for its provider: an Anthropic connector for Claude Code, an OpenAI connector for Codex. See Enabling Managed Desktop Tools, and Platform Support for what each operating system's endpoint client applies.

What the People Using Agents Need​

Pass these on to anyone onboarding an agent:

  • Their agent installed and working. For Claude Code, claude has been run at least once and signed in.
  • The gateway URL.
  • Console access as a supervisor, to approve their own agent's first connection.

See Onboarding Your Agent.