Identity v2

With this API, you can create, update, and delete the identities for a device in a module.

PUB Create an identity

from/module/{module_id}/action/identity/create

Use this endpoint to create new indirectly connected device identities.

Parameters:

Name	Type	Description	Accepted values
module_id	string	Module identifier	Name of module

Message format

Properties:

Key	Value	Notes	Mandatory
correlationId	<string>	Unique String (e.g. uuid)	No
ack	<string>		No
target	<string>		No
context	<string>		No
timestamp	<string>	Date time in ISO-8601 format	No
parent	<string>		No

Specifying the parent

When specifying the parent property in the header, the identity must already exist and must be connected via this directly connected device. If absent, a directly connected device will become the parent of the new identity.

These properties can be included in the request by adding them to the topic to which you are sending the messages. See the Message Properties section to find out more.

Here is an example of the properties used:

from/module/{module_id}/action/identity/create&parent={parent}&ack=all

Payload information:

Key	Value	Notes	Mandatory
identity	<string>	Format: uuid	No
publicKey	<string>		No

Here is an example of a payload:

{
  "identity": "{identity_value_UUID}",
  "publicKey": "{public Key}"
}

SUB Ack for identity creation

to/module/{module_id}/ack/identity/create

Use this endpoint to check whether the device identity was successfully created.

Parameters:

Name	Type	Description	Accepted values
module_id	string	Module identifier	Name of module

PUB Update an identity

from/module/{module_id}/action/identity/update

Use this endpoint to update indirectly or directly connected device properties.

Parameters:

Name	Type	Description	Accepted values
module_id	string	Module identifier	Name of module

Message format

Properties:

Key	Value	Notes	Mandatory
correlationId	<string>	Unique String (e.g. uuid)	No
ack	<string>		No
target	<string>		No
context	<string>		No
timestamp	<string>	Date time in ISO-8601 format	No
parent	<string>		No

Specifying the parent

When specifying the parent property in the header, the identity must already exist and must be connected via this directly connected device. If absent, a directly connected device will become the parent of the new identity.

These properties can be included in the request by adding them to the topic you are sending the messages to. See the Message Properties section to find out more.

Here is an example of the properties used:

from/module/{module_id}/action/identity/update&parent={parent}&ack=all

Payload information:

Key	Value	Notes	Mandatory
identity	<string>	Format: uuid	No
publicKey	<string>		No

Here is an example payload:

{
  "identity": "{identity_value_UUID}",
  "publicKey": "{public Key}"
}

SUB Ack for identity update

to/module/{module_id}/ack/identity/update

Use this endpoint to check whether the identity properties were updated successfully.

Parameters

Name	Type	Description	Accepted values
module_id	string	Module identifier	Name of module

PUB Delete an identity

from/module/{module_id}/action/identity/delete

Use this endpoint to delete an indirectly connected device identity.

Parameters:

Name	Type	Description	Accepted values
module_id	string	Module identifier	Name of module

Message format

Properties:

Key	Value	Notes	Mandatory
correlationId	<string>	Unique String (e.g. uuid)	Optional
ack	<string>		Optional
target	<string>		Optional
context	<string>		Optional
timestamp	<string>	Date time in ISO-8601 format	Optional
parent	<string>		Optional

Specifying the parent

When specifying the parent property in the header, the identity must already exist and must be connected via this directly connected device. If absent, a directly connected device will become a parent of the new identity.

These properties can be included in the request by adding them to the topic you are sending the messages to. See the Message Properties section to find out more.

Here is an example of the properties used:

from/module/{module_id}/action/identity/delete&parent={parent}&ack=all

Payload information:

Key	Value	Notes	Mandatory	Remarks
identity	<string>	Format: uuid	No

Here is an example payload:

{
  "identity": "{identity_value_UUID}",
}

SUB Ack for identity deletion

to/module/{module_id}/ack/identity/delete

Use this endpoint to check whether the device identity was deleted successfully.

Parameters:

Name	Type	Description	Accepted values
module_id	string	Module identifier	Name of module