For the complete documentation index, see llms.txt. This page is also available as Markdown.

アカウント管理API

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

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

APIの機能

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

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

  • 有料アカウントへ変換

  • MSPをすべて一覧表示

  • 現在の使用状況を取得

  • 月間の使用量を取得

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

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

  • MSP製品を一覧表示

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

API定義

Convert to Paid

post
/convert-to-paid

convert-to-paid

認可
Authorizationstring必須

JWT with HS512 alg

ヘッダーパラメータ
Authorizationstringオプション

Bearer

vendorstringオプション

vendor_name(Provided by Keeper)

本文
または
レスポンス
200

OK

application/json
successbooleanオプション
messagestringオプション
post
/convert-to-paid

Get Current Usage

post
/current-usage

Fetch Current Usage

認可
Authorizationstring必須

JWT with HS512 alg

ヘッダーパラメータ
Authorizationstringオプション

Bearer

vendorstringオプション

vendor_name(Provided by Keeper)

本文
または
レスポンス
200

OK

application/json

current usage details

post
/current-usage

Fetch Monthly Usage

post
/monthly-usage

Fetch Monthly Usage

認可
Authorizationstring必須

JWT with HS512 alg

ヘッダーパラメータ
Authorizationstringオプション

Bearer

vendorstringオプション

vendor_name(Provided by Keeper)

本文
または
レスポンス
200

OK

application/json

usage details

subTotalnumberオプション
taxnumberオプション
totalCostnumberオプション
currencystringオプション
post
/monthly-usage

Cancel Paid Account

post
/cancel-paid-account

Cancel Paid Account

認可
Authorizationstring必須

JWT with HS512 alg

ヘッダーパラメータ
Authorizationstringオプション

Bearer

vendorstringオプション

vendor_name(Provided by Keeper)

本文
または
レスポンス
200

OK

application/json
successbooleanオプション
messagestringオプション
post
/cancel-paid-account

Create Trial Account

post
/create-trial-account

Create Trial Account

ヘッダーパラメータ
Authorizationstringオプション

Bearer JWT

vendorstringオプション

vendor_name(Provided by Keeper)

本文

Create Trial Account Request

namestring · 最大: 255必須
countrystring · 最大: 2必須

iso standard country code

Example: US
zipCodestring · 最大: 12必須
emailstring · email必須
vendorInternalIdstring · 最小: 1 · 最大: 52必須
statestringオプション
citystringオプション
streetstringオプション
phonestring · 最大: 15オプション

Country Code followed by phone number

Example: +1 9191919191
showPricingInMSPConsolebooleanオプションDefault: false
レスポンス
200

Success Response

application/json

partner Details

partnerIdstring · uuid · 最大: 36読み取り専用オプション

Unique identifier for the given user.

first namestring · 最小: 1 · 最大: 119オプション
last namestring · 最小: 1 · 最大: 100オプション
countrystring · 最大: 2必須

iso standard country code

Example: US
emailstring · email必須
zipCodestring必須Example: zip-code for US , postalCode for non-US countries
streetstringオプション
citystringオプション
vendorInternalIdstring必須

Unique identifier for each account.

statestringオプション
phonestringオプション
trailbooleanオプション
showPricingInMSPConsolebooleanオプション
post
/create-trial-account

Fetch All MSPs linked to vendor

get
/accounts

Get All linked MSPs

認可
Authorizationstring必須

JWT with HS512 alg

ヘッダーパラメータ
Authorizationstringオプション

Bearer

vendorstringオプション

vendor_name(Provided by Keeper)

レスポンス
200

OK

application/json

get All accounts response

successbooleanオプション
get
/accounts

Activate Expired Account

post
/activate-expired

Activate Expired Account

認可
Authorizationstring必須

JWT with HS512 alg

ヘッダーパラメータ
Authorizationstringオプション

Bearer

vendorstringオプション

vendor_name(Provided by Keeper)

本文
または
レスポンス
200

OK

application/json
successbooleanオプション
messagestringオプション
post
/activate-expired

Fetch available Keeper MSP Products

get
/msp-products

Get available Keeper MSP products

認可
Authorizationstring必須

JWT with HS512 alg

ヘッダーパラメータ
Authorizationstringオプション

Bearer

vendorstringオプション

vendor_name(Provided by Keeper)

レスポンス
200

OK

application/json

get MSP Products response

successbooleanオプション
get
/msp-products

Delete Pending/Conflict Account

post
/remove-account

Delete Pending/Conflict Account

認可
Authorizationstring必須

JWT with HS512 alg

ヘッダーパラメータ
Authorizationstringオプション

Bearer

vendorstringオプション

vendor_name(Provided by Keeper)

本文
または
レスポンス
200

OK

application/json
successbooleanオプション
messagestringオプション
post
/remove-account

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

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

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

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

その他のJWT生成方法

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

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

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

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

APIについての追加詳細

MSPアカウントステータス

一部のAPIエンドポイントのレスポンスには、MSPのステータスが含まれます。各ステータスの意味は以下の表のとおりです。

ステータス
定義

PENDING (保留中)

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

TRIAL (トライアル)

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

ACTIVE (アクティブ)

有効期限内の有料MSPアカウント (アクティブ)

REGION_CONFLICT (地域の競合)

米国リージョンで /create-trial-account によりアカウント作成後、招待メールのリンクではなく別リージョンのサイトからトライアルを有効化したとき。レスポンスの accountRegion に登録済みアカウントのリージョンが含まれる

PRODUCT_CONFLICT (製品の競合)

米国リージョンで /create-trial-account によりアカウント作成後、招待メールのリンクではなくサイト上からエンタープライズ向けまたは個人向けのトライアルを有効化したとき。レスポンスの productType にKeeperの製品種別が含まれる

EXPIRED (期限切れ)

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

製品IDとSKUの対応

各ラインアイテムには読みやすい名称があり、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定義のYAMLファイル

PostmanやSwagger EditorなどでAPIの挙動を確認する場合は、関連するAPIのYAML定義をダウンロードしてください。

現在の使用状況の出力例

月間使用量の出力例

アカウント作成APIを利用すると、作成済みまたは招待済みのアカウント宛にメールが自動送信されます。以下はその例です。

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

最終更新