LogoLogo
⮐ Keeper HomeAll DocumentationAdmin Console
エンタープライズガイド (企業、組織向け)
エンタープライズガイド (企業、組織向け)
  • はじめに
  • トライアルを開始
  • 資料
  • スモールビジネス (小規模組織) 向けKeeper
  • Keeperエンタープライズについて
  • 導入の概要
  • ドメインの予約
  • Keeperをエンドユーザーにデプロイ
    • Keeperデスクトップアプリケーション
      • コンピュータの起動時にKeeperを起動
    • フォースフィールド
    • KeeperFillブラウザ拡張機能
      • Mac
        • PLIST (.plist) ポリシーの展開
          • Jamf Proでのポリシーの展開 - Chrome
          • Microsoft Intuneポリシーの展開 - Chrome
      • Linux
        • JSONポリシーの展開 - Chrome
      • Windows
        • グループポリシーの展開 - Chrome
        • グループポリシーの展開 - Firefox
        • グループポリシーの展開 - Edge
        • SCCMでの展開 - Chrome
        • Intune - Chrome
        • Intune - Edge
        • Edge設定ポリシー
        • Chrome設定ポリシー
      • 仮想マシンの永続化
    • モバイルアプリケーション
      • IBM MaaS360
    • オプションの展開タスク
    • IE11信頼済みサイト
  • エンドユーザーガイド
  • Keeper管理コンソールの概要
  • ノードと組織構造
  • リスク管理ダッシュボード
  • ユーザーとチームのプロビジョニング
    • 招待メールとロゴのカスタマイズム
      • カスタムEメールでのマークダウン記法
    • 管理コンソールでの手動プロビジョニング
    • Active Directoryでのプロビジョニング
    • LDAPでのプロビジョニング
    • SSO JIT (ジャストインタイム) プロビジョニング
    • Oktaでのプロビジョニング
    • Azure / Entra IDでのプロビジョニング
    • Google Workspaceでのプロビジョニング
    • JumpCloudでのプロビジョニング
    • CloudGateでのプロビジョニング
    • OneLoginでのプロビジョニング
    • Microsoft AD FSでのプロビジョニング
    • SCIMを使用したAPIのプロビジョニング
      • SCIM APIプロビジョニングの使用
    • チームとユーザーの承認
    • メールアドレスで自動プロビジョニング
    • コマンダーSDKを使用したCLIのプロビジョニング
  • SSO/SAML認証
  • ユーザー管理とライフサイクル
  • メールアドレスの変更
  • ロール単位のアクセス権限設定
    • 強制適用ポリシー
    • セキュリティキー
  • 管理権限の委任
  • アカウント移管ポリシー
  • チーム (グループ)
  • 共有
    • レコードとファイルの共有
    • 共有フォルダ
    • PAMリソースの共有
    • ワンタイム共有
    • 共有管理機能
    • 時間制限付きアクセス
    • 自動消滅レコード
    • パスワードを隠す
  • レコードの作成
  • データのインポート
  • レコードタイプ
  • 二要素認証
  • 二要素認証コードの保存
  • セキュリティ監査
    • セキュリティ監査スコアの算出方法
  • BreachWatch (ダークウェブ)
  • ファイルストレージ
  • レポート作成、アラート、SIEM
    • イベント詳細
    • Splunk
    • Sumo Logic
    • Exabeam (LogRhythm)
    • Syslog
    • QRadar
    • Azure Sentinel
    • Azure Monitor
    • AWS S3バケット
    • Devo
    • Datadog
    • Logz.io
    • Elastic
    • ファイアウォールの設定
    • コマンダーによるオンサイトプッシュ通知
  • 推奨アラート
  • Webhooks (SlackおよびTeams)
    • Slack Webhook
    • Teams Webhook
    • Amazon Chime Webhook
    • Discord Webhook
  • コンプライアンスレポート
  • ボルトへのオフラインアクセス
  • シークレットマネージャー
  • コマンダーCLI
  • Keeperコネクションマネージャー
  • KeeperPAM特権アクセス管理
  • Keeperフォースフィールド
  • Keeper MSP
    • 無料トライアル
    • はじめに
    • 基本
    • 使用量に基づく請求
      • アドオン
      • 既存のMSP管理者
    • 導入
    • PSA 請求リコンサイル (照合)
    • Slackチャンネルに参加
    • 次のステップ
    • 削除
    • コマンダーCLI/SDK
    • アカウント管理API
    • API利用プロビジョニング家族プラン
    • MSPのベストプラクティス
  • 個人使用のための家族向け無料ライセンス
    • API経由で家族向けプランを提供
    • API経由での学生プランの提供
    • APIトラブルシューティング
      • APIパラメータ
      • APIレスポンスコード
      • APIエクスプローラ - Swagger
  • セキュリティの推奨設定
  • KeeperのIPをホワイトリスト化
  • Keeperの暗号化モデル
  • 開発者用API/SDKツール
  • KeeperChat
  • オンプレミスとクラウド
  • 認証フローV3
  • LastPassからの移行
  • トレーニングとサポート
  • LMS用Keeper SCORMファイル
  • ドキュメントホーム
Powered by GitBook
On this page
  1. Keeper MSP

アカウント管理API

MSPやディストリビューターがアカウントを管理するためのAPI

