Skip to main content
POST
利用上限設定の取得

概要

組織の現在のユーザー単位のアドオン用クレジット上限設定を取得します。上限は常にユーザー単位です。チームまたはグループのスコープで照会すると、レスポンスには、そのチームまたはグループに属するユーザーに適用されているユーザー単位の上限が返されます。

リクエスト

string
必須
「請求 Read」権限を持つサービスキー

スコープ設定(いずれか1つを選択)

boolean
チーム内のすべてのユーザーに適用されるユーザーごとの上限を取得するには、true を設定します
string
グループ ID を指定して、特定のグループ内のすべてのユーザーに適用されるユーザーごとの上限を取得します
string
メールアドレスを指定して、特定のユーザーの設定を取得します
スコープを定義するには、team_levelgroup_iduser_email のいずれか1つを指定する必要があります。

リクエスト例 - チーム内全ユーザーのユーザーごとの上限値を取得

リクエスト例:グループ内の全ユーザーのユーザー別上限の取得

リクエスト例 - ユーザー設定の取得

レスポンス

integer
設定されているアドオンのクレジット上限値。このフィールドがレスポンスに含まれていない場合、リクエストされたスコープレベルでは上限は設定されていません。

レスポンス例 - 上限を設定した場合

レスポンス例 - 上限未設定時

エラーレスポンス

一般的なエラーシナリオ:
  • 無効なサービスキーまたは権限不足
  • 複数の scope パラメーターが指定されている
  • scope パラメーターが指定されていない
  • 無効なグループ ID またはユーザーのメールアドレス
  • レート制限を超過した