認証方法

新機能

Eggplant DAI APIは、APIを保護するために開放標準の認証（OAuth 2.0 - クライアント資格情報付与）を使用します。

Eggplant DAI Execution APIを使用するには、有効なアクセストークンが必要です。アクセストークンを取得するには：

• あなたのインテグレーションのためのOAuth資格情報を取得します
• 下記に示す生成されたトークンエンドポイントに、あなたのOAuth資格情報を含む認証リクエストを送信します。

トークンは5分後に有効期限が切れるため、アクセスを維持するには、定期的にあなたの資格情報を再送信して新しいアクセストークンを取得する必要があります。

これの具体的な手順については、Getting Startedをご覧ください。

認証方法

POST -> http://localhost:8000/auth/realms/{realm}/protocol/openid-connect/token

ヘッダー

名前	値
Content-Type	application/x-www-form-urlencoded

ボディパラメータ

名前	タイプ	説明	必須
grant_type	string	タイプ：client_credentials あなたのOAuth資格情報を使用してアクセストークンを生成します。	はい
client_id	string	あなたのclient_id	はい
client_secret	string	あなたのclient_secret	はい

可能なレスポンス

ステータス	ステータステキスト	説明
200	OK	成功した応答
400	Bad request	必要なパラメータが送信されていません
401	Bad request	無効な資格情報が提供されました。
403	禁止されています	十分な同時ユーザーライセンスが利用できません

レスポンスボディJSON

以下の最初の例は、成功した応答（ステータス200）を示しています。

例：

{
      "access_token": "eyJhbGciOiJSUzI1NiIsInR5cCIgOiAiSldUIiwia...",
      "expires_in": 300,
      "refresh_expires_in": 0,
      "token_type": "Bearer",
      "not-before-policy": 0,
      "scope": "email template:dai:agents profile"
  }

名前	タイプ	説明	値
access_token	string	認証に成功したユーザーアカウントのアクセストークン	<dynamic>
expires_in	integer	アクセストークンが有効である秒数。	300 (または5分)
refresh_expires_in	integer	リフレッシュトークンが有効である秒数。	1800 (または30分)
token_type	string	OAuth 2.0で使用されるアクセストークンのタイプ。	bearer
not-before-policy	boolean	ポリシーは無効化されています。	0
scope	string	システム管理者の権限をアクセストークンを使用するリソースまたはアプリケーションに付与します	email template:dai:agents profile

次の例は、無効なレスポンスステータス401未認証を示しています。

例：

{
  "message": "Not Authorized",
  "description": "The credentials you provided are not valid."
}