openapi-directory/api/azure.com/apimanagement-apimopenidconnectproviders.json

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

{"openapi":"3.0.0","info":{"description":"Use these REST APIs for performing operations on OpenId Connect Provider entity associated with your Azure API Management deployment. API Management allows you to access APIs secured with token from [OpenID Connect Provider ](http://openid.net/connect/) to be accessed from the Developer Console.","title":"ApiManagementClient","version":"2016-10-10","x-apisguru-categories":["cloud"],"x-logo":{"url":"https://assets.onestore.ms/cdnfiles/onestorerolling-1606-01000/shell/v3/images/logo/microsoft.png"},"x-origin":[{"format":"swagger","url":"https://raw.githubusercontent.com/Azure/azure-rest-api-specs/master/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2016-10-10/apimopenidconnectproviders.json","version":"2.0"}],"x-preferred":true,"x-providerName":"azure.com","x-serviceName":"apimanagement-apimopenidconnectproviders","x-tags":["Azure","Microsoft"]},"security":[{"azure_auth":["user_impersonation"]}],"paths":{"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders":{"get":{"description":"Lists all OpenID Connect Providers.","operationId":"OpenIdConnectProviders_ListByService","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"}},{"description":"| Field | Supported operators    | Supported functions                         |\n|-------|------------------------|---------------------------------------------|\n| id    | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |\n| name  | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith |","in":"query","name":"$filter","required":false,"schema":{"type":"string"}},{"description":"Number of records to return.","in":"query","name":"$top","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":1}},{"description":"Number of records to skip.","in":"query","name":"$skip","required":false,"x-ms-parameter-location":"method","schema":{"type":"integer","format":"int32","minimum":0}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Lists of all the OpenId Connect Providers.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenIdConnectProviderCollection"}}}}},"tags":["OpenIdConnectProviders"],"x-ms-odata":"#/components/schemas/OpenidConnectProviderContract","x-ms-pageable":{"nextLinkName":"nextLink"}}},"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}":{"delete":{"description":"Deletes specific OpenID Connect Provider of the API Management service instance.","operationId":"OpenIdConnectProviders_Delete","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"}},{"$ref":"#/components/parameters/OpenIdConnectIdParameter"},{"description":"The entity state (Etag) version of the OpenID Connect Provider to delete. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","in":"header","name":"If-Match","required":true,"schema":{"type":"string"}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"}}],"responses":{"204":{"description":"OpenId Connect Provider was successfully deleted."},"405":{"description":"The specified OpenIdConnect Provider cannot be deleted because it is in use in a policy. You must remove all references to this property before it can be deleted.","content":{"application/json":{"schema":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}},"tags":["OpenIdConnectProviders"]},"get":{"description":"Gets specific OpenID Connect Provider.","operationId":"OpenIdConnectProviders_Get","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"}},{"$ref":"#/components/parameters/OpenIdConnectIdParameter"},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"The response body contains the specified OpenId Connect Provider entity.","headers":{"ETag":{"description":"Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenidConnectProviderContract"}}}},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}},"tags":["OpenIdConnectProviders"]},"patch":{"description":"Updates the specific OpenID Connect Provider.","operationId":"OpenIdConnectProviders_Update","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"}},{"$ref":"#/components/parameters/OpenIdConnectIdParameter"},{"description":"The entity state (Etag) version of the OpenID Connect Provider to update. A value of \"*\" can be used for If-Match to unconditionally apply the operation.","in":"header","name":"If-Match","required":true,"schema":{"type":"string"}},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenidConnectProviderUpdateContract"}}},"description":"Update parameters.","required":true},"responses":{"204":{"description":"OpenId Connect Provider was successfully updated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}},"tags":["OpenIdConnectProviders"]},"put":{"description":"Creates or updates the OpenID Connect Provider.","operationId":"OpenIdConnectProviders_CreateOrUpdate","parameters":[{"description":"The name of the resource group.","in":"path","name":"resourceGroupName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string"}},{"description":"The name of the API Management service.","in":"path","name":"serviceName","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","minLength":1,"maxLength":50,"pattern":"^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$"}},{"$ref":"#/components/parameters/OpenIdConnectIdParameter"},{"description":"Version of the API to be used with the client request.","in":"query","name":"api-version","required":true,"schema":{"type":"string"}},{"description":"Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.","in":"path","name":"subscriptionId","required":true,"schema":{"type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/OpenidConnectProviderCreateContract"}}},"description":"Create parameters.","required":true},"responses":{"201":{"description":"OpenIdConnect Provider was successfully created."},"204":{"description":"OpenIdConnect Provider was successfully updated."},"default":{"description":"Error response describing why the operation failed.","content":{"application/json":{"schema":{"description":"Error Body contract.","properties":{"code":{"description":"Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.","type":"string"},"details":{"description":"The list of invalid fields send in request, in case of validation error.","items":{"description":"Error Field contract.","properties":{"code":{"description":"Property level error code.","type":"string"},"message":{"description":"Human-readable representation of property-level error.","type":"string"},"target":{"description":"Property name.","type":"string"}}},"type":"array"},"message":{"description":"Human-readable representation of the error.","type":"string"}}}}}}},"tags":["OpenIdConnectProviders"]}}},"servers":[{"url":"https://management.azure.com"}],"components":{"parameters":{"OpenIdConnectIdParameter":{"description":"Identifier of the OpenID Connect Provider.","in":"path","name":"opid","required":true,"x-ms-parameter-location":"method","schema":{"type":"string","maxLength":256,"pattern":"^[^*#&+:<>?]+$"}}},"securitySchemes":{"azure_auth":{"description":"Azure Active Directory OAuth2 Flow.","type":"oauth2","flows":{"implicit":{"authorizationUrl":"https://login.microsoftonline.com/common/oauth2/authorize","scopes":{"user_impersonation":"impersonate your user account"}}}}},"schemas":{"OpenIdConnectProviderCollection":{"description":"Paged OpenIdProviders list representation.","properties":{"count":{"description":"Total record count number across all pages.","format":"int64","type":"integer"},"nextLink":{"description":"Next page link if any.","type":"string"},"value":{"description":"Page values.","items":{"$ref":"#/components/schemas/OpenidConnectProviderContract"},"type":"array"}}},"OpenidConnectProviderContract":{"description":"OpenID Connect Providers Contract.","properties":{"clientId":{"description":"Client ID of developer console which is the client application.","type":"string"},"clientSecret":{"description":"Client Secret of developer console which is the client application.","type":"string"},"description":{"description":"User-friendly description of OpenID Connect Provider.","type":"string"},"id":{"description":"OpenID Connect Provider identifier.","type":"string"},"metadataEndpoint":{"description":"Metadata endpoint URI.","type":"string"},"name":{"description":"User-friendly OpenID Connect Provider name.","maxLength":50,"type":"string"}},"required":["name","metadataEndpoint","clientId"]},"OpenidConnectProviderCreateContract":{"description":"Parameters supplied to the Create OpenID Connect Provider operation.","properties":{"clientId":{"description":"Client ID of developer console which is the client application.","type":"string"},"clientSecret":{"description":"Client Secret of developer console which is the client application.","type":"string"},"description":{"description":"User-friendly description of OpenID Connect Provider.","type":"string"},"metadataEndpoint":{"description":"Metadata endpoint URI.","type":"string"},"name":{"description":"User-friendly OpenID Connect Provider name.","maxLength":50,"type":"string"}},"required":["name","metadataEndpoint","clientId"]},"OpenidConnectProviderUpdateContract":{"description":"Parameters supplied to the Update OpenID Connect Provider operation.","properties":{"clientId":{"description":"Client ID of developer console which is the client application.","type":"string"},"clientSecret":{"description":"Client Secret of developer console which is the client application.","type":"string"},"description":{"description":"User-friendly description of OpenID Connect Provider.","type":"string"},"metadataEndpoint":{"description":"Metadata endpoint URI.","type":"string"},"name":{"description":"User-friendly OpenID Connect Provider name.","maxLength":50,"type":"string"}}}}}}