- Development Integration
- /
- SDK
- /
- Python
- /
Management Module
- /
Custom Field Management
- /
- Set Custom Field Value
¶ Set the value of the custom field
Update time: 2025-07-23 07:34:21
This document is automatically generated based on https://github.com/authing/authing-docs-factory based on the https://api-explorer.genauth.ai V3 API, and is consistent with the API parameters and return results. If this document description is incorrect, please refer to the V3 API.
Set the value of the custom field for the user, role or department. If it exists, update it, and if it does not exist, create it.
¶ Method name
ManagementClient.set_custom_data
¶ Request parameters
| Name | Type | Required | Default value | Description | Sample value |
|---|---|---|---|---|---|
| list | SetCustomDataDto[] | Yes | - | Custom data list Array length limit: 50. | |
| targetIdentifier | string | yes | - | Unique identifier of the target object: - If it is a user, it is the user's ID, such as 6343b98b7cfxxx9366e9b7c- If it is a role, it is the role's code, such as admin- If it is a group, it is the group's code, such as developer- If it is a department, it is the department's ID, such as 6343bafc019xxxx889206c4c | userId1 |
| targetType | string | yes | - | Target object type: - USER: user- ROLE: role- GROUP: group- DEPARTMENT: department | USER |
| tenantId | string | no | - | Tenant ID | 642c1df417c2d8a80d744c1d |
| namespace | string | No | - | The code of the permission group. This field is required when target_type is role. Otherwise, it can be ignored. | default |
¶ Request Response
Type: IsSuccessRespDto
| Name | Type | Description |
|---|---|---|
| statusCode | number | Business status code, which can be used to determine whether the operation is successful. 200 means success. |
| message | string | Description |
| apiCode | number | Segmented error code, which can be used to get the specific error type (successful request does not return). For a detailed list of error codes, please see: API Code List (opens new window) |
| requestId | string | Request ID. Returned when the request fails. |
| data | IsSuccessDto | Whether the operation is successful |
Example results:
{
"statusCode": 200,
"message": "Success",
"requestId": "934108e5-9fbf-4d24-8da1-c330328abd6c",
"data": {
"success": true
}
}
¶ Data Structure
¶ SetCustomDataDto
| Name | Type | Is it required? | Description | Sample value |
|---|---|---|---|---|
| tenantId | string | No | Tenant ID | 642c1df417c2d8a80d744c1d |
| key | string | Yes | Field key, cannot conflict with the key of built-in fields | school |
| value | string | Yes | Custom data, can be of any type, but must match the custom field type defined when creating, otherwise the setting will fail | pku |
¶ IsSuccessDto
| Name | Type | Is it required? | Description | Sample value |
|---|---|---|---|---|
| success | boolean | yes | Whether the operation was successful | true |