PreviousコマンダーCLI/SDKNextAPI利用プロビジョニング家族プラン

Last updated 1 month ago

これらのAPIはMSPアカウントのディストリビューターにのみ適用されます。ほとんどのMSPは、コマンダーの「」コマンドを使用して企業を管理できます。

APIの機能

APIで実現する主なユースケースは以下の通りです。

  • 試用版アカウントを作成

  • 有料アカウントへ変換

  • MSPをすべて一覧表示

  • 現在の使用状況を取得

  • 月間の使用量を取得

  • 有料アカウントを取り消し

  • 期限切れのアカウントを有効化

  • MSP製品を一覧表示

  • 保留中/競合するアカウントの削除

MSP固有のAPIにアクセスするには、サポート担当者までお問い合わせください。APIキーはKeeperレコードでシークレットキーとして共有されます。

API定義

事前共有シークレットからJSON Web Tokenを作成する

アクセスが要求された後、KeeperからAPIを使用するために必要な情報を含むレコードを共有します。上記のAPIメソッドを使用するにはJWTを作成する必要があります。以下の例では、「iat」と「exp」は5分間隔になっています。以下のコードは、ウェブリクエストで必要なトークンを生成するものです。

 System.out.println(LocalDateTime.now().toEpochSecond(ZoneOffset.UTC));
       System.out.println(LocalDateTime.now().plusMinutes(5).toEpochSecond(ZoneOffset.UTC));

JWTスクリプトのサンプル例

以下のスクリプトでJWTが正しく生成されます。create-trial-accountPOSTに必要なデータが含まれています。

var jwt = require('jsonwebtoken');
var request = require('request');
var rightnowTimeStampInSeconds = Math.floor(Date.now() / 1000);
jwt.sign({
    "iat": rightnowTimeStampInSeconds ,
    "iss": "PARTNER_KEY",
    "exp": rightnowTimeStampInSeconds + (60*5) //adding 5 mins
  }, "PARTNER_SECRET", { algorithm: 'HS512' }, function(err, token) {
    var options = {
    'method': 'POST',
    'url': '',
    'headers': {
        'vendor': 'PARTNER_NAME',
        'Authorization': 'Bearer '+ token,
        'Content-Type': 'application/json'
    },
    body: '{"name":"string","country":"US","zipCode":"98001","email":"test+werworir@keeperdemo.io","vendorInternalId":"89654we7r64ert65","state":"CA","city":"My city","street":"the street","phone":"19191919191"}'

    };
    request(options, function (error, response) {
        if (error) console.log("Error From the server: "+error);
        console.log("response body: "+response.body);
    });
});

その他のJWT生成方法

JWT.ioのようなサービスを利用すルト、事前に共有されているシークレットからJSON Web Tokenを生成できます。

  • 暗号化には、HS512アルゴリズムを使用します。

  • ペイロードとして以下のjsonを使用します。このトークンは5分間有効となります。

  • トークンをエンコードするための秘密キーとしてsecret.key を使用します。

{
  "iat": timestamp in unix ,
  "iss": "consumer.key",
  "exp": timestamp in unix 
}

APIについての追加詳細

MSPのアカウント・ステータス

一部のAPIエンドポイントでは、MSPのステータスが返されます。以下では、それぞれのステータスが何であるかを説明します。

ステータス
定義

PENDING (保留中)

/create-trial-accountエンドポイントを通じてアカウントが作成されると、ユーザーにアカウントをアクティブにしてトライアルを開始するよう招待するメールが送信されます。

TRIAL (トライアル)

新しくアクティブとなったMSPは、自動的に14日間のトライアルを開始します。トライアルが終了した後、/convert-to-paidエンドポイントが呼び出されない場合、MSPは非アクティブ化され、ログインできなくなります。データは1年後に削除されます。トライアル期間が終了しても、データ保持期間内であれば再びアクティブ化できます。

ACTIVE (アクティブ)

今後有効期限がある、アクティブな有料MSPアカウント。

REGION_CONFLICT (地域の競合)

/create-trial-accountエンドポイントを使用して米国リージョンでアカウントが作成されると、通常はメールリンクからアカウントを有効化しますが、別のリージョンにあるウェブサイトからトライアルアカウントを有効化した場合、APIレスポンス内の「accountRegion」フィールドには登録されたアカウントのリージョンが表示されます。

PRODUCT_CONFLICT (製品の競合)

/create-trial-accountエンドポイントを使用して米国リージョンでアカウントが作成されると、通常はメールリンクからアカウントを有効化しますが、ウェブサイトからエンタープライズトライアルまたは個人向けトライアルアカウントを有効化した場合、APIレスポンス内の「productType」フィールドにはKeeper製品の種類が表示されます。

EXPIRED (期限切れ)

/cancel-paid-accountエンドポイントが呼び出されると、指定されたMSPは即座に期限切れとなり、このMSPの請求が停止します。

Product IDからSKUマッピング

KeeperのラインアイテムのそれぞれにIDと名前があります。これらは使用状況のAPIエンドポイントで表示されます。

productID
Line Item

720

Keeper MSP

10001

Keeper Business

10002

Keeper Business Plus

10010

Keeper Enterprise

10011

Keeper Enterprise Plus

967

Keeper Connection Manager Add On

968

Keeper Secrets Manager Add On

910

KeeperChat Add On

920

Keeper ARAM Add On

