Share via

Get credentials to access Media Services API

  • Article

Media Services logo v3

Warning

Azure Media Services will be retired June 30th, 2024. For more information, see the AMS Retirement Guide.

When you use Azure AD authentication to access the Azure Media Services API, you have two authentication options:

  • Service principal authentication

    Authenticate a service. Applications that commonly use this authentication method are apps that run daemon services, middle-tier services, or scheduled jobs: web apps, function apps, logic apps, APIs, or a microservice.

  • User authentication

    Authenticate a person who is using the app to interact with Media Services resources. The interactive application should first prompt the user for credentials. An example is a management console app used by authorized users to monitor encoding jobs or live streaming.

This article describes steps for getting credentials to access Media Services API. Choose from the following tabs.

Prerequisites

API access

The API access page lets you select the authentication method you want to use to connect to the API. The page also provides the values you need to connect to the API.

  1. In the Azure portal, select your Media Services account.
  2. Select the API access blade on the left navigation bar.
  3. Under Connect to Media Services API, select the Media Services API version you want to connect to (V3 is the latest version of the service).

Service principal authentication

Authenticates a service using an Azure Active Directory (Azure AD) app and secret.

Manage your Azure AD app and secret

The Manage your AAD app and secret section lets you select or create a new Azure AD app and generate a secret. For security purposes, the secret cannot be shown after the blade is closed. The application uses the application ID and secret for authentication to obtain a valid token for media services.

Make sure that you have sufficient permissions to register an application with your Azure AD tenant and to assign the application to a role in your Azure subscription. For more information, see Required permissions.

Connect to Media Services API

The Connect to Media Services API provides you with values that you use to connect your service principal application. You can get text values or copy the JSON or XML blocks.

User authentication

This option could be used to authenticate an employee or member of an Azure Active Directory who is using an app to interact with Media Services resources. The interactive application should first prompt the user for the user's credentials. This authentication method should only be used for Management applications.

Connect to Media Services API

Copy your credentials to connect your user application from the Connect to Media Services API section. You can get text values or copy the JSON or XML blocks.

Get help and support

You can contact Media Services with questions or follow our updates by one of the following methods: