Microsoft Entra ID - App Registration
π§ Guide: Setting Up Microsoft Entra ID App for API Access
This guide explains how to register a Microsoft Entra ID (formerly Azure AD) app to allow secure API access to user and group information β including avatars (also known as profile images) β via Microsoft Graph.
β Goal: Provide the Tenant ID, Client ID, and Client Secret to our team so we can integrate securely with your Entra ID.
π Prerequisites
Before you begin, ensure the following:
You have access to an Azure account with an active subscription.
You have permission to register applications (you need to be at least an Application Developer in Entra ID).
You can access Microsoft Entra ID in the Azure Portal.
π οΈ Step 1: Register a New App in Azure
Go to https://portal.azure.com
In the left-hand menu, open Microsoft Entra ID
Click App registrations β + New registration
Fill in:
Name:
TeamForm API IntegrationSupported account types: Choose Single tenant
Redirect URI: Leave this blank (unless we specify one)
Click Register
βΉοΈ Why Single Tenant?
Because this app will only be used within your Microsoft Entra ID environment. The credentials will be securely shared with TeamForm so we can access your user and group data via Microsoft Graph. You do not need to allow access from other tenants or personal accounts.
π Step 2: Gather Required Information
After registration, youβll be taken to the appβs overview page. Please copy and share the following with us:
Field | Example |
|---|---|
Application(client) ID |
|
Directory(tenant) ID |
|
Β
π Step 3: Create a Client Secret
Click the link Add a certificate or Secret
Under the Client secrets section, click + New client secret
Add a description (e.g.
IntegrationSecret)Choose an expiration (e.g. 12/24 months according to agreement)
Click Add
Copy the value of the client secret immediately β it wonβt be shown again.
β οΈ Important: Please send this secret securely (not by plain email). Use a secure method like a password manager, secure link, or encrypted message.
π Step 4: Add API Permissions
Go to API permissions
Click + Add a permission
Choose Microsoft Graph
Select:
Application permissions (recommended for background services), or
Delegated permissions (if acting on behalf of users)
Add the following permissions (or as needed):
Type | Permissions |
|---|---|
Application |
|
Click Grant admin consent to activate them
β Summary β Please Share with Us
Field | Value (example shown) |
|---|---|
Tenant ID |
|
Client ID |
|
Client Secret |
|
π Reminder: Share the secret via a secure channel.