Help Center/ CodeArts Repo/ API Reference/ APIs/ V4/ Member/ Adding Repository Members in Batches
Updated on 2026-01-27 GMT+08:00
View PDF
Share

Adding Repository Members in Batches

Function

This API is used to add repository members in batches.

Debugging

You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.

Authorization Information

Each account root user has all the permissions required to call all APIs, but IAM users must be assigned the following required identity policy-based permissions. For details about the required permissions, see Permissions Policies and Supported Actions.

Action

Access Level

Resource Type (*: required)

Condition Key

Alias

Dependencies

codeartsrepo:repository:createMembers

Write

-

-

-

-

URI

POST https://{hostURL}/v4/repositories/{repository_id}/members

Table 1 Path Parameters

Parameter

Mandatory

Type

Description

repository_id

Yes

Integer

Definition

You can query the project list to obtain the repository ID by calling the API used to query user's all repositories.

Constraints

N/A

Default Value

N/A

Value range:

1~2147483647

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

Definition

User token. Obtain one by calling the IAM API Obtaining a User Token. The value of X-Subject-Token in the response header is a token.

Constraints

N/A

Range

1–100,000 characters.

Default Value

N/A
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

users

Yes

Array of CreateRepositoryMemberDto objects

Definition

Member information list.
Table 4 CreateRepositoryMemberDto

Parameter

Mandatory

Type

Description

user_iam_id

No

String

Definition

IAM user ID

Constraints

N/A.

user_name

No

String

Definition

Username.

Constraints

N/A.

tenant_name

No

String

Definition

Tenant name.

Constraints

  • N/A.

tenant_id

No

String

Definition

Tenant ID.

Constraints

  • N/A.

repository_role_Id

No

String

Definition

Role ID.

Constraints

  • N/A.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

[items]

Array of BatchCreateRepositoryMemberDto objects

Response to the request for creating members in batches.
Table 6 BatchCreateRepositoryMemberDto

Parameter

Type

Description

status

String

Definition

Whether batch member addition is successful.

Constraints

  • success: all members are added successfully.

  • error: not all members are added.

result

Array of CreateRepositoryMemberResponseDto objects

Definition

Batch addition result details.

Constraints

N/A.
Table 7 CreateRepositoryMemberResponseDto

Parameter

Type

Description

user_iam_id

String

Definition

IAM user ID.

Constraints

N/A.

user_name

String

Definition

Username.

Constraints

N/A.

tenant_name

String

Definition

Tenant name.

Constraints

  • N/A.

user_nick_name

String

Definition

User alias.

Constraints

  • N/A.

status

String

Definition

Role ID.

Constraints

Constraints

  • success: adding succeeded.

  • error: adding failed.

message

String

Definition

Member adding result.

Constraints

  • N/A.

Status code: 401

Table 8 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 403

Table 9 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Status code: 404

Table 10 Response body parameters

Parameter

Type

Description

error_code

String

Definition

Error code.

error_msg

String

Definition

Error message.

Example Requests

PUT https://{endpoint}/v4/repositories/1/members

{
  "users" : [ {
    "user_iam_id" : "9ce763c569e54df38804944fe597ba72",
    "user_name" : "test_name",
    "repository_role_Id" : "9ce763c569e54df38804944fe597ba72",
    "tenant_name" : "tenant_example",
    "tenant_id" : "159b65b41ead484d8ddff250a4731781"
  } ]
}

Example Responses

Status code: 200

Add repository members in batches.

{
  "result" : [ {
    "user_iam_id" : "9ce763c569e54df38804944fe597ba72",
    "user_name" : "test_name",
    "user_nick_name" : "nicekName",
    "tenant_name" : "tenant_example",
    "status" : "success",
    "message" : "Members added."
  } ],
  "status" : "success"
}

Status code: 401

Unauthorized

{
  "error_code" : "CH.00000001",
  "error_msg" : "User authentication info not found."
}

Status code: 403

Bad Request

{
  "error_code" : "CH.00401008",
  "error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
}

Status code: 404

Not Found

{
  "error_code" : "CH.00402000",
  "error_msg" : "The repository does not exist. Check and try again."
}

Status Codes

Status Code

Description

200

Add repository members in batches.

401

Unauthorized

403

Bad Request

404

Not Found

Error Codes

See Error Codes.

Parent topic: Member