ユーザー

プロバイダーのユーザーの完全な一覧または単一ユーザーの詳細な情報を取得することができます。

単一ユーザーについての詳細な情報を取得するには、ユーザーのBacklot API キーが必要です。

プロバイダーのユーザーをすべて取得

[GET] /v2/providers/provider_id/users
   

ユーザーについての情報を表示

[GET] /v2/users/user_api_key
   

ルート属性

次の表はルートに表示されるすべて属性を示しています。

ルート属性 説明
provider_id

プロバイダーのID。プロバイダー一覧を取得するために、/providersルートに対してGETを実行してください。

タイプ:文字列

デフォルト:なし

例: b4f1a93b779145b

user_api_key

ユーザー用APIキー。

タイプ:文字列

デフォルト:なし

例: pzd3M6WH2UIRTFrurtFjGI52AaY.SwBWE

プロパティ

次の表はユーザーと関連付けることができるすべてのプロパティを示しています。

プロパティ 説明 必須?
api_key

ユーザーのAPIキー。

タイプ:文字列

デフォルト:なし

例: pzd3M6WH2UIRTFrurtFjGI52AaY.SwBWE

はい
created_at

ユーザーが作成された日時。

タイプ:DateTime

例:2012-02-08T19:52:28+00:00

はい
email

ユーザーのメールアドレス。

タイプ:文字列

デフォルト:なし

例: user@company.com

はい
permission

ユーザーの許可レベルを指定します。

タイプ:文字列

デフォルト:パッケージ設定に依存します

例: reseller

はい
secret

ユーザーの秘密鍵。

タイプ:文字列

デフォルト:なし

例:PYHxQiUY8-Us__iYS-HRT67fddi2VZ5IhW5_ii

はい
terms_of_service_accepted

ユーザーがサービス規約に同意したかどうかを指定します。

タイプ:ブーリアン

有効値: true | false

デフォルト: false

例: true

はい

次の例は指定されたプロバイダーアカウントのユーザーをすべて取得します。

[GET] /v2/providers/pzd3M6WH2DENHKruXzs4nGI52AaY/users
    

Backlot は次のようなユーザー一覧を返します。

{
 "items": [   {
   "created_at": "2012-02-08T19:52:28+00:00",
   "api_key": "pzd3M6WH2UIRTFrurtFjGI52AaY.SwBWE",
   "terms_of_service_accepted": false,
   "permission": "reseller",
   "secret": "PYHxQiUY8-Us__iYS-HRT67fddi2VZ5IhW5_ii",
   "email": "user@company.com"
  }  ]
}           
       

Sorting 試行する

次の例は特定のユーザー情報を取得します。

[GET] /v2/users/pzd3M6WH2UIRTFrurtFjGI52AaY.SwBWE
    

Backlot は次のようなレスポンスを返します。

{
 "created_at": "2012-02-08T19:52:28+00:00",
 "api_key": "pzd3M6WH2UIRTFrurtFjGI52AaY.SwBWE",
 "terms_of_service_accepted": false,
 "permission": "reseller",
 "secret": "PYHxQiUY8-Us__iYS-HRT67fddi2VZ5IhW5_ii",
 "email": "user@company.com"
}        
    

Sorting 試行する

この記事はお役にたちましたか?