Skip to content

developer-portal-basic-authentication.md

Latest commit

 

History

History
78 lines (45 loc) · 4.52 KB

developer-portal-basic-authentication.md

File metadata and controls

78 lines (45 loc) · 4.52 KB
title Set up Basic Authentication to the Developer Portal
titleSuffix Azure API Management
description Learn how to set up user accounts with username and password authentication to the developer portal in Azure API Management.
author dlepow
ms.service azure-api-management
ms.topic how-to
ms.date 03/06/2026
ms.author danlep
ms.custom sfi-image-nochange

Configure users of the developer portal to authenticate using usernames and passwords

[!INCLUDE api-management-availability-premium-dev-standard-basic-premiumv2-standardv2-basicv2]

In the developer portal for Azure API Management, the default authentication method for users is to provide a username and password. In this article, learn how to set up users with basic authentication credentials to the developer portal.

For an overview of options to secure the developer portal, see Secure access to the API Management developer portal.

Caution

While you can use basic authentication to secure users' access to the developer portal, we recommend configuring a more secure authentication method such as Microsoft Entra ID or Microsoft Entra External ID, if available.

Prerequisites

[!INCLUDE api-management-navigate-to-instance.md]

Confirm the username and password provider

By default, the username and password identity provider is enabled in the developer portal. To confirm this setting:

  1. In the sidebar menu, under Developer portal, select Identities.

  2. In the Provider type list, confirm that Username and password appears.

  3. If the provider isn't already enabled, select + Add.

  4. Under Type, select Username and password, and then select Add.

Add a username and password

There are two ways to add a username and password for authentication to the developer portal:

  • An API publisher can add a user through the Azure portal, or with equivalent Azure tools such as the New-AzApiManagementUser Azure PowerShell cmdlet. For steps to use the portal, see How to manage user accounts in Azure API Management.

    :::image type="content" source="media/developer-portal-basic-authentication/add-user-portal.png" alt-text="Screenshot showing how to add a user in the Azure portal.":::

  • An API consumer (developer) can sign up directly in the developer portal, using the Sign up page.

    :::image type="content" source="media/developer-portal-basic-authentication/developer-portal-sign-up-page.png" alt-text="Screenshot of the sign-up page in the developer portal.":::

Note

API Management enforces password strength requirements including password length. When you add a user in the Azure portal, the password must be at least six characters long. When a developer signs up or resets a password through the developer portal, the password must be at least eight characters long.

Delete the username and password provider

If you've configured another identity provider for the developer portal such as Microsoft Entra ID or Microsoft Entra External ID, you might want to delete the username and password provider.

Deleting the identity provider prevents adding users to use username and password authentication. Existing users configured for basic authentication are also prevented from signing into the developer portal.

  1. Under Developer portal, select Identities.

  2. In the Provider type list, select Username and password. In the context menu (...), select Delete.

Tip

If you want to disable all sign-up or sign-in functionality in the developer portal, see How do I disable sign-up in the developer portal?

Related content

For steps to add other identity providers for developer sign-up to the developer portal, see: