mf2c/identification repository overview

⁠Identification

In mF2C, the identification module is responsible for obtaining an ID for the device that executes the agent and sharing both, the IDKey (also called userID) and the deviceID, with other system components.

The identification module will acquire the IDKey and the deviceID from a webservice running in the cloud agent. For this purpose, it will send the CIMIUsrID parameter or the credentials that the user assigned during the registration (service subscription) process and will get in return both identifiers.

The ID acquisition process takes place only the first time the user executes the agent. During this process, both the IDKey and the deviceID are stored locally for future use.

The identification module implements two functions which are briefly describe below:

• Register Device
  Purpose: to provide a method to register new devices in the system and assign them a unique identifier in the network.
  Endpoint: http://localhost:46060/api/v1/resource-management/identification/registerDevice/⁠
  Input: CIMIUsrID (read from env variable) or user credentials
  Input format: json
  Input example: {"usr":"username", "pwd":"password"}
  Output: Error / Success message
  Output format: json
  Output example: {"status":"status_code", "message":"generated message"}
  Method: POST

• Request ID
  Purpose: to provide a method to share both, the IDKey and the deviceID, with other mF2C modules.
  Endpoint: http://localhost:46060/api/v1/resource-management/identification/requestID/⁠
  Input: None
  Output: CIMIUsrID, IDKey, deviceID
  Output format: json
  Output example: {"CIMIUsrID":"klmno", "IDKey":"fghij", "deviceID":"abcde"}
  Method: GET