930

Keeper BreachWatch Add On

940

Keeper Compliance Reporting Add On

1011

Keeper 1TB Storage Add On

1012

Keeper 10TB Storage Add On

730

Dedicated Service & Support

973

Remote Browser Isolation

978

Privilege Access Management

API definition YAML file

postmanやswaggerエディタなどの他のツールでAPIを確認する場合は、以下のAPIのYAML定義をダウンロードしてください。

現在の使用状況の出力例

{
    "success": true,
    "usage": {
        "mcItems": [
            {
                "companyId": "NDU5ODU",
                "companyName": "Cowboys",
                "plan": "Keeper Business Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10001,
                        "productName": "Keeper Business Bundle"
                    }
                ]
            },
            {
                "companyId": "NDU5ODY",
                "companyName": "Eagles",
                "plan": "Keeper Business Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10002,
                        "productName": "Keeper Business Plus Bundle"
                    }
                ]
            },
            {
                "companyId": "NDU5ODc",
                "companyName": "Commanders",
                "plan": "Keeper Enterprise Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10010,
                        "productName": "Keeper Enterprise Bundle"
                    }
                ]
            },
            {
                "companyId": "NDU5ODg",
                "companyName": "Giants",
                "plan": "Keeper Enterprise Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10011,
                        "productName": "Keeper Enterprise Plus Bundle"
                    }
                ]
            },
            {
                "companyId": "NDU5ODk",
                "companyName": "Packers",
                "plan": "Keeper Enterprise Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 30,
                        "productId": 10010,
                        "productName": "Keeper Enterprise Bundle"
                    },
                    {
                        "unit": "GB",
                        "quantity": 1000,
                        "productId": 1011,
                        "productName": "1TB Secure File Storage"
                    }
                ]
            },
            {
                "companyId": "NDU5OTA",
                "companyName": "Vikings",
                "plan": "Keeper Business Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10002,
                        "productName": "Keeper Business Plus Bundle"
                    }
                ]
            },
            {
                "companyId": "NDU5OTE",
                "companyName": "Bears",
                "plan": "Keeper Enterprise Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 30,
                        "productId": 10011,
                        "productName": "Keeper Enterprise Plus Bundle"
                    }
                ]
            },
            {
                "companyId": "NDU5OTI",
                "companyName": "Lions",
                "plan": "Keeper Enterprise Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10011,
                        "productName": "Keeper Enterprise Plus Bundle"
                    }
                ]
            },
            {
                "companyId": "NDU5OTM",
                "companyName": "Buccaneers",
                "plan": "Keeper Business Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10001,
                        "productName": "Keeper Business Bundle"
                    }
                ]
            },
            {
                "companyId": "NDU5OTQ",
                "companyName": "Saints",
                "plan": "Keeper Business Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10002,
                        "productName": "Keeper Business Plus Bundle"
                    }
                ]
            },
            {
                "companyId": "NDU5OTU",
                "companyName": "Falcons",
                "plan": "Keeper Enterprise Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10010,
                        "productName": "Keeper Enterprise Bundle"
                    }
                ]
            },
            {
                "companyId": "NDkzNDk",
                "companyName": "MC Test",
                "plan": "Keeper Enterprise Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10011,
                        "productName": "Keeper Enterprise Plus Bundle"
                    },
                    {
                        "unit": "GB",
                        "quantity": 10000,
                        "productId": 1012,
                        "productName": "10TB Secure File Storage"
                    }
                ]
            },
            {
                "companyId": "NDU5OTY",
                "companyName": "Panthers",
                "plan": "Keeper Enterprise Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10011,
                        "productName": "Keeper Enterprise Plus Bundle"
                    }
                ]
            },
            {
                "companyId": "NDU5OTc",
                "companyName": "Rams",
                "plan": "Keeper Enterprise Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 2,
                        "productId": 10001,
                        "productName": "Keeper Business Bundle"
                    }
                ]
            },
            {
                "companyId": "NDU5OTg",
                "companyName": "Cardinals",
                "plan": "Keeper Business Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10002,
                        "productName": "Keeper Business Plus Bundle"
                    }
                ]
            },
            {
                "companyId": "NDU5OTk",
                "companyName": "49ers",
                "plan": "Keeper Enterprise Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10010,
                        "productName": "Keeper Enterprise Bundle"
                    }
                ]
            },
            {
                "companyId": "NDYwMDA",
                "companyName": "seahawks",
                "plan": "Keeper Enterprise Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 2,
                        "productId": 10011,
                        "productName": "Keeper Enterprise Plus Bundle"
                    }
                ]
            },
            {
                "companyId": "NDYwMDE",
                "companyName": "NFC Business",
                "plan": "Keeper Business Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 10,
                        "productId": 10001,
                        "productName": "Keeper Business Bundle"
                    }
                ]
            },
            {
                "companyId": "NDYwMDI",
                "companyName": "NFC Business Plus",
                "plan": "Keeper Business Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10002,
                        "productName": "Keeper Business Plus Bundle"
                    }
                ]
            },
            {
                "companyId": "NDY5NTk",
                "companyName": "NFC Business - All Upgrades",
                "plan": "Keeper Business Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10001,
                        "productName": "Keeper Business Bundle"
                    },
                    {
                        "unit": "GB",
                        "quantity": 10000,
                        "productId": 1012,
                        "productName": "10TB Secure File Storage"
                    }
                ]
            },
            {
                "companyId": "NDYwMDM",
                "companyName": "NFC Enterprise",
                "plan": "Keeper Enterprise Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10010,
                        "productName": "Keeper Enterprise Bundle"
                    }
                ]
            },
            {
                "companyId": "NDY5NjA",
                "companyName": "NFC Business Plus - All Upgrades",
                "plan": "Keeper Business Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10002,
                        "productName": "Keeper Business Plus Bundle"
                    },
                    {
                        "unit": "GB",
                        "quantity": 10000,
                        "productId": 1012,
                        "productName": "10TB Secure File Storage"
                    }
                ]
            },
            {
                "companyId": "NDYwMDQ",
                "companyName": "NFC Enterprise Plus",
                "plan": "Keeper Enterprise Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10011,
                        "productName": "Keeper Enterprise Plus Bundle"
                    }
                ]
            },
            {
                "companyId": "NDY5NjE",
                "companyName": "NFC Enterprise Plus - All Upgrades",
                "plan": "Keeper Enterprise Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10011,
                        "productName": "Keeper Enterprise Plus Bundle"
                    },
                    {
                        "unit": "GB",
                        "quantity": 10000,
                        "productId": 1012,
                        "productName": "10TB Secure File Storage"
                    }
                ]
            },
            {
                "companyId": "NDY5NjI",
                "companyName": "NFC Enterprise - All Upgrades",
                "plan": "Keeper Enterprise Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10010,
                        "productName": "Keeper Enterprise Bundle"
                    },
                    {
                        "unit": "GB",
                        "quantity": 10000,
                        "productId": 1012,
                        "productName": "10TB Secure File Storage"
                    }
                ]
            },
            {
                "companyId": "NDYwMDk",
                "companyName": "Company 1",
                "plan": "Keeper Business Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10001,
                        "productName": "Keeper Business Bundle"
                    }
                ]
            },
            {
                "companyId": "NDYwMTA",
                "companyName": "Company 2",
                "plan": "Keeper Business Plus Bundle",
                "invitedUsers": 1,
                "maximumAllowedUsers": 5,
                "products": [
                    {
                        "unit": "bundles",
                        "quantity": 1,
                        "productId": 10002,
                        "productName": "Keeper Business Plus Bundle"
                    }
                ]
            }
        ],
        "mspItem": {
            "companyId": "NDU5Njg",
            "companyName": "QaMspNfl",
            "invitedUsers": 1,
            "products": [
                {
                    "unit": "licenses",
                    "quantity": 31,
                    "productId": 720,
                    "productName": "MSP Base License"
                },
                {
                    "unit": "GB",
                    "quantity": 10000,
                    "productId": 1012,
                    "productName": "10TB Secure File Storage"
                },
                {
                    "unit": "",
                    "quantity": 1,
                    "productId": 730,
                    "productName": "Dedicated Service & Support"
                },
                {
                    "unit": "licenses",
                    "quantity": 31,
                    "productId": 920,
                    "productName": "Advanced Reporting & Alerts"
                },
                {
                    "unit": "licenses",
                    "quantity": 31,
                    "productId": 940,
                    "productName": "Compliance Reporting"
                },
                {
                    "unit": "licenses",
                    "quantity": 31,
                    "productId": 930,
                    "productName": "BreachWatch"
                },
                {
                    "unit": "KCM users",
                    "quantity": 10,
                    "productId": 967,
                    "productName": "Keeper Connection Manager (KCM)"
                },
                {
                    "unit": "licenses",
                    "quantity": 31,
                    "productId": 910,
                    "productName": "KeeperChat"
                }
            ]
        }
    }
}

