Remove Wallet Users

Overview

You can remove users from wallets. If there's more than a 1 wallet admin, removal requires approval by at least 2 admins.

Prerequisites

Steps

bitgo
  .coin('tbtc4')
  .wallets()
  .get({ id: walletId })
  .then(function (wallet) {
    wallet.removeUser({ userId: userId }).then(function (wallet) {
      console.dir(wallet);
    });
  });
DELETE /api/v2/{coin}/wallet/{walletId}/user/{userId}

Step Result

{
  "admin": {
    "policy": {
      "id": "59cd72485007a239fb00282ed480da1f",
      "date": "2019-08-24T14:15:22Z",
      "label": "string",
      "latest": true,
      "rules": [
        {
          "id": "string",
          "lockDate": "2019-08-24T14:15:22Z",
          "mutabilityConstraint": "managed",
          "coin": "btc",
          "type": "advancedWhitelist",
          "condition": {
            "amountString": "2000000",
            "timeWindow": 2678400,
            "groupTags": [
              "59cd72485007a239fb00282ed480da1f"
            ],
            "excludeTags": [
              "59cd72485007a239fb00282ed480da1f"
            ]
          },
          "action": {
            "type": "deny",
            "approvalsRequired": 1,
            "userIds": [
              "59cd72485007a239fb00282ed480da1f"
            ]
          }
        }
      ],
      "version": 0
    }
  },
  "allowBackupKeySigning": true,
  "approvalsRequired": 1,
  "balanceString": "string",
  "buildDefaults": {
    "minFeeRate": 12000
  },
  "coin": "btc",
  "coinSpecific": {
    "creationFailure": [
      "b8a828b98dbf32d9fd1875cbace9640ceb8c82626716b4a64203fdc79bb46d26"
    ],
    "pendingChainInitialization": true,
    "rootAddress": "GCTTCPH4IIDK7P72FFAEJ3ZFN6WDHJH6GGMRPHPM56ZWGIQ7B3XTIJAM",
    "stellarUsername": "[email protected]",
    "homeDomain": "bitgo.com",
    "stellarAddress": "[email protected]*bitgo.com"
  },
  "custodialWallet": {},
  "custodialWalletId": "59cd72485007a239fb00282ed480da1f",
  "deleted": true,
  "disableTransactionNotifications": true,
  "enterprise": "59cd72485007a239fb00282ed480da1f",
  "freeze": {
    "time": "string",
    "expires": "string"
  },
  "id": "59cd72485007a239fb00282ed480da1f",
  "isCold": true,
  "keys": [
    "585951a5df8380e0e304a553",
    "585951a5df8380e0e30d645c",
    "585951a5df8380e0e30b6147"
  ],
  "label": "My Wallet",
  "m": 2,
  "n": 3,
  "nodeId": "59cd72485007a239fb00282ed480da1f",
  "receiveAddress": {
    "id": "59cd72485007a239fb00282ed480da1f",
    "address": "2MvrwRYBAuRtPTiZ5MyKg42Ke55W3fZJfZS",
    "chain": 1,
    "index": 0,
    "coin": "string",
    "lastNonce": -1,
    "wallet": "59cd72485007a239fb00282ed480da1f",
    "coinSpecific": {
      "xlm": {
        "memoId": "2000000",
        "rootAddress": "GCTTCPH4IIDK7P72FFAEJ3ZFN6WDHJH6GGMRPHPM56ZWGIQ7B3XTIJAM"
      },
      "txlm": {
        "memoId": "2000000",
        "rootAddress": "GCTTCPH4IIDK7P72FFAEJ3ZFN6WDHJH6GGMRPHPM56ZWGIQ7B3XTIJAM"
      }
    },
    "balance": {
      "updated": "2019-08-24T14:15:22Z",
      "balance": 50000,
      "balanceString": "50000",
      "totalReceived": 0,
      "totalSent": 0,
      "confirmedBalanceString": "40000",
      "spendableBalanceString": "40000"
    },
    "label": "Bob's Hot Wallet Address",
    "addressType": "p2sh"
  },
  "recoverable": true,
  "tags": [
    "59cd72485007a239fb00282ed480da1f"
  ],
  "spendableBalanceString": "string",
  "startDate": "string",
  "type": "cold",
  "users": [
    {
      "user": "55e8a1a5df8380e0e30e20c6",
      "permissions": [
        "admin",
        "view",
        "spend"
      ]
    }
  ],
  "customChangeKeySignatures": {
    "user": "string",
    "backup": "string",
    "bitgo": "string"
  },
  "multisigType": "onchain"
}

See Also

API Reference: Remove user from Wallet