diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/apimapis.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/apimapis.json index a17597e9a513..f71ba315f1b2 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/apimapis.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/apimapis.json @@ -243,6 +243,9 @@ "ApiManagementCreateApiWithMultipleAuthServers": { "$ref": "./examples/ApiManagementCreateApiWithMultipleAuthServers.json" }, + "ApiManagementCreateApiWithMultipleOpenIdConnectProviders": { + "$ref": "./examples/ApiManagementCreateApiWithMultipleOpenIdConnectProviders.json" + }, "ApiManagementCreateWebSocketApi": { "$ref": "./examples/ApiManagementCreateWebsocketApi.json" }, diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/definitions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/definitions.json index 12c6e6a13c51..2003ecdaa262 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/definitions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/definitions.json @@ -1135,6 +1135,16 @@ "authorizationServerId" ], "description": "Collection of OAuth2 authentication settings included into this API." + }, + "openidAuthenticationSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/OpenIdAuthenticationSettingsContract" + }, + "x-ms-identifiers": [ + "openidProviderId" + ], + "description": "Collection of Open ID Connect authentication settings included into this API." } }, "description": "API Authentication Settings." @@ -3734,6 +3744,14 @@ "x-ms-secret": true, "type": "string", "description": "Client Secret of developer console which is the client application." + }, + "useInTestConsole": { + "type": "boolean", + "description": "If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided." + }, + "useInApiDocumentation": { + "type": "boolean", + "description": "If true, the Open ID Connect provider will be used in the API documentation in the developer portal. False by default if no value is provided." } }, "required": [ @@ -3776,6 +3794,14 @@ "x-ms-secret": true, "type": "string", "description": "Client Secret of developer console which is the client application." + }, + "useInTestConsole": { + "type": "boolean", + "description": "If true, the Open ID Connect provider may be used in the developer portal test console. True by default if no value is provided." + }, + "useInApiDocumentation": { + "type": "boolean", + "description": "If true, the Open ID Connect provider will be used in the API documentation in the developer portal. False by default if no value is provided." } }, "description": "Parameters supplied to the Update OpenID Connect Provider operation." diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/examples/ApiManagementCreateApiWithMultipleOpenIdConnectProviders.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/examples/ApiManagementCreateApiWithMultipleOpenIdConnectProviders.json new file mode 100644 index 000000000000..abdcac13c815 --- /dev/null +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/examples/ApiManagementCreateApiWithMultipleOpenIdConnectProviders.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "serviceName": "apimService1", + "resourceGroupName": "rg1", + "api-version": "2022-04-01-preview", + "subscriptionId": "subid", + "apiId": "tempgroup", + "parameters": { + "properties": { + "description": "apidescription5200", + "authenticationSettings": { + "openidAuthenticationSettings": [ + { + "openidProviderId": "openidProviderId2283", + "bearerTokenSendingMethods": [ + "authorizationHeader" + ] + }, + { + "openidProviderId": "openidProviderId2284", + "bearerTokenSendingMethods": [ + "authorizationHeader" + ] + } + ] + }, + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + }, + "displayName": "apiname1463", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "path": "newapiPath", + "protocols": [ + "https", + "http" + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "name": "apiid9419", + "properties": { + "displayName": "apiname1463", + "apiRevision": "1", + "description": "apidescription5200", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "path": "newapiPath", + "protocols": [ + "http", + "https" + ], + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + }, + "isCurrent": true, + "isOnline": true + } + } + }, + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/tempgroup?api-version=2022-04-01-preview&asyncId=5c730e343244df1b9cb56e85&asyncCode=201" + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/apiid9419", + "type": "Microsoft.ApiManagement/service/apis", + "name": "apiid9419", + "properties": { + "displayName": "apiname1463", + "apiRevision": "1", + "description": "apidescription5200", + "serviceUrl": "http://newechoapi.cloudapp.net/api", + "path": "newapiPath", + "protocols": [ + "http", + "https" + ], + "authenticationSettings": { + "openid": { + "openidProviderId": "openidProviderId2283", + "bearerTokenSendingMethods": [ + "authorizationHeader" + ] + }, + "openidAuthenticationSettings": [ + { + "openidProviderId": "openidProviderId2283", + "bearerTokenSendingMethods": [ + "authorizationHeader" + ] + }, + { + "openidProviderId": "openidProviderId2284", + "bearerTokenSendingMethods": [ + "authorizationHeader" + ] + } + ] + }, + "subscriptionKeyParameterNames": { + "header": "header4520", + "query": "query3037" + }, + "isCurrent": true, + "isOnline": true + } + } + } + } +} diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/examples/ApiManagementCreateOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/examples/ApiManagementCreateOpenIdConnectProvider.json index 8edcf812ea79..8777ca9512e7 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/examples/ApiManagementCreateOpenIdConnectProvider.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/examples/ApiManagementCreateOpenIdConnectProvider.json @@ -10,7 +10,9 @@ "displayName": "templateoidprovider3", "metadataEndpoint": "https://oidprovider-template3.net", "clientId": "oidprovidertemplate3", - "clientSecret": "x" + "clientSecret": "x", + "useInTestConsole": false, + "useInApiDocumentation": true } } }, @@ -23,7 +25,9 @@ "properties": { "displayName": "templateoidprovider3", "metadataEndpoint": "https://oidprovider-template3.net", - "clientId": "oidprovidertemplate3" + "clientId": "oidprovidertemplate3", + "useInTestConsole": false, + "useInApiDocumentation": true } } }, @@ -35,7 +39,9 @@ "properties": { "displayName": "templateoidprovider3", "metadataEndpoint": "https://oidprovider-template3.net", - "clientId": "oidprovidertemplate3" + "clientId": "oidprovidertemplate3", + "useInTestConsole": false, + "useInApiDocumentation": true } } } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/examples/ApiManagementGetOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/examples/ApiManagementGetOpenIdConnectProvider.json index a914d18aaca2..3c59e64564fe 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/examples/ApiManagementGetOpenIdConnectProvider.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/examples/ApiManagementGetOpenIdConnectProvider.json @@ -16,7 +16,9 @@ "displayName": "templateoidprovider2", "description": "open id provider template2", "metadataEndpoint": "https://oidprovider-template2.net", - "clientId": "oidprovidertemplate2" + "clientId": "oidprovidertemplate2", + "useInTestConsole": false, + "useInApiDocumentation": true } } } diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/examples/ApiManagementListOpenIdConnectProviders.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/examples/ApiManagementListOpenIdConnectProviders.json index 54e73c7075d5..4418e3045ef1 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/examples/ApiManagementListOpenIdConnectProviders.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/examples/ApiManagementListOpenIdConnectProviders.json @@ -17,7 +17,9 @@ "displayName": "templateoidprovider2", "description": "open id provider template2", "metadataEndpoint": "https://oidprovider-template2.net", - "clientId": "oidprovidertemplate2" + "clientId": "oidprovidertemplate2", + "useInTestConsole": false, + "useInApiDocumentation": true } } ], diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/examples/ApiManagementUpdateOpenIdConnectProvider.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/examples/ApiManagementUpdateOpenIdConnectProvider.json index 1c501332b81d..73e16a55c535 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/examples/ApiManagementUpdateOpenIdConnectProvider.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/examples/ApiManagementUpdateOpenIdConnectProvider.json @@ -8,7 +8,9 @@ "If-Match": "*", "parameters": { "properties": { - "clientSecret": "updatedsecret" + "clientSecret": "updatedsecret", + "useInTestConsole": false, + "useInApiDocumentation": true } } }, @@ -22,7 +24,9 @@ "displayName": "templateoidprovider2", "description": "open id provider template2", "metadataEndpoint": "https://oidprovider-template2.net", - "clientId": "oidprovidertemplate2" + "clientId": "oidprovidertemplate2", + "useInTestConsole": false, + "useInApiDocumentation": true } } }