月間使用量の出力例

{"success":true,"usage":{"total":2387.74,"tax":0,"currency":"USD","mcItems":[{"companyId":"NDU5OTk","total":3,"companyName":"49ers","products":[{"unitPrice":3,"unit":"user","quantity":1,"productId":10010,"productName":"Keeper Enterprise Bundle","avgMonthlyCost":3}]},{"companyId":"NDU5OTE","total":278.2,"companyName":"Bears","products":[{"unitPrice":4.8,"unit":"user","quantity":30,"productId":10011,"productName":"Keeper Enterprise Plus Bundle","avgMonthlyCost":144},{"unitPrice":0.5,"unit":"user","quantity":30,"productId":940,"productName":"Compliance Reporting","avgMonthlyCost":15},{"unitPrice":64,"quantity":1,"productId":730,"productName":"Dedicated Service & Support","avgMonthlyCost":64},{"unitPrice":25.2,"unit":"user","quantity":1,"productId":967,"productName":"Keeper Connection Manager (KCM)","avgMonthlyCost":25.2},{"unitPrice":1,"unit":"user","quantity":30,"productId":910,"productName":"KeeperChat","avgMonthlyCost":30}]},{"companyId":"NDU5OTM","total":2.25,"companyName":"Buccaneers","products":[{"unitPrice":2.25,"unit":"user","quantity":1,"productId":10001,"productName":"Keeper Business Bundle","avgMonthlyCost":2.25}]},{"companyId":"NDU5OTg","total":4.2,"companyName":"Cardinals","products":[{"unitPrice":4.2,"unit":"user","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle","avgMonthlyCost":4.2}]},{"companyId":"NDU5ODc","total":3,"companyName":"Commanders","products":[{"unitPrice":3,"unit":"user","quantity":1,"productId":10010,"productName":"Keeper Enterprise Bundle","avgMonthlyCost":3}]},{"companyId":"NDYwMDk","total":2.25,"companyName":"Company 1","products":[{"unitPrice":2.25,"unit":"user","quantity":1,"productId":10001,"productName":"Keeper Business Bundle","avgMonthlyCost":2.25}]},{"companyId":"NDYwMTA","total":4.2,"companyName":"Company 2","products":[{"unitPrice":4.2,"unit":"user","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle","avgMonthlyCost":4.2}]},{"companyId":"NDU5ODU","total":2.25,"companyName":"Cowboys","products":[{"unitPrice":2.25,"unit":"user","quantity":1,"productId":10001,"productName":"Keeper Business Bundle","avgMonthlyCost":2.25}]},{"companyId":"NDU5ODY","total":4.2,"companyName":"Eagles","products":[{"unitPrice":4.2,"unit":"user","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle","avgMonthlyCost":4.2}]},{"companyId":"NDU5OTU","total":3,"companyName":"Falcons","products":[{"unitPrice":3,"unit":"user","quantity":1,"productId":10010,"productName":"Keeper Enterprise Bundle","avgMonthlyCost":3}]},{"companyId":"NDU5ODg","total":4.8,"companyName":"Giants","products":[{"unitPrice":4.8,"unit":"user","quantity":1,"productId":10011,"productName":"Keeper Enterprise Plus Bundle","avgMonthlyCost":4.8}]},{"companyId":"NDU5OTI","total":4.8,"companyName":"Lions","products":[{"unitPrice":4.8,"unit":"user","quantity":1,"productId":10011,"productName":"Keeper Enterprise Plus Bundle","avgMonthlyCost":4.8}]},{"companyId":"NDkzNDk","total":181.04,"companyName":"MC Test","products":[{"unitPrice":4.8,"unit":"user","quantity":0.89,"productId":10011,"productName":"Keeper Enterprise Plus Bundle","avgMonthlyCost":4.27},{"unitPrice":89,"quantity":1,"productId":1012,"productName":"10TB Secure File Storage","avgMonthlyCost":89},{"unitPrice":0.5,"unit":"user","quantity":0.89,"productId":940,"productName":"Compliance Reporting","avgMonthlyCost":0.45},{"unitPrice":64,"quantity":1,"productId":730,"productName":"Dedicated Service & Support","avgMonthlyCost":64},{"unitPrice":25.2,"unit":"user","quantity":0.89,"productId":967,"productName":"Keeper Connection Manager (KCM)","avgMonthlyCost":22.43},{"unitPrice":1,"unit":"user","quantity":0.89,"productId":910,"productName":"KeeperChat","avgMonthlyCost":0.89}]},{"companyId":"NDYwMDE","total":37.5,"companyName":"NFC Business","products":[{"unitPrice":2.25,"unit":"user","quantity":10,"productId":10001,"productName":"Keeper Business Bundle","avgMonthlyCost":22.5},{"unitPrice":0.5,"unit":"user","quantity":10,"productId":920,"productName":"Advanced Reporting & Alerts","avgMonthlyCost":5},{"unitPrice":1,"unit":"user","quantity":10,"productId":930,"productName":"BreachWatch","avgMonthlyCost":10}]},{"companyId":"NDY5NTk","total":421.25,"companyName":"NFC Business - All Upgrades","products":[{"unitPrice":2.25,"unit":"user","quantity":1,"productId":10001,"productName":"Keeper Business Bundle","avgMonthlyCost":2.25},{"unitPrice":100,"quantity":1,"productId":1012,"productName":"10TB Secure File Storage","avgMonthlyCost":100},{"unitPrice":0.5,"unit":"user","quantity":1,"productId":920,"productName":"Advanced Reporting & Alerts","avgMonthlyCost":0.5},{"unitPrice":1,"unit":"user","quantity":1,"productId":930,"productName":"BreachWatch","avgMonthlyCost":1},{"unitPrice":0.5,"unit":"user","quantity":1,"productId":940,"productName":"Compliance Reporting","avgMonthlyCost":0.5},{"unitPrice":64,"quantity":1,"productId":730,"productName":"Dedicated Service & Support","avgMonthlyCost":64},{"unitPrice":25.2,"unit":"user","quantity":10,"productId":967,"productName":"Keeper Connection Manager (KCM)","avgMonthlyCost":252},{"unitPrice":1,"unit":"user","quantity":1,"productId":910,"productName":"KeeperChat","avgMonthlyCost":1}]},{"companyId":"NDYwMDI","total":4.2,"companyName":"NFC Business Plus","products":[{"unitPrice":4.2,"unit":"user","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle","avgMonthlyCost":4.2}]},{"companyId":"NDY5NjA","total":194.9,"companyName":"NFC Business Plus - All Upgrades","products":[{"unitPrice":4.2,"unit":"user","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle","avgMonthlyCost":4.2},{"unitPrice":100,"quantity":1,"productId":1012,"productName":"10TB Secure File Storage","avgMonthlyCost":100},{"unitPrice":0.5,"unit":"user","quantity":1,"productId":940,"productName":"Compliance Reporting","avgMonthlyCost":0.5},{"unitPrice":64,"quantity":1,"productId":730,"productName":"Dedicated Service & Support","avgMonthlyCost":64},{"unitPrice":25.2,"unit":"user","quantity":1,"productId":967,"productName":"Keeper Connection Manager (KCM)","avgMonthlyCost":25.2},{"unitPrice":1,"unit":"user","quantity":1,"productId":910,"productName":"KeeperChat","avgMonthlyCost":1}]},{"companyId":"NDYwMDM","total":3,"companyName":"NFC Enterprise","products":[{"unitPrice":3,"unit":"user","quantity":1,"productId":10010,"productName":"Keeper Enterprise Bundle","avgMonthlyCost":3}]},{"companyId":"NDY5NjI","total":195.2,"companyName":"NFC Enterprise - All Upgrades","products":[{"unitPrice":3,"unit":"user","quantity":1,"productId":10010,"productName":"Keeper Enterprise Bundle","avgMonthlyCost":3},{"unitPrice":100,"quantity":1,"productId":1012,"productName":"10TB Secure File Storage","avgMonthlyCost":100},{"unitPrice":0.5,"unit":"user","quantity":1,"productId":920,"productName":"Advanced Reporting & Alerts","avgMonthlyCost":0.5},{"unitPrice":1,"unit":"user","quantity":1,"productId":930,"productName":"BreachWatch","avgMonthlyCost":1},{"unitPrice":0.5,"unit":"user","quantity":1,"productId":940,"productName":"Compliance Reporting","avgMonthlyCost":0.5},{"unitPrice":64,"quantity":1,"productId":730,"productName":"Dedicated Service & Support","avgMonthlyCost":64},{"unitPrice":25.2,"unit":"user","quantity":1,"productId":967,"productName":"Keeper Connection Manager (KCM)","avgMonthlyCost":25.2},{"unitPrice":1,"unit":"user","quantity":1,"productId":910,"productName":"KeeperChat","avgMonthlyCost":1}]},{"companyId":"NDYwMDQ","total":4.8,"companyName":"NFC Enterprise Plus","products":[{"unitPrice":4.8,"unit":"user","quantity":1,"productId":10011,"productName":"Keeper Enterprise Plus Bundle","avgMonthlyCost":4.8}]},{"companyId":"NDY5NjE","total":195.5,"companyName":"NFC Enterprise Plus - All Upgrades","products":[{"unitPrice":4.8,"unit":"user","quantity":1,"productId":10011,"productName":"Keeper Enterprise Plus Bundle","avgMonthlyCost":4.8},{"unitPrice":100,"quantity":1,"productId":1012,"productName":"10TB Secure File Storage","avgMonthlyCost":100},{"unitPrice":0.5,"unit":"user","quantity":1,"productId":940,"productName":"Compliance Reporting","avgMonthlyCost":0.5},{"unitPrice":64,"quantity":1,"productId":730,"productName":"Dedicated Service & Support","avgMonthlyCost":64},{"unitPrice":25.2,"unit":"user","quantity":1,"productId":967,"productName":"Keeper Connection Manager (KCM)","avgMonthlyCost":25.2},{"unitPrice":1,"unit":"user","quantity":1,"productId":910,"productName":"KeeperChat","avgMonthlyCost":1}]},{"companyId":"NDU5ODk","total":239,"companyName":"Packers","products":[{"unitPrice":3,"unit":"user","quantity":30,"productId":10010,"productName":"Keeper Enterprise Bundle","avgMonthlyCost":90},{"unitPrice":25,"quantity":1,"productId":1011,"productName":"1TB Secure File Storage","avgMonthlyCost":25},{"unitPrice":0.5,"unit":"user","quantity":30,"productId":920,"productName":"Advanced Reporting & Alerts","avgMonthlyCost":15},{"unitPrice":1,"unit":"user","quantity":30,"productId":930,"productName":"BreachWatch","avgMonthlyCost":30},{"unitPrice":0.5,"unit":"user","quantity":30,"productId":940,"productName":"Compliance Reporting","avgMonthlyCost":15},{"unitPrice":64,"quantity":1,"productId":730,"productName":"Dedicated Service & Support","avgMonthlyCost":64}]},{"companyId":"NDU5OTY","total":4.8,"companyName":"Panthers","products":[{"unitPrice":4.8,"unit":"user","quantity":1,"productId":10011,"productName":"Keeper Enterprise Plus Bundle","avgMonthlyCost":4.8}]},{"companyId":"NDU5OTc","total":4.5,"companyName":"Rams","products":[{"unitPrice":2.25,"unit":"user","quantity":2,"productId":10001,"productName":"Keeper Business Bundle","avgMonthlyCost":4.5}]},{"companyId":"NDU5OTQ","total":4.2,"companyName":"Saints","products":[{"unitPrice":4.2,"unit":"user","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle","avgMonthlyCost":4.2}]},{"companyId":"NDYwMDA","total":9.6,"companyName":"seahawks","products":[{"unitPrice":4.8,"unit":"user","quantity":2,"productId":10011,"productName":"Keeper Enterprise Plus Bundle","avgMonthlyCost":9.6}]},{"companyId":"NDU5OTA","total":4.2,"companyName":"Vikings","products":[{"unitPrice":4.2,"unit":"user","quantity":1,"productId":10002,"productName":"Keeper Business Plus Bundle","avgMonthlyCost":4.2}]}],"subTotal":2387.74,"mspItem":{"companyId":"NDU5Njg","total":567.9,"companyName":"QaMspNfl","products":[{"unitPrice":3.4,"unit":"user","quantity":31,"productId":720,"productName":"MSP Base License","avgMonthlyCost":105.4},{"unitPrice":100,"quantity":1,"productId":1012,"productName":"10TB Secure File Storage","avgMonthlyCost":100},{"unitPrice":0.5,"unit":"user","quantity":31,"productId":940,"productName":"Compliance Reporting","avgMonthlyCost":15.5},{"unitPrice":64,"quantity":1,"productId":730,"productName":"Dedicated Service & Support","avgMonthlyCost":64},{"unitPrice":25.2,"unit":"user","quantity":10,"productId":967,"productName":"Keeper Connection Manager (KCM)","avgMonthlyCost":252},{"unitPrice":1,"unit":"user","quantity":31,"productId":910,"productName":"KeeperChat","avgMonthlyCost":31}]}}}

