Update a Tenant Binding
Creates or updates the tenant binding of an account.
Request URL
PUT {base_url}/uc-user/api/v1/accounts/{id}/tenant-binding
Request parameters
- Headers
-
Parameter Required Type Description Authorization Yes String The access token used for authentication. Format: Bearer
{access_token}.x-tenant-code No String The tenant name. Note: You can obtain tenant name using the Query Tenants interface.
- Path parameters
-
Parameter Required Type Description id Yes String The ID of the account (P_ACCOUNT). You can obtain the ID using the Search Resellers interface.
- Body parameters
-
Parameter Required Type Description username Yes String The username of the tenant user, in the format extension number@tenant code.
Response parameters
| Parameter | Type | Description |
|---|---|---|
| requestId | String | The unique ID of the request, which can be used to quickly locate the request. |
| code | String | The HTTP status code of the request.
|
| message | String | The status message of the request. |
| detailMessage | String | The detailed error information. When the request is successful, this parameter returns empty. |
| result | Object<Tenant_Binding> | The tenant binding after the operation. |
- Tenant_Binding
-
Parameter Type Description platformUserId Integer The ID of the platform user. tenantUserId Integer The ID of the tenant user. tenantCode String The code of the tenant. username String The username of the bound tenant user. regionCode String The region code of the bound tenant user. isCurrentRegion Boolean Whether the bound tenant user is in the region of the current request. regionUrl String The entry URL of the region where the bound tenant user is located. customDomain Boolean Whether the region entry uses a custom domain. boundAt Integer The time when the binding was created, in Unix timestamp format (milliseconds).