Service APIs

This section provides comprehensive documentation for the various service APIs offered by Microsoft. Understand how to integrate with our services to build powerful applications and solutions.

API Categories

Identity & Access Management APIs

Manage user identities, authentication, and authorization for your applications.

User Authentication API

POST /api/v1/auth/login

Authenticates a user and returns an access token.

Parameters

Name Type Required Description
username string Yes The user's login name.
password string Yes The user's password.
tenantId string No The tenant identifier.

Responses

Status Code Description Schema
200 OK Authentication successful. 
{
    "accessToken": "...",
    "expiresIn": 3600,
    "tokenType": "Bearer"
}
401 Unauthorized Invalid credentials. 
{
    "error": "InvalidCredentials",
    "message": "Username or password incorrect."
}

User Profile API

GET /api/v1/users/me

Retrieves the profile information for the currently authenticated user.

Parameters

Name Type Required Description
Authorization string Yes Bearer token obtained from login.

Responses

Status Code Description Schema
200 OK User profile retrieved. 
{
    "userId": "...",
    "username": "...",
    "email": "...",
    "firstName": "...",
    "lastName": "..."
}
401 Unauthorized Authentication token is missing or invalid. 
{
    "error": "Unauthorized",
    "message": "Authentication failed."
}

Data Services APIs

Access and manage your data with our robust data service APIs.

List Items API

GET /api/v1/data/{resourceId}

Retrieves a list of items from a specified data resource.

Parameters

Name Type Required Description
resourceId string Yes The unique identifier of the data resource.
filter string No OData filter string.
select string No Comma-separated list of fields to retrieve.

Responses

Status Code Description Schema
200 OK List of items retrieved successfully. 
[
    { "id": "...", "name": "...", "value": "..." },
    { "id": "...", "name": "...", "value": "..." }
]
404 Not Found The specified resource was not found. 
{
    "error": "ResourceNotFound",
    "message": "Data resource with ID '{resourceId}' not found."
}

Compute & Orchestration APIs

Manage virtual machines, containers, and orchestrate your workloads.

Messaging & Eventing APIs

Send and receive messages, and subscribe to events from various services.

Storage Solutions APIs

Interact with cloud storage for blobs, files, and queues.