アカウント作成APIから、作成済みおよび招待済みアカウントに対して以下のようなメール (英語のみ) が自動的に送信されます。

これらのAPIの使用方法についてご不明な点がございましたら、サポートチームまたは営業担当者までご連絡ください。

35KB
msp_vendor_api_v9.yaml

Fetch All MSPs linked to vendor

get

Get All linked MSPs

Authorizations
Header parameters
AuthorizationstringOptional

Bearer

vendorstringOptional

vendor_name(Provided by Keeper)

Responses
200
OK
application/json
401
Unauthorized
application/json
get
GET /bi_api/v1/services/mspvendor/accounts HTTP/1.1
Host: keepersecurity.com
Authorization: Bearer JWT
Accept: */*
{
  "success": true,
  "accounts": [
    {
      "companyName": "msp11",
      "vendorInternalId": "msp11_internalId",
      "status": "TRIAL"
    },
    {
      "companyName": "msp12",
      "vendorInternalId": "msp12_internalId",
      "status": "EXPIRED"
    }
  ]
}

Fetch Current Usage

post

Fetch Current Usage

Authorizations
Header parameters
AuthorizationstringOptional

Bearer

vendorstringOptional

vendor_name(Provided by Keeper)

Body
any ofOptional
or
Responses
200
OK
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
post
POST /bi_api/v1/services/mspvendor/current-usage HTTP/1.1
Host: keepersecurity.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "vendorInternalId": "string"
}
{
  "success": true,
  "usage": {
    "mspItem": {
      "companyName": "msp",
      "companyId": "msp_partnerId",
      "products": [
        {
          "productName": "basePlan",
          "productId": 720,
          "quantity": 1
        },
        {
          "productName": "addon",
          "productId": 916,
          "quantity": 1
        }
      ]
    },
    "mcItems": [
      {
        "companyName": "mc1",
        "companyId": "mc1_partnerId",
        "products": [
          {
            "productName": "bundle",
            "productId": 10011,
            "quantity": 2
          },
          {
            "productName": "addon",
            "productId": 916,
            "quantity": 1.1
          }
        ]
      },
      {
        "companyName": "mc2",
        "companyId": "mc2_partnerId",
        "products": [
          {
            "productName": "bundle2",
            "productId": 10011,
            "quantity": 1.1
          },
          {
            "productName": "addon",
            "productId": 916,
            "quantity": 1.1
          }
        ]
      }
    ]
  }
}

Fetch Monthly Usage

post

Fetch Monthly Usage

Authorizations
Header parameters
AuthorizationstringOptional

Bearer

vendorstringOptional

vendor_name(Provided by Keeper)

Body
any ofOptional
or
Responses
200
OK
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
post
POST /bi_api/v1/services/mspvendor/monthly-usage HTTP/1.1
Host: keepersecurity.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 56

{
  "vendorInternalId": "string",
  "month": "08",
  "year": "2021"
}
{
  "success": true,
  "usage": {
    "mspItem": {
      "companyName": "msp",
      "companyId": "msp_partner_id",
      "products": [
        {
          "productName": "basePlan",
          "productId": 720,
          "quantity": 1.1,
          "unitPrice": 2.54,
          "unit": "string",
          "avgMonthlyCost": 3.11
        },
        {
          "productName": "addon",
          "productId": 916,
          "quantity": 1.1,
          "unitPrice": 2.54,
          "unit": "string",
          "avgMonthlyCost": 3.11
        }
      ],
      "total": 2.54
    },
    "mcItems": [
      {
        "companyName": "mc1",
        "companyId": "mc1_partner_id",
        "products": [
          {
            "productName": "bundle",
            "productId": 720,
            "quantity": 1.1,
            "unitPrice": 2.54,
            "unit": "string",
            "avgMonthlyCost": 3.11
          },
          {
            "productName": "addon",
            "productId": 916,
            "quantity": 1.1,
            "unitPrice": 2.54,
            "unit": "string",
            "avgMonthlyCost": 3.11
          }
        ],
        "total": 2.54
      },
      {
        "companyName": "mc2",
        "companyId": "mc2_partner_id",
        "products": [
          {
            "productName": "bundle2",
            "productId": 720,
            "quantity": 1.1,
            "unitPrice": 2.54,
            "unit": "string",
            "avgMonthlyCost": 3.11
          },
          {
            "productName": "addon",
            "productId": 916,
            "quantity": 1.1,
            "unitPrice": 2.54,
            "unit": "string",
            "avgMonthlyCost": 3.11
          }
        ],
        "total": 2.54
      }
    ],
    "subTotal": 10.1,
    "tax": 0,
    "totalCost": 10.1,
    "currency": "USD"
  }
}

Cancel Paid Account

post

Cancel Paid Account

Authorizations
Header parameters
AuthorizationstringOptional

Bearer

vendorstringOptional

vendor_name(Provided by Keeper)

Body
any ofOptional
or
Responses
200
OK
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
post
POST /bi_api/v1/services/mspvendor/cancel-paid-account HTTP/1.1
Host: keepersecurity.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "partnerId": "text"
}
{
  "success": true,
  "message": "Cancelled paid account"
}

Create Trial Account

post

Create Trial Account

Header parameters
AuthorizationstringOptional

Bearer JWT

vendorstringOptional

vendor_name(Provided by Keeper)

Body

Create Trial Account Request

namestring · max: 255Required
countrystring · max: 2Required

iso standard country code

Example: US
zipCodestring · max: 12Required
emailstring · emailRequired
vendorInternalIdstring · min: 1 · max: 52Required
statestringOptional
citystringOptional
streetstringOptional
phonestring · max: 15Optional

Country Code followed by phone number

Example: +1 9191919191
showPricingInMSPConsolebooleanOptionalDefault: false
Responses
200
Success Response
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
post
POST /bi_api/v1/services/mspvendor/create-trial-account HTTP/1.1
Host: keepersecurity.com
Content-Type: application/json
Accept: */*
Content-Length: 199

