All Products
Search

This Product

    DataWorks:DsgUserGroupAddOrUpdate

    Document Center

    DataWorks:DsgUserGroupAddOrUpdate

    Last Updated:Mar 23, 2026

    Creates or updates a user group in Data Security Guard.

    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

    dataworks:DsgUserGroupAddOrUpdate

    list

    *All Resource

    *

    		 None None

    Request parameters

    Parameter

    Type

    Required

    Description

    Example
    UserGroups

    array<object>

    Yes

    The user groups.

    object

    Yes

    The user group.

    Id

    integer

    No

    The ID of the user group.

    • If you do not specify this parameter, a new user group is created.

    • If you specify this parameter, the specified user group is modified. You can call the DsgUserGroupQueryList operation to query the ID of the user group.

    123
    Name

    string

    Yes

    The name of the user group.

    yun_group
    Owner

    string

    Yes

    The owner of the user group.

    user1
    Accounts

    array

    No

    The users in the user group.

    • For user groups created based on Alibaba Cloud accounts and Resource Access Management (RAM) roles, call the DsgUserGroupQueryUserList API to query the user list.

    • For user groups created based on MaxCompute roles, call the DsgUserGroupGetOdpsRoleGroups API to query the user list.

    string

    No

    Enter a username or a MaxCompute Role. This parameter is set based on the value of the UserGroupType parameter.

    user1
    ProjectName

    string

    No

    The name of the MaxCompute project. Set this parameter when you create a MaxCompute user group.

    dev_project
    UserGroupType

    integer

    Yes

    The type of the user group. The following values are valid:

    • 1: Alibaba Cloud user

    • 2: RAM Role

    • 3: MaxCompute Role

    1
    projects

    string

    No

    Response elements

    Element

    Type

    Description

    Example

    object

    OpenApiResultModel

    Success

    boolean

    Indicates whether the request succeeded. Valid values:

    • true: The request succeeded.

    • false: The request failed.

    true
    ErrorCode

    string

    The error code that is returned if the request fails.

    1029030003
    ErrorMessage

    string

    The error message that is returned if the request fails.

    param error
    HttpStatusCode

    integer

    The HTTP status code.

    400
    Data

    boolean

    The result of the operation. Valid values:

    • true: The operation succeeded.

    • false: The operation failed.

    true
    RequestId

    string

    The ID of the request. This is a common parameter. We recommend that you save this ID. If an issue occurs, you can use the ID to locate logs for troubleshooting.

    102400001

    Examples

    Success response

    JSON format

    {
  "Success": true,
  "ErrorCode": "1029030003",
  "ErrorMessage": "param error",
  "HttpStatusCode": 400,
  "Data": true,
  "RequestId": "102400001"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description
    400 USERGROUP.ACCOUNTLISTSIZE.ERROR The number of account exceeds the limit. The number of users exceeds the limit
    400 USERGROUP.ID.ERROR The user group ID does not match the tenant or does not exist. The user group ID does not exist or does not belong to the tenant.
    400 USERGROUP.LISTSIZE.ERROR The number of user groups exceeds the limit. The number of user groups exceeds the limit
    400 USERGROUP.PAGESIZE.ERROR Page size is too large, maximum of 100. Page size limit, up to 100
    400 USERACCOUNT.OWNER.ERROR User list or owner user does not exist. User list or responsible user does not exist
    400 PARAMS.ERROR param error.
    500 UNKNOWN.ERROR unknown error. Unknown error.
    403 PERMISSION.DENIED.ERROR Permission denied Insufficient permissions.

    See Error Codes for a complete list.

    Release notes

    See Release Notes for a complete list.