Skip to main content

SuccessionTransferResponse

Response for POST /admin/users/{user_id}/succession/transfer.

user_idUser Id (string)required
results object[]
  • Array [
    • resource_typeResource Type (string)required
    resource_idResource Id (string)required
    successor_idSuccessor Id (string)required
    statusStatus (string)required

    Possible values: [transferred, skipped, failed]

    error_code object
    anyOf
    string
    message object
    anyOf
    string
    collection_role_granted object
    anyOf
    string
    run_as_clearedRun As Cleared (boolean)
    Default value: false
    redeployedRedeployed (boolean)
    Default value: false
  • ]
    • SuccessionTransferResponse
    {
      "user_id": "string",
      "results": [
        {
          "resource_type": "string",
          "resource_id": "string",
          "successor_id": "string",
          "status": "transferred",
          "error_code": "string",
          "message": "string",
          "collection_role_granted": "string",
          "run_as_cleared": false,
          "redeployed": false
        }
      ]
    }