APIHub
Back to Explore

ApiManagementClient

Use these REST APIs for performing operations on Identity Provider entity associated with your Azure API Management deployment. Setting up an external Identity Provider for authentication can help you manage the developer portal logins using the OAuth2 flow.

Cloud
OAuth
HTTPS
CORS: Unknown
Visit official documentation

Latency

Not monitored yet

Uptime

Not monitored yet

Playground

Verified

live

Endpoints

REST · JSON
GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders

Lists a collection of Identity Provider configured in the specified service instance.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}

Deletes the specified identity provider configuration.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • identityProviderName (path, required) — Identity Provider Type identifier.
  • If-Match (header, required) — ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}

Gets the configuration details of the identity Provider configured in specified service instance.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • identityProviderName (path, required) — Identity Provider Type identifier.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
HEAD

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}

Gets the entity state (Etag) version of the identityProvider specified by its identifier.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • identityProviderName (path, required) — Identity Provider Type identifier.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
PATCH

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}

Updates an existing IdentityProvider configuration.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • identityProviderName (path, required) — Identity Provider Type identifier.
  • If-Match (header, required) — ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}

Creates or Updates the IdentityProvider configuration.

  • resourceGroupName (path, required) — The name of the resource group.
  • serviceName (path, required) — The name of the API Management service.
  • identityProviderName (path, required) — Identity Provider Type identifier.
  • If-Match (header) — ETag of the Entity. Not required when creating an entity, but required when updating an entity.
  • api-version (query, required) — Version of the API to be used with the client request.
  • subscriptionId (path, required) — Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

6 endpoints auto-detected

Authentication

This API requires authentication: OAuth.

curl -X GET \
  "https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders"

management.azure.com · HTTPS only