DocsICP FilingConsole
Documentation

UpdateUserDevicesSharingStatus

Updated at:
Copy as MD
Product
My Favorites

Updates the sharing status of devices for multiple enterprise users.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

  • Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.

  • API: The API that you can call to perform the action.

  • Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.

  • Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.

    • For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.

    • For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.

  • Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.

  • Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

csas:UpdateUserDevicesSharingStatus

update

*All Resource

*

 None None

Request parameters

Parameter

Type

Required

Description

Example
DeviceTags

array

Yes

Collection of device IDs.

string

No

Device ID. Values:

36efa42d-2c32-c4dc-e3fc-8541e33a****

SharingStatus

boolean

Yes

Indicates whether device sharing is enabled. Values:

  • true: Enable sharing.

  • false: Disable sharing.

Valid values:

  • true :

    Enable sharing

  • false :

    Disable sharing

true

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

4D169859-A4F2-5EC8-853B-8447787C0D8A
Devices

array<object>

Device list.

array<object>

Device.

DeviceTag

string

Device ID.

36efa42d-2c32-c4dc-e3fc-8541e33a****
DeviceType

string

The operating system type of the device. Values:

  • Windows: Windows system.

  • macOS: macOS system.

  • Linux: Linux system.

  • Android: Android system.

  • iOS: iOS system.

  • Windows_Wuying: Wuying Cloud Desktop system.

Valid values:

  • Linux :

    Linux system

  • Windows_Wuying :

    Wuying Cloud Desktop system

  • Windows :

    Windows system

  • iOS :

    iOS system

  • macOS :

    macOS system

  • Android :

    Android system

Windows
DeviceModel

string

Device model.

MacBookPro17,1
DeviceVersion

string

Device operating system version.

3.5.1
Hostname

string

Device name.

win10-64bit
Username

string

Username.

王先生
SaseUserId

string

User ID.

su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****
Department

string

User's department.

测试部
InnerIP

string

Device private network IP address.

192.168.XX.XX
SrcIP

string

Device logon IP address.

11.49.XX.XX
Memory

string

Device memory capacity. Unit: GB.

16
CPU

string

Device CPU model.

Apple M1
Disk

string

Device disk model.

APPLE SSD AP0512Q Media
Mac

string

Device MAC address.

00:16:XX:XX:7c:46
AppVersion

string

Client version.

2.2.0
DeviceBelong

string

Device ownership. Values:

  • Personal: Personal device.

  • Company: Company device.

Valid values:

  • Company :

    Company device

  • Personal :

    Personal device

Company
SharingStatus

boolean

Indicates whether device sharing is enabled. Values:

  • true: Enable sharing.

  • false: Disable sharing.

Valid values:

  • true :

    Enable sharing

  • false :

    Disable sharing

true
DeviceStatus

string

The status of the device. Values:

  • Online: Online.

  • Offline: Offline.

  • LongTermOffline: Long-term offline.

  • Locked: Locked.

  • Lost: Lost.

  • Unbound: Unbound.

Valid values:

  • Lost :

    Lost

  • Locked :

    Locked

  • LongTermOffline :

    Long-term offline

  • Offline :

    Offline

  • Online :

    Online

Online
AppStatus

string

The client status. Values:

  • Online: Online.

  • Offline: Offline.

Valid values:

  • Offline :

    Offline

  • Online :

    Online

Online
PaStatus

string

Private network access status. Values:

  • Enabled: Enabled.

  • Disabled: Disabled.

  • Unprovisioned: Unprovisioned.

Valid values:

  • Enabled :

    Enabled

  • Disabled :

    Disabled

  • Unprovisioned :

    Unprovisioned

Enabled
IaStatus

string

Internet access status. Values:

  • Enabled: Enabled.

  • Disabled: Disabled.

  • Unprovisioned: Unprovisioned.

Valid values:

  • Enabled :

    Enabled

  • Disabled :

    Disabled

  • Unprovisioned :

    Unprovisioned

Enabled
DlpStatus

string

Data protection status. Values:

  • Enabled: Enabled.

  • Disabled: Disabled.

  • Unprovisioned: Unprovisioned.

  • Unauthorized: Unauthorized.

Valid values:

  • Enabled :

    Enabled

  • Unauthorized :

    Unauthorized

  • Disabled :

    Disabled

  • Unprovisioned :

    Unprovisioned

Enabled
NacStatus

string

Network access control status. Values:

  • Enabled: Enabled.

  • Disabled: Disabled.

  • Unprovisioned: Unprovisioned.

Valid values:

  • Enabled :

    Enabled

  • Disabled :

    Disabled

  • Unprovisioned :

    Unprovisioned

Enabled
CreateTime

string

Device registration time.

2023-05-16 17:18:46
UpdateTime

string

Device last online time.

2023-08-24 19:04:42
NetInterfaceInfo

array<object>

NIC list.

object

NIC.

Name

string

NIC name.

eth0
Mac

string

NIC MAC address.

00:16:XX:XX:7c:46

Examples

Success response

JSON format

{
  "RequestId": "4D169859-A4F2-5EC8-853B-8447787C0D8A",
  "Devices": [
    {
      "DeviceTag": "36efa42d-2c32-c4dc-e3fc-8541e33a****",
      "DeviceType": "Windows",
      "DeviceModel": "MacBookPro17,1",
      "DeviceVersion": "3.5.1",
      "Hostname": "win10-64bit",
      "Username": "王先生",
      "SaseUserId": "su_e8f218fb171edd167c2ad917d21f53148bdefc510ca1f3c3cc0249d3643d****",
      "Department": "测试部",
      "InnerIP": "192.168.XX.XX",
      "SrcIP": "11.49.XX.XX",
      "Memory": "16",
      "CPU": "Apple M1",
      "Disk": "APPLE SSD AP0512Q Media",
      "Mac": "00:16:XX:XX:7c:46",
      "AppVersion": "2.2.0",
      "DeviceBelong": "Company",
      "SharingStatus": true,
      "DeviceStatus": "Online",
      "AppStatus": "Online",
      "PaStatus": "Enabled",
      "IaStatus": "Enabled",
      "DlpStatus": "Enabled",
      "NacStatus": "Enabled",
      "CreateTime": "2023-05-16 17:18:46",
      "UpdateTime": "2023-08-24 19:04:42",
      "NetInterfaceInfo": [
        {
          "Name": "eth0",
          "Mac": "00:16:XX:XX:7c:46"
        }
      ]
    }
  ]
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.