アカウント管理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
post
/convert-to-paid

Fetch 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
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
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
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
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
/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
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

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
post
/remove-account

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

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

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

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

その他の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エンドポイントを使用して米国リージョンでアカウントが作成されると、通常はメールリンクからアカウントを有効化しますが、別のリージョンにあるウェブサイトからトライアルアカウントを有効化した場合、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定義をダウンロードしてください。

35KB
開く

現在の使用状況の出力例

月間使用量の出力例

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

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

最終更新