{
  "name": "text",
  "country": "US",
  "zipCode": "text",
  "email": "name@gmail.com",
  "vendorInternalId": "text",
  "state": "text",
  "city": "text",
  "street": "text",
  "phone": "+1 9191919191",
  "showPricingInMSPConsole": false
}
{
  "success": true,
  "partnerDetails": {
    "partnerId": "12345678-1234-5678-1234-567812345678",
    "first name": "John",
    "last name": "Doe",
    "country": "US",
    "locale": "en_US",
    "state": "Colorado",
    "city": "Broomfield",
    "street": "4753 Pine Garden Lane",
    "zipCode": "80021",
    "phone": "+1 9191919191",
    "email": "johndoe@partner.test",
    "vendorInternalId": "msp-vendor-internal-id12345678-1234-5678-1234-567812345678",
    "trial": true,
    "showPricingInMSPConsole": false
  }
}

Convert to Paid

post

convert-to-paid

Authorizations
Header parameters
AuthorizationstringOptional

Bearer

vendorstringOptional

vendor_name(Provided by Keeper)

Body
any ofOptional
or
Responses
200
OK
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
post
POST /bi_api/v1/services/mspvendor/convert-to-paid HTTP/1.1
Host: keepersecurity.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 29

{
  "vendorInternalId": "string"
}
{
  "success": true,
  "message": "Converted Trial to Paid"
}
msp

