All Products
Search
Document Center

Data Management:AddUserToDataAgentWorkspace

Last Updated:Jan 07, 2026

Adds a user to a specified workspace.

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

No authorization for this operation. If you encounter issues with this operation, contact technical support.

Request syntax

POST  HTTP/1.1

Request parameters

Parameter

Type

Required

Description

Example

DMSUnit

string

No

The current DMS unit.

cn-hangzhou

WorkspaceId

string

No

The workspace ID.

20923*****7291

MemberId

string

No

The Alibaba Cloud UID of the user.

20282*****7591

RoleName

string

No

The name of the user's role in the workspace.

admin

Response elements

Element

Type

Description

Example

object

Schema of Response

RequestId

string

The request ID.

67E910F2-***-695C

Success

boolean

Indicates whether the request was successful.

true

ErrorCode

string

The error code.

DMS-DA-40114

ErrorMessage

string

The error message.

Specified parameter is not valid.

Data

object

The returned struct.

MemberId

string

The Alibaba Cloud UID of the user.

20282*****7591

UserName

string

The RAM username.

agentTest

RoleName

string

The name of the user's role in the workspace.

admin

JoinTime

integer

The time when the user joined the workspace. This is a UNIX timestamp in seconds.

1765960516

RunningTaskNumber

integer

The number of tasks that the user is running in the workspace.

2

TotalTaskNumber

integer

The total number of tasks that the user initiated in the workspace.

5

Examples

Success response

JSON format

{
  "RequestId": "67E910F2-***-695C",
  "Success": true,
  "ErrorCode": "DMS-DA-40114",
  "ErrorMessage": "Specified parameter is not valid.",
  "Data": {
    "MemberId": "20282*****7591",
    "UserName": "agentTest",
    "RoleName": "admin",
    "JoinTime": 1765960516,
    "RunningTaskNumber": 2,
    "TotalTaskNumber": 5
  }
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.