Obtaining Project Member Settings
Function
This API is used to obtain project member settings.
Debugging
You can debug this API through automatic authentication in API Explorer or use the SDK sample code generated by API Explorer.
URI
GET https://{hostURL}/v4/projects/{project_id}/member-setting
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| project_id | Yes | String | Definition: You can obtain the unique project identifier, 32-character UUID, by calling the API used to query the project list. Value range: 32 characters |
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| offset | No | Integer | Definition Offset, which starts from 0. Value range: 0~2147483647 Default value: 0 |
| limit | No | Integer | Definition Number of returned records. Value range: 1~100 Default value: 20 |
Request Parameters
| Parameter | Mandatory | Type | Description |
|---|---|---|---|
| X-Auth-Token | Yes | String | Definition User token. Obtain a token by calling the IAM API for obtaining a user token. The value of X-Subject-Token in the response header is the user token. Constraints Mandatory. Range 1–100,000 characters. Default Value N/A. |
Response Parameters
Status code: 200
| Parameter | Type | Description |
|---|---|---|
| product_id | String | Definition: Project ID Value range: 1–1,000 characters. |
| sync_enabled | Boolean | Definition: Synchronization switch |
| sync_all_role_enabled | Boolean | Definition: Switch for synchronizing all roles |
| role_sync | Array of RoleSyncDto objects | Definition: Role synchronization |
| Parameter | Type | Description |
|---|---|---|
| id | Integer | Definition Role record ID. Value range: 1~2147483647 |
| role_id | String | Definition Role ID. Range 1–1,000 characters. |
| role_sync_enabled | Boolean | Definition Role synchronization switch. |
| role_name | String | Definition Role name. Range 1–1,000 characters. |
| role_type | String | Definition Role type. Range 1–1,000 characters. |
| role_chinese_name | String | Definition Role name in Chinese. Range 1–1,000 characters. |
| created_at | String | Definition Creation time. Range 1–1,000 characters. |
| updated_at | String | Definition Update time. Range 1–1,000 characters. |
Status code: 401
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition Error code. |
| error_msg | String | Definition Error message. |
Status code: 403
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition Error code. |
| error_msg | String | Definition Error message. |
Status code: 404
| Parameter | Type | Description |
|---|---|---|
| error_code | String | Definition Error code. |
| error_msg | String | Definition Error message. |
Example Requests
GET https://{endpoint}/v4/projects/{project_id}/member-setting?offset=1&limit=20 Example Responses
Status code: 200
Obtain project member settings.
{
"product_id" : "66d26441a9a24158af9db7603f1e0937",
"sync_enabled" : true,
"role_sync" : [ {
"id" : 11588179,
"role_id" : "d4b6fd9af7e34b168de2fef683058f13",
"role_sync_enabled" : true,
"role_name" : "Project manager",
"role_type" : "template-customized-inst",
"role_chinese_name" : "Project manager",
"created_at" : 1745289920273,
"updated_at" : 1745289920273
}, {
"id" : 11588178,
"role_id" : "f7b9f99aa0d94dc595aef01d2ed661a9",
"role_sync_enabled" : false,
"role_name" : "Product manager",
"role_type" : "template-customized-inst",
"role_chinese_name" : "Product manager",
"created_at" : 1745289920268,
"updated_at" : 1745289920268
} ]
} Status code: 401
Unauthorized
{
"error_code" : "DEV.00000003",
"error_msg" : "Authentication information expired."
} Status code: 403
Bad Request
{
"error_code" : "CH.004403",
"error_msg" : "Insufficient permissions. Apply for the required permissions and try again."
} Status code: 404
Not Found
{
"error_code" : "CH.004404",
"error_msg" : "Group Not Found. Group Not Found"
} Status Codes
| Status Code | Description |
|---|---|
| 200 | Obtain project member settings. |
| 401 | Unauthorized |
| 403 | Bad Request |
| 404 | Not Found |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.
