Clusters

Transfer cluster ownership

Transfer the ownership of the Cluster to a user, a group or an cluster member.

Return a 404 HTTP Error if Cluster cannot be found.

User must have the CLUSTER_MEMBER[UPDATE] permission.

post/clusters/{clusterId}/members/_transfer-ownership

Request

  • Base URL
    /management/v2/environments/DEFAULT (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /management/v2/environments/DEFAULT/clusters/{clusterId}/members/_transfer-ownership
  • Auth
    • HTTP basic
    • or API key in cookie Auth-Graviteeio-APIM

Request body

newPrimaryOwnerIdstring

The new primary owner ID (user's technical identifier). Can be null if userReference is defined.

userReferencestring

The new primary owner reference (user's reference provided by an identity provider). Can be null if userId is defined.

currentPrimaryOwnerNewRolestring

The name of the role that will be assigned to the current primary owner after the transfer.

Response

Ownership has been transferred successfully

Changes

No recorded changes to this operation across all 65 revisions of this API.