Fetch available Keeper MSP Products

get

Get available Keeper MSP products

Authorizations
Header parameters
AuthorizationstringOptional

Bearer

vendorstringOptional

vendor_name(Provided by Keeper)

Responses
200
OK
application/json
401
Unauthorized
application/json
get
GET /bi_api/v1/services/mspvendor/msp-products HTTP/1.1
Host: keepersecurity.com
Authorization: Bearer JWT
Accept: */*
{
  "success": true,
  "products": [
    {
      "productId": 720,
      "productName": "Keeper MSP"
    }
  ]
}
  • APIの機能
  • API定義
  • POSTConvert to Paid
  • POSTFetch Current Usage
  • POSTFetch Monthly Usage
  • POSTCancel Paid Account
  • POSTCreate Trial Account
  • GETFetch All MSPs linked to vendor
  • POSTActivate Expired Account
  • GETFetch available Keeper MSP Products
  • POSTDelete Pending/Conflict Account
  • 事前共有シークレットからJSON Web Tokenを作成する
  • JWTスクリプトのサンプル例
  • その他のJWT生成方法
  • APIについての追加詳細

Activate Expired Account

post

Activate Expired Account

Authorizations
Header parameters
AuthorizationstringOptional

Bearer

vendorstringOptional

vendor_name(Provided by Keeper)

Body
any ofOptional
or
Responses
200
OK
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
post
POST /bi_api/v1/services/mspvendor/activate-expired HTTP/1.1
Host: keepersecurity.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "vendorInternalId": "text"
}
{
  "success": true,
  "message": "Activated Expired Account"
}

Delete Pending/Conflict Account

post

Delete Pending/Conflict Account

Authorizations
Header parameters
AuthorizationstringOptional

Bearer

vendorstringOptional

vendor_name(Provided by Keeper)

Body
any ofOptional
or
Responses
200
OK
application/json
400
Bad Request
application/json
401
Unauthorized
application/json
post
POST /bi_api/v1/services/mspvendor/remove-account HTTP/1.1
Host: keepersecurity.com
Authorization: Bearer JWT
Content-Type: application/json
Accept: */*
Content-Length: 20

{
  "partnerId": "text"
}
{
  "success": true,
  "message": "Deleted Pending/Conflict Account"
}