OpenId Connect Provider - List By Service
Lists of all the OpenId Connect Providers.
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders?api-version=2021-08-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2021-08-01
URI Parameters
Name | In | Required | Type | Description |
---|---|---|---|---|
resource
|
path | True |
string |
The name of the resource group. |
service
|
path | True |
string |
The name of the API Management service. Regex pattern: |
subscription
|
path | True |
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
api-version
|
query | True |
string |
Version of the API to be used with the client request. |
$filter
|
query |
string |
| Field | Usage | Supported operators | Supported functions | |
|
$skip
|
query |
integer int32 |
Number of records to skip. |
|
$top
|
query |
integer int32 |
Number of records to return. |
Responses
Name | Type | Description |
---|---|---|
200 OK |
Lists of all the OpenId Connect Providers. |
|
Other Status Codes |
Error response describing why the operation failed. |
Security
azure_auth
Azure Active Directory OAuth2 Flow.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Name | Description |
---|---|
user_impersonation | impersonate your user account |
Examples
ApiManagementListOpenIdConnectProviders
Sample request
Sample response
{
"value": [
{
"id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/openidConnectProviders/templateOpenIdConnect2",
"type": "Microsoft.ApiManagement/service/openidconnectproviders",
"name": "templateOpenIdConnect2",
"properties": {
"displayName": "templateoidprovider2",
"description": "open id provider template2",
"metadataEndpoint": "https://oidprovider-template2.net",
"clientId": "oidprovidertemplate2"
}
}
],
"count": 1,
"nextLink": ""
}
Definitions
Name | Description |
---|---|
Error |
Error Field contract. |
Error |
Error Response. |
Open |
Paged OpenIdProviders list representation. |
Openid |
OpenId Connect Provider details. |
ErrorFieldContract
Error Field contract.
Name | Type | Description |
---|---|---|
code |
string |
Property level error code. |
message |
string |
Human-readable representation of property-level error. |
target |
string |
Property name. |
ErrorResponse
Error Response.
Name | Type | Description |
---|---|---|
error.code |
string |
Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. |
error.details |
The list of invalid fields send in request, in case of validation error. |
|
error.message |
string |
Human-readable representation of the error. |
OpenIdConnectProviderCollection
Paged OpenIdProviders list representation.
Name | Type | Description |
---|---|---|
count |
integer |
Total record count number across all pages. |
nextLink |
string |
Next page link if any. |
value |
Page values. |
OpenidConnectProviderContract
OpenId Connect Provider details.
Name | Type | Description |
---|---|---|
id |
string |
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} |
name |
string |
The name of the resource |
properties.clientId |
string |
Client ID of developer console which is the client application. |
properties.clientSecret |
string |
Client Secret of developer console which is the client application. |
properties.description |
string |
User-friendly description of OpenID Connect Provider. |
properties.displayName |
string |
User-friendly OpenID Connect Provider name. |
properties.metadataEndpoint |
string |
Metadata endpoint URI. |
type |
string |
The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts" |