# OpenAPI コネクターの認証
このガイドは、OpenAPI コネクターでサポートされている認証方法のリファレンスです。
# Swagger ファイルと認証方法
場合によっては、アプリケーションの Swagger ファイルに、そのアプリケーションに必要な認証方法が記述されていることがあります。この情報が Swagger ファイルに含まれていると、コネクションの設定時に正しい認証方法を選択するのに役立ちます。
NOTE
現時点では、Swagger ファイル内に認証方法が記述されていても、コネクターがそれを自動的に読み取ることはありません。
# サポートされている方法
OpenAPI コネクターでは、以下の認証方法がサポートされています。
一部のケースでは、OpenAPI コネクターをカスタマイズする場合にかぎり、他の認証方法がサポートされることもあります。詳細については、「カスタムコネクターの設定」ガイドを参照してください。
# 認証なし
この方法では、認証の詳細は必要ありません。この方法は以下の場合に使用します。
- アプリケーションに認証が必要ではない。
- レシピで指定する入力に基づいて認証が実行される。
# 基本認証
基本認証 (opens new window)では、ユーザー名とパスワードを使用してリクエストを検証します。この情報は SSL での転送時に Base64 でエンコードされます。これは認証フローとしては一般的なものです。
# 入力項目
- Basic auth user
- アプリケーションのユーザー名またはアカウント名。
- Basic auth password
- ユーザーのパスワード。ユーザーパスワードの代わりに、アカウント設定から取得した API キーまたは API トークンを使用することもできます。
- この情報は秘密にしておく必要があります。
# ヘッダー認証
通常のユーザー名とパスワード/API キーに加えてヘッダーを必要とするアプリケーションの場合、またはリクエスト内で送信されるヘッダーをカスタマイズしたい場合は、ヘッダー認証を使用します。また、生成済みのトークンをすでに所有している場合も、ヘッダー認証を使用することができます。
# 入力項目
- Header authorization
- カスタム認証ヘッダーを1行に1つずつ追加します。
例 :
X-API-TOKEN: secret42 Authorization: Bearer AbC123XyZ789uje4
# クエリーパラメータ認証
認証構造が URL クエリーパラメータの検証に依存するアプリケーションの場合は、クエリーパラメータ認証を使用します。
# 入力項目
- Query param authorization
- カスタム URL クエリーパラメータを1行に1つずつ追加します。
例 :
token: 872943684629 api-key: DKDF34KD8DD
# OAuth 2.0: 認証コード付与
認証コード付与フロー (opens new window)は、多くのクラウドアプリで採用されている認証規格です。広く採用されている理由は、ユーザー名とパスワードを開示することなく、アプリへのアクセスを第三者に許可できるためです。Workato では、これを使用する場合、単に対象アプリへユーザーをリダイレクトさせ、そこでログイン資格情報を入力するよう促します。これだけで、アプリは Workato がユーザーに代わって API リクエストを行っていることを十分に信頼することができます。
認証コード付与タイプは、アクセストークン用の認証コードを交換するために、機密クライアントおよびパブリッククライアントによって使用されます。さらに、以下の入力情報が必要です。
# 入力項目
- OAuth2 authorization URL
- ユーザーが [Connect] をクリックしたときに Workato がリダイレクトする URL です。たいていは、アプリのログイン画面です。
- この情報は、接続先アプリの API ドキュメントの認証セクションなどで公開されているものです。
- OAuth2 token URL
- Workato が認証トークンを取得する URL です。この認証トークンは、アプリとそのデータへのアクセス権限を証明するために使用されます。
- この情報は、接続先アプリの API ドキュメントの認証セクションなどで公開されているものです。
- How does the API require credentials to be sent to request a token？
- 接続先のアプリによっては、リクエスト本文またはヘッダーで資格情報を送信しなければいけない場合があります。
- この情報は、接続先アプリの API ドキュメントの認証セクションなどで公開されているものです。
- Client ID
- Workato に関連付けられている、OAuth アプリの公開 ID です。
- これはたいてい、接続先アプリのログインアカウントの [設定] や [統合] (またはそれと同等の) ページにあり、秘密にしておくべきものです。
- Client secret
- 接続先アプリケーションがクライアント ID と併せて検証する、対応する秘密鍵です。
- これはたいてい、接続先アプリのログインアカウントの [設定] や [統合] (またはそれと同等の) ページにあり、秘密にしておくべきものです。
- OAuth2 scopes
- スコープとは接続先アプリにリクエストできる権限です。
- これはたいてい、接続先アプリのログインアカウントの [設定] や [統合] (またはそれと同等の) ページで見つかります。
# OAuth 2.0: クライアント資格情報付与
クライアント資格情報付与フロー (opens new window)は、Workato がクライアント資格情報のみを使用してアクセストークンを要求する場合に使用してください。
このアプローチは、ユーザーのコントロール下にある保護されたリソースへのアクセスを要求する場合や、データアクセスに特定ユーザーの許可が要求されない機器間 (M2M) 認証の場合に最適です。
# 入力項目
- OAuth2 token URL
- Workato が認証トークンを取得する URL です。この認証トークンは、アプリとそのデータへのアクセス権限を証明します。
- この情報は、接続先アプリの API ドキュメントの認証セクションなどで公開されているものです。
- How does the API require credentials to be sent to request a token？
- 接続先のアプリによっては、リクエスト本文またはヘッダーで資格情報を送信しなければいけない場合があります。
- この情報は、接続先アプリの API ドキュメントの認証セクションなどで公開されているものです。
- Client ID
- Workato に関連付けられている、OAuth アプリの公開 ID です。
- これはたいてい、接続先アプリのログインアカウントの [設定] や [統合] (またはそれと同等の) ページにあり、秘密にしておくべきものです。
- Client secret
- 接続先アプリケーションがクライアント ID と併せて検証する、対応する秘密鍵です。
- これはたいてい、接続先アプリのログインアカウントの [設定] や [統合] (またはそれと同等の) ページにあり、秘密にしておくべきものです。
- OAuth2 scopes
- スコープとは接続先アプリにリクエストできる権限です。
- これはたいてい、接続先アプリのログインアカウントの [設定] や [統合] (またはそれと同等の) ページで見つかります。
# OAuth 2.0: リソース所有者パスワード付与
リソース所有者パスワード付与フロー (opens new window)は、Workato がユーザーの資格情報 (ユーザー名とパスワード) を使用して、アプリケーションのリソースへのアクセストークンを要求する場合に使用します。
# 入力項目
- OAuth2 token URL
- Workato が認証トークンを取得する URL です。この認証トークンは、アプリとそのデータへのアクセス権限を証明するために使用されます。
- この情報は、接続先アプリの API ドキュメントの認証セクションなどで公開されているものです。
- Client ID
- Workato に関連付けられている、OAuth アプリの公開 ID です。
- これはたいてい、接続先アプリのログインアカウントの [設定] や [統合] (またはそれと同等の) ページにあり、秘密にしておくべきものです。
- Client secret
- 接続先アプリケーションがクライアント ID と併せて検証する、対応する秘密鍵です。
- これはたいてい、接続先アプリのログインアカウントの [設定] や [統合] (またはそれと同等の) ページにあり、秘密にしておくべきものです。
- Username
- API 呼び出しを送信するユーザーの名前です。
- Password
- API 呼び出しを送信するユーザーのパスワードです。
- この情報は秘密にしておく必要があります。
- OAuth2 scopes
- スコープとは接続先アプリにリクエストする権限です。
- これはたいてい、接続先アプリのログインアカウントの [設定] や [統合] (またはそれと同等の) ページにあります。
Last updated: 2023/10/13 18:10:21