Dps Certificate - Generate Verification Code

Service:: IoT Hub Device Provisioning Service

API Version:: 2026-08-31

Generate verification code for Proof of Possession.

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/generateVerificationCode?api-version=2026-08-31

With optional parameters:

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/provisioningServices/{provisioningServiceName}/certificates/{certificateName}/generateVerificationCode?api-version=2026-08-31&certificate.name={certificate.name}&certificate.rawBytes={certificate.rawBytes}&certificate.isVerified={certificate.isVerified}&certificate.purpose={certificate.purpose}&certificate.created={certificate.created}&certificate.lastUpdated={certificate.lastUpdated}&certificate.hasPrivateKey={certificate.hasPrivateKey}&certificate.nonce={certificate.nonce}

URI Parameters

Name	In	Required	Type	Description
certificateName	path	True	string	Name of the certificate to retrieve.
provisioningServiceName	path	True	string	Name of the provisioning service to retrieve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	The name of the resource group. The name is case insensitive.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.
certificate.created	query		string (date-time)	Time the certificate is created.
certificate.hasPrivateKey	query		boolean	Indicates if the certificate contains private key.
certificate.isVerified	query		boolean	Indicates if the certificate has been verified by owner of the private key.
certificate.lastUpdated	query		string (date-time)	Certificate last updated time.
certificate.name	query		string	Common Name for the certificate.
certificate.nonce	query		string	Random number generated to indicate Proof of Possession.
certificate.purpose	query		CertificatePurpose	Description mentioning the purpose of the certificate.
certificate.rawBytes	query		string (byte)	Raw data of certificate.

Request Header

Name	Required	Type	Description
If-Match	True	string	ETag of the certificate. This is required to update an existing certificate, and ignored while creating a brand new certificate.

Responses

Name	Type	Description
200 OK	VerificationCodeResponse	Azure operation completed successfully.
Other Status Codes	ErrorDetails	An unexpected error response.

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

DPSGenerateVerificationCode

Sample request

HTTP

POST https://management.azure.com/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/provisioningServices/myFirstProvisioningService/certificates/cert/generateVerificationCode?api-version=2026-08-31&certificate.name={certificate.name}&certificate.rawBytes={certificate.rawBytes}&certificate.isVerified={certificate.isVerified}&certificate.purpose={certificate.purpose}&certificate.created={certificate.created}&certificate.lastUpdated={certificate.lastUpdated}&certificate.hasPrivateKey={certificate.hasPrivateKey}&certificate.nonce={certificate.nonce}

Sample response

Status code:: 200

{
  "name": "cert",
  "properties": {
    "certificate": "MA==",
    "created": "Thu, 12 Oct 2017 19:23:50 GMT",
    "expiry": "Sat, 31 Dec 2039 23:59:59 GMT",
    "isVerified": false,
    "subject": "CN=andbucdevice1",
    "thumbprint": "##############################",
    "updated": "Thu, 12 Oct 2017 19:26:56 GMT",
    "verificationCode": "##################################"
  }
}

Definitions

Name	Description
CertificatePurpose	Description mentioning the purpose of the certificate.
ErrorDetails	Error details.
VerificationCodeResponse	Description of the response of the verification code.
VerificationCodeResponseProperties

CertificatePurpose

Enumeration

Description mentioning the purpose of the certificate.

Value	Description
clientAuthentication
serverAuthentication

ErrorDetails

Object

Error details.

Name	Type	Description
code	integer (int32)	The error code.
details	string	The error details.
httpStatusCode	string	The HTTP status code.
message	string	The error message.

VerificationCodeResponse

Object

Description of the response of the verification code.

Name	Type	Description
etag	string	Request etag.
id	string	The resource identifier.
name	string	Name of certificate.
properties	VerificationCodeResponseProperties
type	string	The resource type.

VerificationCodeResponseProperties

Object

Name	Type	Description
certificate	string (byte)	base-64 representation of X509 certificate .cer file or just .pem file content.
created	string	Certificate created time.
expiry	string	Code expiry.
isVerified	boolean	Indicate if the certificate is verified by owner of private key.
subject	string	Certificate subject.
thumbprint	string	Certificate thumbprint.
updated	string	Certificate updated time.
verificationCode	string	Verification code.