Yandex Cloud
  • Services
  • Solutions
  • Why Yandex Cloud
  • Blog
  • Pricing
  • Documentation
  • Contact us
Get started
Language / Region
Yandex project
© 2023 Yandex.Cloud LLC
Yandex IoT Core
  • Getting started
  • Step-by-step instructions
    • All instructions
    • Sending messages
    • Subscribing a device or registry to receive messages
    • Viewing the connection log
    • Creating a trigger for a topic
    • Managing registries
      • Getting information about registries
      • Creating a registry
      • Updating a registry
      • Deleting a registry
    • Managing devices
      • Managing topic aliases
        • Creating an alias
        • Getting a list of aliases
        • Updating an alias
        • Deleting an alias
      • Getting information about devices
      • Creating a device
      • Updating a device
      • Deleting a device
    • Managing brokers
      • Getting information about a broker
      • Creating a broker
      • Updating a broker
      • Deleting a broker
    • Managing certificates
      • Create a certificate
      • Managing registry certificates
      • Managing device certificates
      • Managing broker certificates
    • Managing passwords
      • Managing registry passwords
      • Managing device passwords
      • Managing broker passwords
  • Concepts
    • Authorization
    • Relationship between service resources
    • MQTT server connection parameters
    • Sending messages to an MQTT server via gRPC
    • Topic
      • Overview
      • Device topics
      • Registry topics
      • Subtopic
      • Using topics
    • Backups
    • Quotas and limits
  • Practical guidelines
    • All tutorials
    • Working with Mosquitto
      • Sending messages
      • Subscribing a device or registry to receive messages
    • Working with Yandex IoT Core from an Android device in Java
    • Working with Yandex IoT Core in C#
    • Working with Yandex IoT Core in Java
    • Writing data from a device to Managed Service for PostgreSQL
  • Access management
  • Pricing policy
  • Devices API reference
    • Authentication in the API
    • gRPC
      • Overview
      • DeviceDataService
      • DeviceService
      • RegistryDataService
      • RegistryService
      • OperationService
    • REST
      • Overview
      • DeviceData
        • Overview
        • publish
      • Device
        • Overview
        • addCertificate
        • addPassword
        • create
        • delete
        • deleteCertificate
        • deletePassword
        • get
        • getByName
        • list
        • listCertificates
        • listOperations
        • listPasswords
        • update
      • RegistryData
        • Overview
        • publish
      • Registry
        • Overview
        • addCertificate
        • addPassword
        • create
        • delete
        • deleteCertificate
        • deletePassword
        • get
        • getByName
        • list
        • listCertificates
        • listDeviceTopicAliases
        • listOperations
        • listPasswords
        • update
  • Broker API reference
    • Authentication in the API
    • gRPC
      • Overview
      • BrokerDataService
      • BrokerService
      • OperationService
    • REST
      • Overview
      • BrokerData
        • Overview
        • publish
      • Broker
        • Overview
        • addCertificate
        • addPassword
        • create
        • delete
        • deleteCertificate
        • deletePassword
        • get
        • list
        • listCertificates
        • listOperations
        • listPasswords
        • update
  • Questions and answers
  1. Step-by-step instructions
  2. Managing passwords
  3. Managing device passwords

Managing device passwords

Written by
Yandex Cloud
  • Adding a password to a device
    • Adding a password to an existing device
    • Setting a password for a device when creating it
  • Getting a list of device passwords
  • Deleting a device password

For devices and registries to begin exchanging data and commands, you need to log in. This section describes how to manage device passwords for the appropriate authorization method.

Note

When using an X.509 certificate along with a password, the password has higher priority.

  • Adding a password
  • Viewing a password list
  • Deleting a password

Adding a password to a device

You can add a password to an already created device or set it when creating a device using the --password parameter.

Note

You can also set a password from the input stream. To do this, use the --read-password flag instead of the --password parameter.

Adding a password to an existing device

Management console
CLI
Terraform
API

