Contact UsGet started
© 2024 Iron Hive LLC Belgrade

IoT Core Service, gRPC: DeviceService.AddPassword

Written by
Updated at October 17, 2024

Adds password for the specified device.

gRPC request

rpc AddPassword (AddDevicePasswordRequest) returns (operation.Operation)

AddDevicePasswordRequest

{
  "deviceId": "string",
  "password": "string"
}

Field

Description

deviceId

string

Required field. ID of the device to add a password for.

To get a device ID make a DeviceService.List request.

password

string

Passwords for the device.

The password must contain at least three character categories among the following: upper case latin, lower case latin, numbers and special symbols.

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "deviceId": "string",
    "passwordId": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "deviceId": "string",
    "id": "string",
    "createdAt": "google.protobuf.Timestamp"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

google.protobuf.Timestamp

Creation timestamp.

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

AddDevicePasswordMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

DevicePassword

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

AddDevicePasswordMetadata

Field

Description

deviceId

string

ID of the device for which the password is being added.

passwordId

string

ID of the password that is being added.

DevicePassword

A device password.

Field

Description

deviceId

string

ID of the device that the password belongs to.

id

string

ID of the password.

createdAt

google.protobuf.Timestamp

Creation timestamp.
Previous
ListPasswords
Next
DeletePassword