All Products
Search

This Product

    DataWorks:CreateProjectMember

    Document Center

    DataWorks:CreateProjectMember

    Last Updated:May 06, 2024

    Adds a user to a DataWorks workspace.

    Debugging

    OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

    Request parameters

    Parameter

    Type

    Required

    Example

    Description

    Action

    String

    Yes

    CreateProjectMember

    The operation that you want to perform. Set the value to CreateProjectMember.

    ProjectId

    Long

    Yes

    27

    The DataWorks workspace ID.

    UserId

    String

    Yes

    1234

    The ID of the user to be added.

    ClientToken

    String

    No

    1AFAE64E-D1BE-432B-A9****

    The client token that is used to ensure the idempotence of the request. We recommend that you set this parameter to a UUID.

    RoleCode

    String

    No

    role_project_guest

    The code of the role. This parameter is optional. If you configure the RoleCode parameter, the user is assigned the role.

    Response parameters

    Parameter

    Type

    Example

    Description

    RequestId

    String

    1AFAE64E-D1BE-432B-A9****

    The request ID.

    Examples

    Sample requests

    http(s)://[Endpoint]/?Action=CreateProjectMember
&ProjectId=27
&UserId=1234
&ClientToken=1AFAE64E-D1BE-432B-A9****
&RoleCode=role_project_guest
&<Common request parameters>

    Sample success responses

    XML format

    HTTP/1.1 200 OK
Content-Type:application/xml

<CreateProjectMemberResponse>
    <RequestId>1AFAE64E-D1BE-432B-A9****</RequestId>
</CreateProjectMemberResponse>

    JSON format

    HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "1AFAE64E-D1BE-432B-A9****"
}

    Error codes

    HTTP status code

    Error code

    Error message

    Description

    400

    Invalid.Tenant.ConnectionNotExists

    The connection does not exist.

    The specified data source does not exist.

    400

    Invalid.Tenant.ProjectNotExists

    The project does not exist.

    The specified workspace does not exist.

    400

    Invalid.Tenant.UserNotInProject

    The user is not in the project.

    The user is not added to the workspace.

    400

    Invalid.Tenant.UserAlreadyInProject

    The user already exists in the project.

    The user that you want to add is in the workspace.

    400

    Invalid.Tenant.UserNotInTenant

    The user is not in the tenant.

    The member that you want to add does not belong to the tenant.

    403

    Invalid.Tenant.UserIsNotProjectOwnerOrAdmin

    The user is not a project administrator or owner.

    The user is not the workspace owner or administrator.

    403

    Invalid.Tenant.UserNotInTenant

    The user is not in tenant.

    The user does not belong to the tenant.

    For a list of error codes, see Service error codes.