Share via

az iot central user

  • Reference

Note

This reference is part of the azure-iot extension for the Azure CLI (version 2.46.0 or higher). The extension will automatically install the first time you run an az iot central user command. Learn more about extensions.

Manage and configure IoT Central users.

Commands

Name Description Type Status
az iot central user create

Add a user to the application.

 Extension GA
az iot central user delete

Delete a user from the application.

 Extension GA
az iot central user list

Get list of users for an IoT Central application.

 Extension GA
az iot central user show

Get the details of a user by ID.

 Extension GA
az iot central user update

Update roles for a user in the application.

 Extension GA

az iot central user create

Add a user to the application.

az iot central user create --app-id
                           --assignee
                           --role
                           [--api-version {2022-06-30-preview, 2022-07-31}]
                           [--central-api-uri]
                           [--email]
                           [--object-id]
                           [--org-id]
                           [--tenant-id]
                           [--token]

Examples

Add a user by email to the application

az iot central user create --user-id {userId} --app-id {appId} --email {emailAddress} --role admin

Add a service-principal to the application

az iot central user create --user-id {userId} --app-id {appId} --tenant-id {tenantId} --object-id {objectId} --role operator

Required Parameters

--app-id -n

The App ID of the IoT Central app you want to manage. You can find the App ID in the "About" page for your application under the help menu.

--assignee --user-id

ID associated with the user.

--role -r

The role that will be associated with this token or user. You can specify one of the built-in roles, or specify the role ID of a custom role. See more at https://aka.ms/iotcentral-customrolesdocs.

Optional Parameters

--api-version --av
Deprecated

Argument 'api_version' has been deprecated and will be removed in a future release.

This command parameter has been deprecated and will be ignored.In the future release, we will only support IoT Central APIs from latest GA version.If any API is not GA yet, we will call latest preview version.

Accepted values: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

The IoT Central DNS suffix associated with your application.

Default value: azureiotcentral.com
--email

Email address of user to be added to the app. If this is specified, service principal parameters (tenant_id and object_id) will be ignored.

--object-id --oid

Object ID for service principal to be added to the app. Tenant ID must also be specified. If email is specified this gets ignored and the user will not be a service principal user but a standard "email" user.

--org-id --organization-id

The ID of the organization for the user role assignment. Only available for api-version == 1.1-preview.

--tenant-id --tnid

Tenant ID for service principal to be added to the app. Object ID must also be specified. If email is specified this gets ignored and the user will not be a service principal user but a standard "email" user.

--token

If you'd prefer to submit your request without authenticating against the Azure CLI, you can specify a valid user token to authenticate your request. You must specify the type of key as part of the request. Learn more at https://aka.ms/iotcentraldocsapi.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az iot central user delete

Delete a user from the application.

az iot central user delete --app-id
                           --assignee
                           [--api-version {2022-06-30-preview, 2022-07-31}]
                           [--central-api-uri]
                           [--token]

Examples

Delete a user

az iot central user delete --app-id {appid} --user-id {userId}

Required Parameters

--app-id -n

The App ID of the IoT Central app you want to manage. You can find the App ID in the "About" page for your application under the help menu.

--assignee --user-id

ID associated with the user.

Optional Parameters

--api-version --av
Deprecated

Argument 'api_version' has been deprecated and will be removed in a future release.

This command parameter has been deprecated and will be ignored.In the future release, we will only support IoT Central APIs from latest GA version.If any API is not GA yet, we will call latest preview version.

Accepted values: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

The IoT Central DNS suffix associated with your application.

Default value: azureiotcentral.com
--token

If you'd prefer to submit your request without authenticating against the Azure CLI, you can specify a valid user token to authenticate your request. You must specify the type of key as part of the request. Learn more at https://aka.ms/iotcentraldocsapi.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az iot central user list

Get list of users for an IoT Central application.

az iot central user list --app-id
                         [--api-version {2022-06-30-preview, 2022-07-31}]
                         [--central-api-uri]
                         [--token]

Examples

List of users

az iot central user list --app-id {appid}

Required Parameters

