{ "opencollection": "1.0.0", "info": { "name": "Microsoft Azure AccessControlClient AccessConnector Certificates API", "version": "2020-08-01-preview" }, "items": [ { "info": { "name": "Certificates", "type": "folder" }, "items": [ { "info": { "name": "Microsoft Azure Lists All Of The Certificates That Have Been Added To The Specified Account", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/certificates", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\"." }, { "name": "maxresults", "value": "", "type": "query", "description": "The maximum number of items to return in the response. A maximum of 1000\napplications can be returned." }, { "name": "$filter", "value": "", "type": "query", "description": "An OData $filter clause. For more information on constructing this filter, see\nhttps://docs.microsoft.com/en-us/rest/api/batchservice/odata-filters-in-batch#list-certificates." }, { "name": "$select", "value": "", "type": "query", "description": "An OData $select clause." } ] }, "docs": "Lists all of the Certificates that have been added to the specified Account." }, { "info": { "name": "Microsoft Azure Creates A Certificate To The Specified Account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/certificates", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The API version to use for this operation." }, { "name": "timeOut", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds. If the value is larger than 30, the default will be used instead.\"." } ] }, "docs": "Creates a Certificate to the specified Account." }, { "info": { "name": "Microsoft Azure Create a Certificate", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/certificates/:certificate-name/create", "params": [ { "name": "certificate-name", "value": "example_value", "type": "path", "description": "The name of the certificate." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API version." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new certificate. If this is the first version, the certificate resource is created. This operation requires the certificates/create permission." }, { "info": { "name": "Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Certificates", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/certificates", "params": [ { "name": "$filter", "value": "", "type": "query", "description": "Filter the result list using the given expression" }, { "name": "$top", "value": "", "type": "query", "description": "The number of result items to return." }, { "name": "$skip", "value": "", "type": "query", "description": "The number of result items to skip." }, { "name": "$maxpagesize", "value": "", "type": "query", "description": "The maximum number of result items per page." }, { "name": "catalogName", "value": "", "type": "path", "description": "Name of catalog" } ] }, "docs": "List Certificate resources by Catalog" }, { "info": { "name": "Get Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Certificates Serialnumber", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/certificates/:serialNumber", "params": [ { "name": "catalogName", "value": "", "type": "path", "description": "Name of catalog" }, { "name": "serialNumber", "value": "", "type": "path", "description": "Serial number of the certificate. Use '.default' to get current active certificate." } ] }, "docs": "Get a Certificate" }, { "info": { "name": "Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Certificates Serialnumber Retrievecertchain", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/certificates/:serialNumber/retrieveCertChain", "params": [ { "name": "catalogName", "value": "", "type": "path", "description": "Name of catalog" }, { "name": "serialNumber", "value": "", "type": "path", "description": "Serial number of the certificate. Use '.default' to get current active certificate." } ] }, "docs": "Retrieves cert chain." }, { "info": { "name": "Post Subscriptions Subscriptionid Resourcegroups Resourcegroupname Providers Microsoft Azuresphere Catalogs Catalogname Certificates Serialnumber Retrieveproofofpossessionnonce", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.AzureSphere/catalogs/:catalogName/certificates/:serialNumber/retrieveProofOfPossessionNonce", "params": [ { "name": "catalogName", "value": "", "type": "path", "description": "Name of catalog" }, { "name": "serialNumber", "value": "", "type": "path", "description": "Serial number of the certificate. Use '.default' to get current active certificate." } ] }, "docs": "Gets the proof of possession nonce." }, { "info": { "name": "Microsoft Azure Cancels A Failed Deletion Of A Certificate From The Specified Account", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/certificates(thumbprintAlgorithm=:thumbprintAlgorithm,thumbprint=:thumbprint)/canceldelete", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "thumbprintAlgorithm", "value": "", "type": "path", "description": "The algorithm used to derive the thumbprint parameter. This must be sha1." }, { "name": "thumbprint", "value": "", "type": "path", "description": "The thumbprint of the Certificate being deleted." }, { "name": "timeout", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API Version." } ] }, "docs": "If you try to delete a Certificate that is being used by a Pool or Compute Node, the status of the Certificate changes to deleteFailed. If you decide that you want to continue using the Certificate, you can use this operation to set the status of the Certificate back to active. If you intend to delete the Certificate, you do not need to run this operation after the deletion failed. You must make sure that the Certificate is not being used by any resources, and then you can try again to delete th" }, { "info": { "name": "Microsoft Azure Get Certificates Thumbprintalgorithm Thumbprintalgorithm,thumbprint Thumbprint", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/certificates(thumbprintAlgorithm=:thumbprintAlgorithm,thumbprint=:thumbprint)", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "thumbprintAlgorithm", "value": "", "type": "path", "description": "The algorithm used to derive the thumbprint parameter. This must be sha1." }, { "name": "thumbprint", "value": "", "type": "path", "description": "The thumbprint of the Certificate to get." }, { "name": "$select", "value": "", "type": "query", "description": "An OData $select clause." }, { "name": "timeout", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API Version." } ] }, "docs": "Gets information about the specified Certificate." }, { "info": { "name": "Microsoft Azure Deletes A Certificate From The Specified Account", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/certificates(thumbprintAlgorithm=:thumbprintAlgorithm,thumbprint=:thumbprint)", "headers": [ { "name": "client-request-id", "value": "" }, { "name": "return-client-request-id", "value": "" }, { "name": "ocp-date", "value": "" } ], "params": [ { "name": "thumbprintAlgorithm", "value": "", "type": "path", "description": "The algorithm used to derive the thumbprint parameter. This must be sha1." }, { "name": "thumbprint", "value": "", "type": "path", "description": "The thumbprint of the Certificate to be deleted." }, { "name": "timeout", "value": "", "type": "query", "description": "The maximum time that the server can spend processing the request, in seconds. The default is 30 seconds." }, { "name": "api-version", "value": "", "type": "query", "description": "Client API Version." } ] }, "docs": "You cannot delete a Certificate if a resource (Pool or Compute Node) is using it. Before you can delete a Certificate, you must therefore make sure that the Certificate is not associated with any existing Pools, the Certificate is not installed on any Nodes (even if you remove a Certificate from a Pool, it is not removed from existing Compute Nodes in that Pool until they restart), and no running Tasks depend on the Certificate. If you try to delete a Certificate that is in use, the deletion fai" }, { "info": { "name": "Microsoft Azure Get All Certificates For A Subscription", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/providers/Microsoft.Web/certificates", "params": [ { "name": "subscriptionId", "value": "", "type": "path", "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)." }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" }, { "name": "$filter", "value": "", "type": "query", "description": "Return only information specified in the filter (using OData syntax). For example: $filter=KeyVaultId eq 'KeyVaultId'" } ] }, "docs": "Description for Get all certificates for a subscription." }, { "info": { "name": "Microsoft Azure Get All Certificates In A Resource Group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/certificates", "params": [ { "name": "resourceGroupName", "value": "", "type": "path", "description": "Name of the resource group to which the resource belongs." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)." }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Description for Get all certificates in a resource group." }, { "info": { "name": "Microsoft Azure Get A Certificate", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/certificates/:name", "params": [ { "name": "resourceGroupName", "value": "", "type": "path", "description": "Name of the resource group to which the resource belongs." }, { "name": "name", "value": "", "type": "path", "description": "Name of the certificate." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)." }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Description for Get a certificate." }, { "info": { "name": "Microsoft Azure Create Or Update A Certificate", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/certificates/:name", "params": [ { "name": "resourceGroupName", "value": "", "type": "path", "description": "Name of the resource group to which the resource belongs." }, { "name": "name", "value": "", "type": "path", "description": "Name of the certificate." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)." }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Description for Create or update a certificate." }, { "info": { "name": "Microsoft Azure Create Or Update A Certificate", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/certificates/:name", "params": [ { "name": "resourceGroupName", "value": "", "type": "path", "description": "Name of the resource group to which the resource belongs." }, { "name": "name", "value": "", "type": "path", "description": "Name of the certificate." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)." }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Description for Create or update a certificate." }, { "info": { "name": "Microsoft Azure Delete A Certificate", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/certificates/:name", "params": [ { "name": "resourceGroupName", "value": "", "type": "path", "description": "Name of the resource group to which the resource belongs." }, { "name": "name", "value": "", "type": "path", "description": "Name of the certificate." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)." }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Description for Delete a certificate." }, { "info": { "name": "Microsoft Azure Get The Certificate List", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceName/certificates", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription identifier." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group that contains the IoT hub." }, { "name": "resourceName", "value": "", "type": "path", "description": "The name of the IoT hub." } ] }, "docs": "Returns the list of certificates." }, { "info": { "name": "Microsoft Azure Get The Certificate", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceName/certificates/:certificateName", "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription identifier." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group that contains the IoT hub." }, { "name": "resourceName", "value": "", "type": "path", "description": "The name of the IoT hub." }, { "name": "certificateName", "value": "", "type": "path", "description": "The name of the certificate" } ] }, "docs": "Returns the certificate." }, { "info": { "name": "Microsoft Azure Upload The Certificate To The Iot Hub", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceName/certificates/:certificateName", "headers": [ { "name": "If-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription identifier." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group that contains the IoT hub." }, { "name": "resourceName", "value": "", "type": "path", "description": "The name of the IoT hub." }, { "name": "certificateName", "value": "", "type": "path", "description": "The name of the certificate" } ] }, "docs": "Adds new or replaces existing certificate." }, { "info": { "name": "Microsoft Azure Delete An X509 Certificate", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceName/certificates/:certificateName", "headers": [ { "name": "If-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription identifier." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group that contains the IoT hub." }, { "name": "resourceName", "value": "", "type": "path", "description": "The name of the IoT hub." }, { "name": "certificateName", "value": "", "type": "path", "description": "The name of the certificate" } ] }, "docs": "Deletes an existing X509 certificate or does nothing if it does not exist." }, { "info": { "name": "Microsoft Azure Generate Verification Code For Proof Of Possession Flow", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceName/certificates/:certificateName/generateVerificationCode", "headers": [ { "name": "If-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription identifier." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group that contains the IoT hub." }, { "name": "resourceName", "value": "", "type": "path", "description": "The name of the IoT hub." }, { "name": "certificateName", "value": "", "type": "path", "description": "The name of the certificate" } ] }, "docs": "Generates verification code for proof of possession flow. The verification code will be used to generate a leaf certificate." }, { "info": { "name": "Microsoft Azure Verify Certificate S Private Key Possession", "type": "http" }, "http": { "method": "POST", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Devices/IotHubs/:resourceName/certificates/:certificateName/verify", "headers": [ { "name": "If-Match", "value": "" } ], "params": [ { "name": "api-version", "value": "", "type": "query", "description": "The version of the API." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "The subscription identifier." }, { "name": "resourceGroupName", "value": "", "type": "path", "description": "The name of the resource group that contains the IoT hub." }, { "name": "resourceName", "value": "", "type": "path", "description": "The name of the IoT hub." }, { "name": "certificateName", "value": "", "type": "path", "description": "The name of the certificate" } ] }, "docs": "Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate." }, { "info": { "name": "Microsoft Azure Gets The Certificate Signing Requests For A Subscription In The Specified Resource Group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/csrs", "params": [ { "name": "resourceGroupName", "value": "", "type": "path", "description": "Name of the resource group" }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription Id" }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Gets A Certificate Signing Request By Certificate Name For A Subscription In The Specified Resource Group", "type": "http" }, "http": { "method": "GET", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/csrs/:name", "params": [ { "name": "resourceGroupName", "value": "", "type": "path", "description": "Name of the resource group" }, { "name": "name", "value": "", "type": "path", "description": "Name of the certificate." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription Id" }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Creates Or Modifies An Existing Certificate Signing Request", "type": "http" }, "http": { "method": "PUT", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/csrs/:name", "params": [ { "name": "resourceGroupName", "value": "", "type": "path", "description": "Name of the resource group" }, { "name": "name", "value": "", "type": "path", "description": "Name of the certificate." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription Id" }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Creates Or Modifies An Existing Certificate Signing Request", "type": "http" }, "http": { "method": "PATCH", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/csrs/:name", "params": [ { "name": "resourceGroupName", "value": "", "type": "path", "description": "Name of the resource group" }, { "name": "name", "value": "", "type": "path", "description": "Name of the certificate." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription Id" }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Needs a more full description created." }, { "info": { "name": "Microsoft Azure Delete The Certificate Signing Request", "type": "http" }, "http": { "method": "DELETE", "url": "{{baseUrl}}/subscriptions/:subscriptionId/resourceGroups/:resourceGroupName/providers/Microsoft.Web/csrs/:name", "params": [ { "name": "resourceGroupName", "value": "", "type": "path", "description": "Name of the resource group" }, { "name": "name", "value": "", "type": "path", "description": "Name of the certificate signing request." }, { "name": "subscriptionId", "value": "", "type": "path", "description": "Subscription Id" }, { "name": "api-version", "value": "", "type": "query", "description": "API Version" } ] }, "docs": "Needs a more full description created." } ] } ], "bundled": true }