Automate Member Invites via CreateProjectMember API - DataWorks - Alibaba Cloud - DataWorks

Operation description

You must purchase DataWorks Basic Edition or a higher edition to use this operation.

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:CreateProjectMember

create

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
ProjectId	integer	Yes	The ID of the DataWorks workspace. You can log on to the DataWorks console and go to the Workspace Management page to obtain the ID. This parameter specifies the DataWorks workspace for this API call operation.	24054
UserId	string	Yes	The ID of the DataWorks account. You can log on to the DataWorks console - Management Center, select the workspace to which you want to add a member, go to the Management Center page, and then navigate to the Tenant Members and Roles page to view the account ID of the user you want to add to the workspace.	123422344899
RoleCodes	array	Yes	The list of workspace role codes. You can call ListProjectRoles to obtain the role codes. This parameter is used to grant workspace roles to the member when adding the member to the workspace.
	string	No	The workspace role code.	role_project_guest

Response elements

Element	Type	Description	Example
	object	Schema of Response
RequestId	string	The request ID. Used to locate logs and troubleshoot issues.	2B2F0B26-9253-5780-B6DB-F1A886D44D6F

Examples

Success response

JSON format

{
  "RequestId": "2B2F0B26-9253-5780-B6DB-F1A886D44D6F"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.