サービス アカウント アクセス トークンの発行

POST /api/v1/oauth/token

有効期間の短いベアラー トークンのサービス アカウントクライアントIDと シークレットを交換します。 grant_type=client_credentials のみがサポートされます。

body 必須

OAuth トークンリクエスト。クライアント認証情報にHTTP基本認証 を優先します。

  • client_id string

    ClientID は、 HTTP基本ユーザー名(推奨)として送信することもできます。

  • client_secret string

    ClientSecret は、 HTTP基本パスワード(推奨)として送信することもできます。

  • grant_type string 必須

    grantType は "client_credentials" である必要があります。

    値は client_credentials です。

body 必須

OAuth トークンリクエスト。クライアント認証情報にHTTP基本認証 を優先します。

  • grant_type string 必須

    値は client_credentials です。

  • client_id string
  • client_secret string

応答

  • 200 application/ JSON

    OK

    応答属性の非表示 応答属性の表示 オブジェクト
    • access_token string
    • expires_in integer
    • token_type string
  • 400 application/ JSON

    無効なリクエスト

    応答属性の非表示 応答属性の表示 オブジェクト
    • エラー string
    • errors_description string
  • 401 application/ JSON

    許可されていない

    応答属性の非表示 応答属性の表示 オブジェクト
    • エラー string
    • errors_description string
  • 429 application/ JSON

    リクエストが多すぎる

    ヘッダー属性を非表示 ヘッダー属性を表示
    • 再試行後 string

      再試行する前に待機する秒数

    応答属性の非表示 応答属性の表示 オブジェクト
    • エラー string
    • errors_description string
  • 500 application/ JSON

    内部サーバーエラー

    応答属性の非表示 応答属性の表示 オブジェクト
    • エラー string
    • errors_description string
POST /api/v1/oauth/token
curl \
 --request POST 'https://agentengine.mongodb.com/api/v1/oauth/token' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/json" \
 --data '{
  "client_id": "string",
  "client_secret": "string",
  "grant_type": "client_credentials"
}'
curl \
 --request POST 'https://agentengine.mongodb.com/api/v1/oauth/token' \
 --header "Authorization: $API_KEY" \
 --header "Content-Type: application/x-www-form-urlencoded" \
 --data 'grant_type=client_credentials&client_id=string&client_secret=string'
リクエスト例
{
  "client_id": "string",
  "client_secret": "string",
  "grant_type": "client_credentials"
}
応答の例(200)
{
  "access_token": "string",
  "expires_in": 42,
  "token_type": "string"
}
応答の例(400)
{
  "error": "string",
  "error_description": "string"
}
応答の例(401)
{
  "error": "string",
  "error_description": "string"
}
応答の例(429)
# Headers
Retry-After: string

# Payload
{
  "error": "string",
  "error_description": "string"
}
応答の例(500)
{
  "error": "string",
  "error_description": "string"
}