All Products
Search
Document Center

DataWorks:DsgUserGroupDelete

Last Updated:Nov 21, 2024

Deletes a user group configured in Data Security Guard.

Debugging

You can run this interface directly in OpenAPI Explorer, saving you the trouble of calculating signatures. After running successfully, OpenAPI Explorer can automatically generate SDK code samples.

Authorization information

The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:

  • Operation: the value that you can use in the Action element to specify the operation on a resource.
  • Access level: the access level of each operation. The levels are read, write, and list.
  • Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
    • The required resource types are displayed in bold characters.
    • If the permissions cannot be granted at the resource level, All Resources is used in the Resource type column of the operation.
  • Condition Key: the condition key that is defined by the cloud service.
  • Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
OperationAccess levelResource typeCondition keyAssociated operation
dataworks:DsgUserGroupDeletelist
*All Resources
*
    none
none

Request parameters

ParameterTypeRequiredDescriptionExample
IdsarrayNo

The information about the user group.

longNo

The user group ID. You can call the DsgUserGroupQueryList operation to query the user group ID.

123

Response parameters

ParameterTypeDescriptionExample
object

OpenApiResultModel

Successboolean

Indicates whether the request was successful. Valid values:

  • true
  • false
true
ErrorCodestring

The error code.

1029030003
ErrorMessagestring

The error message.

param error
HttpStatusCodeinteger

The HTTP status code.

400
Databoolean

The operation result. Valid values:

  • true: The user group is deleted.
  • false: The user group fails to be deleted.
true
RequestIdstring

The request ID. You can locate logs and troubleshoot issues based on the ID.

102400001

Examples

Sample success responses

JSONformat

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

Error codes

HTTP status codeError codeError messageDescription
400USERGROUP.ACCOUNTLISTSIZE.ERRORThe number of account exceeds the limit.The number of users exceeds the limit
400USERGROUP.ID.ERRORThe 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.
400USERGROUP.LISTSIZE.ERRORThe number of user groups exceeds the limit.The number of user groups exceeds the limit
400USERGROUP.PAGESIZE.ERRORPage size is too large, maximum of 100.Page size limit, up to 100
400USERACCOUNT.OWNER.ERRORUser list or owner user does not exist.User list or responsible user does not exist
400PARAMS.ERRORparam error.-
403PERMISSION.DENIED.ERRORPermission deniedInsufficient permissions.
500UNKNOWN.ERRORunknown error.Unknown error.

For a list of error codes, visit the Service error codes.