To add a password to an existing device:

  1. In the management console, select the folder where you wish to set a password for a previously created device.
  2. Select Yandex IoT Core.
  3. Select the registry with the desired device from the list.
  4. In the left part of the window, select Devices.
  5. Select the desired device from the list.
  6. Under Passwords, click Add password.
  7. In the Password field, enter the password you will be using to access your device.
    You can use a password generator to create a password.
    Make sure you save the password - you will need it later.
  8. Click Add.

If you don't have the Yandex Cloud command line interface yet, install and initialize it.

To add a password:

  1. Get a list of devices in the registry:

    yc iot device --registry-name my-registry list
    

    Result:

    +----------------------+--------+
    |          ID          |  NAME  |
    +----------------------+--------+
    | arenak5ciqss6pbas5tm | second |
    | areqjd6un3afc3cefuio | first  |
    +----------------------+--------+
    
  2. Add a password to the device:

    yc iot device password add --device-name first --password Passw0rdForDevice
    

    Result:

    device_id: areqjd6un3afc3cefcvm
    id: areqjd6un3afc3cefuio
    created_at: "2019-12-16T15:11:36.892167Z"
    

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it by configuration files. They store the infrastructure description in HashiCorp Configuration Language (HCL). Terraform and its providers are distributed under the Mozilla Public License.

For more information about the provider resources, see the documentation on the Terraform site or mirror site.

If you change the configuration files, Terraform automatically determines which part of your configuration is already deployed and what should be added or removed.

For more information about Terraform, see the documentation.

To add a password to a device created using Terraform:

  1. In the configuration file, describe the parameters of the resource to create:

    • yandex_iot_core_device: Device parameters:
      • registry_id: ID of the registry where the device was created.
      • name: Device name.
      • description: Device description.
      • passwords: List of passwords for authorization using a username and password.

    Sample resource structure in the configuration file:

    resource "yandex_iot_core_device" "my_device" {
      registry_id = "<registry_ID>"
      name        = "<device_name>"
      description = "test device for terraform provider documentation"
    ...
      passwords = [
        "<password>",
      ]
    ...
    }
    

    For more information about the yandex_iot_core_device resource parameters in Terraform, see the provider documentation.

  2. In the command line, change to the folder where you edited the configuration file.

  3. Make sure the configuration file is correct using the command:

    terraform validate
    

    If the configuration is correct, the following message is returned:

    Success! The configuration is valid.
    
  4. Run the command:

    terraform plan
    

    The terminal will display a list of resources with parameters. No changes are made at this step. If there are errors in the configuration, Terraform points them out.

  5. Apply the configuration changes:

    terraform apply
    
  6. Confirm the changes: type yes in the terminal and press Enter.

    You can verify device passwords in the management console or using the following CLI command:

    yc iot device password list --device-name <device_name>
    

You can add a device password using the API addPassword method.

Setting a password for a device when creating it

Management console
CLI
Terraform
API

For information on setting a password for a device being created, see Creating a device.

If you don't have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To set a password when creating a device:

  1. Get a list of registries in the folder:

    yc iot registry list
    

    Result:

    +----------------------+-------------------+
    |          ID          |       NAME        |
    +----------------------+-------------------+
    | arenou2oj4ct42eq8f4m | my-registry       |
    +----------------------+-------------------+
    
  2. Create a device with a password:

    yc iot device create --registry-name my-registry --name device-with-pass --password Passw0rdForDevice
    

    Result:

    id: arepomfambsg5biqc25n
    registry_id: arenou2oj4ct42eq8g3n
    created_at: "2019-12-16T15:18:39.358922Z"
    name: device-with-pass
    

For information on setting a password for a device being created, see Creating a device.

You can set a device password when creating it using the API create method.

Getting a list of device passwords

Management console
CLI
API

To view the list of device passwords:

  1. In the management console, select the folder to get the list of device passwords for.
  2. Select Yandex IoT Core.
  3. Select the registry with the desired device from the list.
  4. In the left part of the window, select Devices.
  5. Select the desired device from the list.
  6. On the Overview page, go to the Passwords section.

The list of device passwords is displayed in the Passwords section.

