Skip to content

APIM Auth Servers #19234

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tianxchen-ms merged 6 commits into from
Jun 28, 2022
Merged

APIM Auth Servers #19234

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
c79557f
APIM Auth Servers
May 26, 2022
4b28c7d
adding x-ms-identifiers
May 26, 2022
220fb54
removing some weird, invisible special char
May 26, 2022
6950f91
formatting
May 26, 2022
ce2d39d
oAuth2AuthenticationSettings moved to AuthSettings
Jun 1, 2022
725ce4d
Formatting
Jun 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions ...agement/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/apimapis.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -237,6 +237,9 @@
"ApiManagementCreateApi": {
"$ref": "./examples/ApiManagementCreateApi.json"
},
"ApiManagementCreateApiWithMultipleAuthServers": {
"$ref": "./examples/ApiManagementCreateApiWithMultipleAuthServers.json"
},
"ApiManagementCreateWebSocketApi": {
"$ref": "./examples/ApiManagementCreateWebsocketApi.json"
},
Expand Down
26 changes: 26 additions & 0 deletions ...ment/resource-manager/Microsoft.ApiManagement/preview/2022-04-01-preview/definitions.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1082,6 +1082,16 @@
"openid": {
"$ref": "#/definitions/OpenIdAuthenticationSettingsContract",
"description": "OpenID Connect Authentication Settings"
},
"oAuth2AuthenticationSettings": {
"type": "array",
"items": {
"$ref": "#/definitions/OAuth2AuthenticationSettingsContract"
},
"x-ms-identifiers": [
"authorizationServerId"
],
"description": "Collection of OAuth2 authentication settings included into this API."
}
},
"description": "API Authentication Settings."
Expand Down Expand Up @@ -1242,6 +1252,14 @@
"minLength": 1,
"maxLength": 50
},
"useInTestConsole": {
"type": "boolean",
"description": "If true, the authorization server may be used in the developer portal test console. True by default if no value is provided."
},
"useInApiDocumentation": {
"type": "boolean",
"description": "If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided."
},
"clientRegistrationEndpoint": {
"type": "string",
"description": "Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced."
Expand Down Expand Up @@ -1335,6 +1353,14 @@
"minLength": 1,
"maxLength": 50
},
"useInTestConsole": {
"type": "boolean",
"description": "If true, the authorization server may be used in the developer portal test console. True by default if no value is provided."
},
"useInApiDocumentation": {
"type": "boolean",
"description": "If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided."
},
"clientRegistrationEndpoint": {
"type": "string",
"description": "Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced."
Expand Down
16 changes: 14 additions & 2 deletions ...r/Microsoft.ApiManagement/preview/2022-04-01-preview/examples/ApiManagementCreateApi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,13 @@
"oAuth2": {
"authorizationServerId": "authorizationServerId2283",
"scope": "oauth2scope2580"
}
},
"oAuth2AuthenticationSettings": [
{
"authorizationServerId": "authorizationServerId2283",
"scope": "oauth2scope2580"
}
]
},
"subscriptionKeyParameterNames": {
"header": "header4520",
Expand Down Expand Up @@ -83,7 +89,13 @@
"oAuth2": {
"authorizationServerId": "authorizationServerId2283",
"scope": "oauth2scope2580"
}
},
"oAuth2AuthenticationSettings": [
{
"authorizationServerId": "authorizationServerId2283",
"scope": "oauth2scope2580"
}
]
},
"subscriptionKeyParameterNames": {
"header": "header4520",
Expand Down
108 changes: 108 additions & 0 deletions ...nt/preview/2022-04-01-preview/examples/ApiManagementCreateApiWithMultipleAuthServers.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
{
"parameters": {
"serviceName": "apimService1",
"resourceGroupName": "rg1",
"api-version": "2022-04-01-preview",
"subscriptionId": "subid",
"apiId": "tempgroup",
"parameters": {
"properties": {
"description": "apidescription5200",
"authenticationSettings": {
"oAuth2AuthenticationSettings": [
{
"authorizationServerId": "authorizationServerId2283",
"scope": "oauth2scope2580"
},
{
"authorizationServerId": "authorizationServerId2284",
"scope": "oauth2scope2581"
}
]
},
"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": {
"oAuth2": {
"authorizationServerId": "authorizationServerId2283",
"scope": "oauth2scope2580"
},
"oAuth2AuthenticationSettings": [
{
"authorizationServerId": "authorizationServerId2283",
"scope": "oauth2scope2580"
},
{
"authorizationServerId": "authorizationServerId2284",
"scope": "oauth2scope2581"
}
]
},
"subscriptionKeyParameterNames": {
"header": "header4520",
"query": "query3037"
},
"isCurrent": true,
"isOnline": true
}
}
}
}
}
6 changes: 6 additions & 0 deletions ...anagement/preview/2022-04-01-preview/examples/ApiManagementCreateAuthorizationServer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@
"parameters": {
"properties": {
"displayName": "test2",
"useInTestConsole": false,
"useInApiDocumentation": true,
"description": "test server",
"clientRegistrationEndpoint": "https://www.contoso.com/apps",
"authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
Expand Down Expand Up @@ -39,6 +41,8 @@
"name": "newauthServer",
"properties": {
"displayName": "test2",
"useInTestConsole": false,
"useInApiDocumentation": true,
"description": "test server",
"clientRegistrationEndpoint": "https://www.contoso.com/apps",
"authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
Expand Down Expand Up @@ -68,6 +72,8 @@
"name": "newauthServer",
"properties": {
"displayName": "test2",
"useInTestConsole": false,
"useInApiDocumentation": true,
"description": "test server",
"clientRegistrationEndpoint": "https://www.contoso.com/apps",
"authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
Expand Down
16 changes: 16 additions & 0 deletions ...rosoft.ApiManagement/preview/2022-04-01-preview/examples/ApiManagementGetApiContract.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,22 @@
"protocols": [
"https"
],
"authenticationSettings": {
"oAuth2": {
"authorizationServerId": "authorizationServerId2283",
"scope": "oauth2scope2580"
},
"oAuth2AuthenticationSettings": [
{
"authorizationServerId": "authorizationServerId2283",
"scope": "oauth2scope2580"
},
{
"authorizationServerId": "authorizationServerId2284",
"scope": "oauth2scope2581"
}
]
},
"subscriptionKeyParameterNames": {
"header": "Ocp-Apim-Subscription-Key",
"query": "subscription-key"
Expand Down
16 changes: 16 additions & 0 deletions ...rosoft.ApiManagement/preview/2022-04-01-preview/examples/ApiManagementGetApiRevision.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,22 @@
"protocols": [
"https"
],
"authenticationSettings": {
"oAuth2": {
"authorizationServerId": "authorizationServerId2283",
"scope": "oauth2scope2580"
},
"oAuth2AuthenticationSettings": [
{
"authorizationServerId": "authorizationServerId2283",
"scope": "oauth2scope2580"
},
{
"authorizationServerId": "authorizationServerId2284",
"scope": "oauth2scope2581"
}
]
},
"subscriptionKeyParameterNames": {
"header": "Ocp-Apim-Subscription-Key",
"query": "subscription-key"
Expand Down
2 changes: 2 additions & 0 deletions ...piManagement/preview/2022-04-01-preview/examples/ApiManagementGetAuthorizationServer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@
"name": "newauthServer2",
"properties": {
"displayName": "test3",
"useInTestConsole": false,
"useInApiDocumentation": true,
"description": "test server",
"clientRegistrationEndpoint": "https://www.contoso.com/apps",
"authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
Expand Down
4 changes: 4 additions & 0 deletions ...Management/preview/2022-04-01-preview/examples/ApiManagementListAuthorizationServers.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@
"name": "newauthServer",
"properties": {
"displayName": "test2",
"useInTestConsole": true,
"useInApiDocumentation": false,
"description": "test server",
"clientRegistrationEndpoint": "https://www.contoso.com/apps",
"authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
Expand Down Expand Up @@ -42,6 +44,8 @@
"name": "newauthServer2",
"properties": {
"displayName": "test3",
"useInTestConsole": false,
"useInApiDocumentation": true,
"description": "test server",
"clientRegistrationEndpoint": "https://www.contoso.com/apps",
"authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
Expand Down
6 changes: 5 additions & 1 deletion ...anagement/preview/2022-04-01-preview/examples/ApiManagementUpdateAuthorizationServer.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,9 @@
"parameters": {
"properties": {
"clientId": "update",
"clientSecret": "updated"
"clientSecret": "updated",
"useInTestConsole": false,
"useInApiDocumentation": true
}
}
},
Expand All @@ -21,6 +23,8 @@
"name": "newauthServer",
"properties": {
"displayName": "test3",
"useInTestConsole": false,
"useInApiDocumentation": true,
"description": "test server",
"clientRegistrationEndpoint": "https://www.contoso.com/apps",
"authorizationEndpoint": "https://www.contoso.com/oauth2/auth",
Expand Down