updatePortalOwner
updatePortalOwner(OwnerIdSettingsRequestDto)
PUT /api/2.0/settings/owner
Confirm the portal owner change
Completes the portal owner change that POST api/2.0/settings/owner started, making the user named in ownerId the owner of this portal. Authorization comes from the confirmation link in that letter, not from an ordinary session: pass the link's type, key, uid and encemail parameters in the confirm request header, and check with POST api/2.0/authentication/confirm that it is still usable, because it expires after a limited period, seven days by default. A caller without such a link is refused whatever role it holds, and so is a link whose address is no longer the owner's, which is what replaying a used link looks like. The named user has to be an active member of the portal and must not be a guest. The call is mutating: a named user who is not a DocSpace administrator yet is promoted to one first, and a promotion needing a paid seat the portal lacks is refused before ownership moves. The previous owner keeps their account and role but loses the owner's rights, and the change reaches the audit trail. The answer carries no payload: read the new ownerId from GET api/2.0/settings, which needs no token. Only the new owner can start another transfer.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| OwnerIdSettingsRequestDto | body | OwnerIdSettingsRequestDto | [optional] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | The portal owner has been changed to the user named in the request | - | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 400 | The request body cannot be read or has no ownerId | - | - |
| 402 | The user named as the new owner is a regular user, and promoting them to DocSpace administrator needs a paid seat the portal has run out of | - | - |
| 500 | The user named as the new owner cannot be found in this portal, is a guest, or is not active, or the email address the confirmation link was issued for no longer belongs to the portal owner | - | - |
| 401 | Unauthorized | ErrorApiResponse | - |
| 429 | Too Many Requests. | ErrorApiResponse | Retry-After |
| 502 | Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
| 503 | Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
Return type
null (empty response body)
Authorization
Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId
HTTP request headers
- Content-Type: application/json
- Accept: application/json