ESPRMAdminNodeRegistration
Defined in: src/ESPRMAdminNodeRegistration.ts:11
Shell class for admin node registration operations. Methods are added via prototype augmentation in methods/ESPRMAdminNodeRegistration/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminNodeRegistration():
ESPRMAdminNodeRegistration
Returns
Section titled “Returns”ESPRMAdminNodeRegistration
Methods
Section titled “Methods”generateNodeIds()
Section titled “generateNodeIds()”generateNodeIds(
params):Promise<GenerateNodeIdsResponse>
Defined in: src/methods/ESPRMAdminNodeRegistration/GenerateNodeIds.ts:22
Generates new node IDs for device provisioning.
Parameters
Section titled “Parameters”params
Section titled “params”Configuration for node ID generation including count and type.
Returns
Section titled “Returns”Promise<GenerateNodeIdsResponse>
The generated node IDs.
getCustomMQTTHost()
Section titled “getCustomMQTTHost()”getCustomMQTTHost():
Promise<GetMQTTHostResponse>
Defined in: src/methods/ESPRMAdminNodeRegistration/GetCustomMQTTHost.ts:20
Retrieves the custom MQTT host endpoint for the deployment.
Returns
Section titled “Returns”Promise<GetMQTTHostResponse>
The custom MQTT host information.
getMQTTHost()
Section titled “getMQTTHost()”getMQTTHost():
Promise<GetMQTTHostResponse>
Defined in: src/methods/ESPRMAdminNodeRegistration/GetMQTTHost.ts:20
Retrieves the default MQTT host endpoint for the deployment.
Returns
Section titled “Returns”Promise<GetMQTTHostResponse>
The MQTT host information.
getNodeCertificateRegistrationStatus()
Section titled “getNodeCertificateRegistrationStatus()”getNodeCertificateRegistrationStatus(
params):Promise<NodeCertificateRegistrationStatusResponse>
Defined in: src/methods/ESPRMAdminNodeRegistration/GetNodeCertificateRegistrationStatus.ts:27
Checks the registration status of a node certificate request.
Parameters
Section titled “Parameters”params
Section titled “params”GetNodeCertificateRegistrationParams
Must include the request_id of a prior registration request.
Returns
Section titled “Returns”Promise<NodeCertificateRegistrationStatusResponse>
The current registration status.
getNodeCertificates()
Section titled “getNodeCertificates()”getNodeCertificates(
params?):Promise<GetNodeCertificatesResponse>
Defined in: src/methods/ESPRMAdminNodeRegistration/GetNodeCertificates.ts:22
Retrieves node certificates for registered nodes.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional filters such as node ID or pagination.
Returns
Section titled “Returns”Promise<GetNodeCertificatesResponse>
The node certificates.
getNodeIds()
Section titled “getNodeIds()”getNodeIds(
params?):Promise<GetNodeIdsResponse>
Defined in: src/methods/ESPRMAdminNodeRegistration/GetNodeIds.ts:22
Retrieves previously generated node IDs.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional filters such as pagination or node ID status.
Returns
Section titled “Returns”Promise<GetNodeIdsResponse>
The list of node IDs.
registerNodeCertificates()
Section titled “registerNodeCertificates()”registerNodeCertificates(
params):Promise<ESPAPISuccessResponse>
Defined in: src/methods/ESPRMAdminNodeRegistration/RegisterNodeCertificates.ts:22
Registers node certificates for device authentication.
Parameters
Section titled “Parameters”params
Section titled “params”RegisterNodeCertificatesRequest
The certificate data to register.
Returns
Section titled “Returns”Promise<ESPAPISuccessResponse>
A success response upon registration.