Skip to main content
API7.ai Logo
Version: 3.10.x

Register and Log In

To subscribe to API products and manage credentials, you need a Developer Portal account. The released frontend supports email-and-password registration and locally configured OAuth providers.

Register with Email and Password​

Email-and-password registration is available when auth.emailAndPassword.enabled is true in the Developer Portal config.yaml, which is the default.

  1. Navigate to the Developer Portal home page.
  2. Click Sign Up.
  3. Enter your Name, Email, and Password.
  4. Click Create Account.

Registration creates a portal user. Email verification stays off by default. See Email and Password before changing that behavior.

Log In with Email and Password​

  1. Navigate to the Developer Portal home page.
  2. Click Sign In.
  3. Enter your Email and Password.
  4. Click Sign In.

OAuth Login​

If an OAuth provider is configured in the Developer Portal config.yaml:

  1. Navigate to the Developer Portal sign-in page.
  2. Click the configured provider button.
  3. You will be redirected to the identity provider's login page.
  4. Authenticate with your organizational credentials.
  5. After successful authentication, you are redirected back to the Developer Portal.

Provider Portal login-option settings are unavailable in this released line. For the supported frontend configuration, see Customize the Developer Portal.

Join Through an Organization Invitation​

In the default Developer Portal implementation, organization owners and admins can invite people by email to join an organization:

  1. Sign in to the Developer Portal with your existing account, or register first if needed.
  2. Open the invitation email or go to the portal's organization landing page to review pending invitations.
  3. Accept the invitation to join the organization.

The exact invitation flow can vary if your portal has been customized.

Create an Organization​

After your first login, you may be prompted to create an organization. Organizations are the primary unit of multi-tenancy in the Developer Portal.

  1. Enter an Organization Name.
  2. Enter a Slug URL (a URL-friendly identifier for the organization).
  3. Click Create.

Creating the organization creates an active developer in the control plane. The Provider Portal shows that developer as the organization identity. Applications, subscriptions, and credentials belong to the organization.

note

The organization model is specific to the default Developer Portal implementation using Better Auth. If your portal has a custom implementation, the registration flow may differ.

Two-Factor Authentication (2FA)​

If auth.twoFactor.enabled is true in the Developer Portal config.yaml:

  1. Navigate to your profile or security settings.
  2. Enable 2FA and scan the QR code with an authenticator app (TOTP).
  3. On subsequent logins, enter the verification code from your authenticator app after your password.

Next Steps​