--app-id -n

The App ID of the IoT Central app you want to manage. You can find the App ID in the "About" page for your application under the help menu.

Optional Parameters

--api-version --av
Deprecated

Argument 'api_version' has been deprecated and will be removed in a future release.

This command parameter has been deprecated and will be ignored.In the future release, we will only support IoT Central APIs from latest GA version.If any API is not GA yet, we will call latest preview version.

Accepted values: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

The IoT Central DNS suffix associated with your application.

Default value: azureiotcentral.com
--token

If you'd prefer to submit your request without authenticating against the Azure CLI, you can specify a valid user token to authenticate your request. You must specify the type of key as part of the request. Learn more at https://aka.ms/iotcentraldocsapi.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az iot central user show

Get the details of a user by ID.

az iot central user show --app-id
                         --assignee
                         [--api-version {2022-06-30-preview, 2022-07-31}]
                         [--central-api-uri]
                         [--token]

Examples

Get details of user

az iot central user show --app-id {appid} --user-id {userId}

Required Parameters

--app-id -n

The App ID of the IoT Central app you want to manage. You can find the App ID in the "About" page for your application under the help menu.

--assignee --user-id

ID associated with the user.

Optional Parameters

--api-version --av
Deprecated

Argument 'api_version' has been deprecated and will be removed in a future release.

This command parameter has been deprecated and will be ignored.In the future release, we will only support IoT Central APIs from latest GA version.If any API is not GA yet, we will call latest preview version.

Accepted values: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

The IoT Central DNS suffix associated with your application.

Default value: azureiotcentral.com
--token

If you'd prefer to submit your request without authenticating against the Azure CLI, you can specify a valid user token to authenticate your request. You must specify the type of key as part of the request. Learn more at https://aka.ms/iotcentraldocsapi.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

az iot central user update

Update roles for a user in the application.

Update a user with a different roles. Updating the tenantId or objectId for a service principal user is not allowed. Updating the email address for an email user is not allowed.

az iot central user update --app-id
                           --assignee
                           [--api-version {2022-06-30-preview, 2022-07-31}]
                           [--central-api-uri]
                           [--email]
                           [--object-id]
                           [--roles]
                           [--tenant-id]
                           [--token]

Examples

Update roles for a user by email or service principal in the application.

az iot central user update --user-id {userId} --app-id {appId} --roles "org1\admin"

Required Parameters

--app-id -n

The App ID of the IoT Central app you want to manage. You can find the App ID in the "About" page for your application under the help menu.

--assignee --user-id

ID associated with the user.

Optional Parameters

--api-version --av
Deprecated

Argument 'api_version' has been deprecated and will be removed in a future release.

This command parameter has been deprecated and will be ignored.In the future release, we will only support IoT Central APIs from latest GA version.If any API is not GA yet, we will call latest preview version.

Accepted values: 2022-06-30-preview, 2022-07-31
Default value: 2022-07-31
--central-api-uri --central-dns-suffix

The IoT Central DNS suffix associated with your application.

Default value: azureiotcentral.com
--email

Email address of user to be added to the app. If this is specified, service principal parameters (tenant_id and object_id) will be ignored.

--object-id --oid

Object ID for service principal to be added to the app. Tenant ID must also be specified. If email is specified this gets ignored and the user will not be a service principal user but a standard "email" user.

--roles

Comma-separated list of roles that will be associated with this user. You can specify one of the built-in roles, or specify the role ID of a custom role. See more at https://aka.ms/iotcentral-customrolesdocs. Organizations can be specified alongside roles when running with API version == 1.1-preview. E.g. "organization_id\role".

--tenant-id --tnid

Tenant ID for service principal to be added to the app. Object ID must also be specified. If email is specified this gets ignored and the user will not be a service principal user but a standard "email" user.

--token

If you'd prefer to submit your request without authenticating against the Azure CLI, you can specify a valid user token to authenticate your request. You must specify the type of key as part of the request. Learn more at https://aka.ms/iotcentraldocsapi.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

--output -o

Output format.

Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
Default value: json
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.