renew ETX Client Certificate

With this API call the user (client) can:

renew the certificate of a device or software service in the ETX system if the original certificate has expired. If the client's certificate expired or going to expire within 30 days and new certificate will be issued. If the certificate expires more than 30 days, the current certificate will be returned to the client.
complete its device or software service registration to the ETX system if the original registration request was not successful because of a pending certificate generation. Whenever the user receives a "client registration is pending" response (HTTP 202) from POST /clients/registration call. The client should initiate this PUT API call to finish the registration process and get the required certificate.

Note: The user needs to authenticate with their ThingSpace credentials using the Access/Bearer and Session/M2M tokens in order to call this API.

Authorization

thingspace_oauth sessionToken

AuthorizationBearer <token>

Access/Bearer token needed to authorize the user. The Bearer/Access Token should be acquired by using the ThingSpace Portal (thingspace.verizon.com). For details on how to obtain the token please refer to the

In: header

SessionToken<token>

This is the Session/M2M token needed to authenticate the user. It should be acquired by using the ThingSpace APIs. For detail on how to obtain a Session/M2M token please refer to the

In: header

Header Parameters

DeviceID*DeviceID

The generated ID (UUID v4) for the device. It can be used as:

the MQTT Client ID when connecting to the Message Exchange system
a parameter when asking for the connection endpoint
a parameter when finishing the device registration
a parameter when unregistering the device

Match^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$

Formatuuid

Length36 <= length <= 36

VendorID*etx.VendorID

The VendorID set during the Vendor registration call.

Match^[a-zA-Z0-9]+$

Lengthlength <= 64

X-Transaction-Id?string

Optional transaction identifier for tracing requests. If not provided, the application will generate one.

Match^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$

Formatuuid

Length36 <= length <= 36

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Empty request body with no properties.

Response Body

`application/json`

curl -X PUT "https://example.com/api/v2/clients/registration" \  -H "DeviceID: a4fcd16a-343d-4527-8203-2f46e3e4ff4b" \  -H "VendorID: VerizonETX" \  -H "Content-Type: application/json" \  -d '{}'

{  "DeviceID": "a4fcd16a-343d-4527-8203-2f46e3e4ff4b",  "Certificate": {    "cert.pem": "\"-----BEGIN CERTIFICATE-----\nMIIDrjCCApagAwIBAgICEAEwDQYJKoZIhvcNAQELBQAwUjELMAkGA1UEBhMCQVUx\n...\nuuA1Zog3aBOeeEzp9SEJBMTJRYPXbK4e8Xer+7m98OL/3g==\n-----END CERTIFICATE-----\"\n",    "key.pem": "\"-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDa1lF7DWudshQ5\n...\nJbjD2hacWGzpKzTfn5Mt1frE\n-----END PRIVATE KEY-----\"\n",    "ca.pem": "\"-----BEGIN CERTIFICATE-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDa1lF7DWudshQ5\n...\nJbjD2hacWGzpKzTfn5Mt1frE\n-----END CERTIFICATE-----\"\n",    "ExpirationTime": "2017-07-21T17:32:28Z"  }}

{  "DeviceID": "a4fcd16a-343d-4527-8203-2f46e3e4ff4b",  "Message": "Client registration is in pending state due to the unfinished certificate generation. Please call the PUT API to finish the registration."}

{  "error": "Error Summary",  "description": "Error Description"}

{  "error": "Error Summary",  "description": "Error Description"}

{  "error": "Error Summary",  "description": "Error Description"}

{  "error": "Error Summary",  "description": "Error Description"}

{  "error": "Error Summary",  "description": "Error Description"}

{  "error": "Error Summary",  "description": "Error Description"}

Header Parameters

DeviceID*DeviceID

The generated ID (UUID v4) for the device. It can be used as:

the MQTT Client ID when connecting to the Message Exchange system
a parameter when asking for the connection endpoint
a parameter when finishing the device registration
a parameter when unregistering the device

Match^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$

Formatuuid

Length36 <= length <= 36

VendorID*etx.VendorID

The VendorID set during the Vendor registration call.

Match^[a-zA-Z0-9]+$

Lengthlength <= 64

X-Transaction-Id?string

Optional transaction identifier for tracing requests. If not provided, the application will generate one.

Match^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$

Formatuuid

Length36 <= length <= 36

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Empty request body with no properties.

{ "DeviceID": "a4fcd16a-343d-4527-8203-2f46e3e4ff4b", "Certificate": { "cert.pem": "\"-----BEGIN CERTIFICATE-----\nMIIDrjCCApagAwIBAgICEAEwDQYJKoZIhvcNAQELBQAwUjELMAkGA1UEBhMCQVUx\n...\nuuA1Zog3aBOeeEzp9SEJBMTJRYPXbK4e8Xer+7m98OL/3g==\n-----END CERTIFICATE-----\"\n", "key.pem": "\"-----BEGIN PRIVATE KEY-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDa1lF7DWudshQ5\n...\nJbjD2hacWGzpKzTfn5Mt1frE\n-----END PRIVATE KEY-----\"\n", "ca.pem": "\"-----BEGIN CERTIFICATE-----\nMIIEvgIBADANBgkqhkiG9w0BAQEFAASCBKgwggSkAgEAAoIBAQDa1lF7DWudshQ5\n...\nJbjD2hacWGzpKzTfn5Mt1frE\n-----END CERTIFICATE-----\"\n", "ExpirationTime": "2017-07-21T17:32:28Z" }}

{ "DeviceID": "a4fcd16a-343d-4527-8203-2f46e3e4ff4b", "Message": "Client registration is in pending state due to the unfinished certificate generation. Please call the PUT API to finish the registration."}

renew ETX Client Certificate

200application/json

202application/json

400application/json

401application/json

403application/json

429application/json

503application/json

defaultapplication/json

200application/json

202application/json

400application/json

401application/json

403application/json

429application/json

503application/json

defaultapplication/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`