If you don't have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To get a list of passwords:

  1. Get a list of devices in the registry:

    yc iot device --registry-name my-registry list
    

    Result:

    +----------------------+------------------+
    |          ID          |       NAME       |
    +----------------------+------------------+
    | arenak5ciqss6pbas5tm | second           |
    | arepomfambsg5biqc77p | device-with-pass |
    | areqjd6un3afc3cefuio | first            |
    +----------------------+------------------+
    
  2. Get a list of device passwords:

    yc iot device password list --device-name device-with-pass
    

    Result:

    +----------------------+---------------------+
    |          ID          |     CREATED AT      |
    +----------------------+---------------------+
    | areuin5t7pndvlj6n4tr | 2019-12-16 15:18:39 |
    +----------------------+---------------------+
    

You can get a list of device passwords using the API listPasswords method.

Deleting a device password

Management console
CLI
Terraform
API

To delete a device password:

  1. In the management console, select the folder to delete the device password from.
  2. Select Yandex IoT Core.
  3. Select the registry with the desired device from the list.
  4. In the left part of the window, select Devices.
  5. Select the desired device from the list.
  6. In the row with the password you need, click and select Delete from the drop-down list.
  7. In the window that opens, click Delete.

If you don't have the Yandex Cloud command line interface yet, install and initialize it.

The folder specified in the CLI profile is used by default. You can specify a different folder using the --folder-name or --folder-id parameter.

To delete a password:

  1. Get a list of device passwords:

    yc iot device password list --device-name device-with-pass
    

    Result:

    +----------------------+---------------------+
    |          ID          |     CREATED AT      |
    +----------------------+---------------------+
    | areuin5t7pndvlj6n4tr | 2019-12-16 15:18:39 |
    +----------------------+---------------------+
    
  2. Delete the password:

    yc iot device password delete --device-name device-with-pass --password-id areuin5t7pndvlj6n4tr
    
  3. Make sure that the password was deleted:

    yc iot device password list --device-name device-with-pass
    

    Result:

    +----+------------+
    | ID | CREATED AT |
    +----+------------+
    +----+------------+
    

With Terraform, you can quickly create a cloud infrastructure in Yandex Cloud and manage it by configuration files. They store the infrastructure description in HashiCorp Configuration Language (HCL). Terraform and its providers are distributed under the Mozilla Public License.

For more information about the provider resources, see the documentation on the Terraform site or mirror site.

If you change the configuration files, Terraform automatically determines which part of your configuration is already deployed and what should be added or removed.

For more information about Terraform, see the documentation.

To delete the password of a device created using Terraform:

  1. Open the Terraform configuration file and delete the value of the password in the passwords block, in the fragment with the device description. To delete all passwords, delete the entire passwords block.

    Example device description in the Terraform configuration:

    resource "yandex_iot_core_device" "my_device" {
      registry_id = "<registry_ID>"
      name        = "<device_name>"
      description = "test device for terraform provider documentation"
    ...
      passwords = [
        "<password>",
      ]
    ...  
    }
    

    For more information about the yandex_iot_core_device resource parameters in Terraform, see the provider documentation.

  2. In the command line, change to the folder where you edited the configuration file.

  3. Make sure the configuration file is correct using the command:

    terraform validate
    

    If the configuration is correct, the following message is returned:

    Success! The configuration is valid.
    
  4. Run the command:

    terraform plan
    

    The terminal will display a list of resources with parameters. No changes are made at this step. If there are errors in the configuration, Terraform points them out.

  5. Apply the configuration changes:

    terraform apply
    
  6. Confirm the changes: type yes in the terminal and press Enter.

    You can verify device passwords in the management console or using the following CLI command:

    yc iot device password list --device-name <device_name>
    

You can delete a device password using the API deletePassword method.

Was the article helpful?

Language / Region
Yandex project
© 2023 Yandex.Cloud LLC
In this article:
  • Adding a password to a device
  • Adding a password to an existing device
  • Setting a password for a device when creating it
  • Getting a list of device passwords
  • Deleting a device password