OpenAPIコネクター認証
このガイドは、OpenAPIコネクターでサポートされている認証方法のリファレンスです。
Swaggerファイルと認証方法
場合によっては、アプリケーションのSwaggerファイルに、そのアプリケーションに必要な認証方法が記述されています。 ファイルにこの情報が含まれている場合、コネクションの設定時に正しい認証方法を選択する際に役立ちます。
INFO
現在、コネクターは、Swaggerファイルに認証方法が存在する場合でも、その認証方法の自動読み取りをサポートしていません。
サポートされている方法
OpenAPIコネクターは、次の認証方法をサポートしています。
場合によっては、OpenAPIコネクターをカスタマイズする場合にのみ、他の認証方法をサポートします。 詳細については、カスタムコネクターの設定ガイドを参照してください。
なし
この方法では、認証の詳細は必要ありません。 次の場合にこの方法を使用します:
- アプリケーションで認証が不要
- 認証がレシピで指定する入力から実行される
Basic
Basic認証は、ユーザー名とパスワードを使用してリクエストを検証します。 これはSSL経由の転送中にBase64でエンコードされます。一般的な認証フローです。
入力
- Basic認証ユーザー
- アプリケーションユーザー/アカウントの名前。
- Basic認証パスワード
- ユーザーのパスワード。 パスワードの代わりに、アカウント設定から取得したAPIキーまたはAPIトークンを使用できます。
- これは秘密にしておく必要があります。
ヘッダー
通常のユーザー名とパスワードまたはAPIキー以外に追加のヘッダーが必要なアプリケーション、またはリクエストで送信されるヘッダーをカスタマイズする場合は、ヘッダー認証を使用します。 生成済みのトークンがすでにある場合にも、ヘッダー認証を使用できます。
入力フィールド
- ヘッダー認可
- カスタム認証ヘッダーを1行に1つずつ追加します。
例:
X-api-token: secret42 Authorization: Bearer AbC123XyZ789uje4
クエリパラメーター
認証構造がURLクエリパラメーターの検証に依存するアプリケーションでは、クエリパラメーター認証を使用します。
入力
- クエリパラメーター認可
- カスタムURLクエリパラメーターを1行に1つずつ追加します。
例:
token: 872943684629 api-key: DKDF34KD8DD
OAuth 2.0:認可コードグラント
認可コードグラントフローは、多くのクラウドアプリで採用されている認証標準です。 ユーザー名とパスワードを第三者に開示しなくても、第三者にアプリへのアクセスを許可できるため、広く使用されています。 この場合、Workatoはユーザーをアプリにリダイレクトするだけで、そこでログイン資格情報を入力します。 これにより、アプリはWorkatoがAPIリクエストを行う際にユーザーの代理で動作していることを信頼できます。
認可コードグラントタイプは、機密クライアントとパブリッククライアントが認可コードをアクセストークンと交換するために使用します。 また、次の入力情報が必要です。
入力
- OAuth2認可URL
- これは、ConnectをクリックしたときにWorkatoがユーザーをリダイレクトするURLです。 これは通常、アプリのログイン画面です。
- 接続先アプリのAPIドキュメントのAuthenticationセクションで公開されているのが一般的です。
- OAuth2トークンURL
- Workatoが認証トークンを取得するURL。 認証トークンは、アプリとそのデータにアクセスする権限があることを確認するために使用されます。
- 接続先アプリのAPIドキュメントのAuthenticationセクションで公開されているのが一般的です。
- APIでは、トークンをリクエストするために資格情報をどのように送信する必要がありますか
- 接続先のアプリによっては、資格情報をリクエスト本文またはヘッダーとして送信する必要があります。
- 接続先アプリのAPIドキュメントのAuthenticationセクションで公開されているのが一般的です。
- Client ID
- Workatoに関連付ける必要があるOAuthアプリのパブリックID。
- これは通常、接続する予定のログイン済みアプリアカウントのSettingsページまたはIntegrationsページ（または同等のページ）にあり、秘密にしておく必要があります。
- Client secret
- アプリケーションがClient IDとともに検証する、一致する秘密鍵。
- これは通常、接続する予定のログイン済みアプリアカウントのSettingsページまたはIntegrationsページ（または同等のページ）にあり、秘密にしておく必要があります。
- OAuth2スコープ
- スコープは、アプリからリクエストできる権限です。
- これは通常、接続する予定のログイン済みアプリアカウントのSettingsページまたはIntegrationsページ（または同等のページ）にあります。
OAuth 2.0:クライアントクレデンシャルグラント
Workatoがクライアント資格情報のみを使用してアクセストークンをリクエストする場合は、クライアントクレデンシャルグラントフローを使用します。
このアプローチは、管理下にある保護されたリソースへのアクセスをリクエストする場合、またはデータへのアクセスに特定のユーザーの権限が不要なマシン間認証に最適です。
入力
- OAuth2トークンURL
- Workatoが認証トークンを取得するURL。 この認証トークンは、アプリとそのデータにアクセスする権限があることを確認します。
- 接続先アプリのAPIドキュメントのAuthenticationセクションで公開されているのが一般的です。
- APIでは、トークンをリクエストするために資格情報をどのように送信する必要がありますか
- 接続先のアプリによっては、資格情報をリクエスト本文またはヘッダーとして送信できます。
- 接続先アプリのAPIドキュメントのAuthenticationセクションで公開されているのが一般的です。
- Client ID
- Workatoに関連付ける必要があるOAuthアプリのパブリックID。
- これは通常、接続する予定のログイン済みアプリアカウントのSettingsページまたはIntegrationsページ（または同等のページ）にあり、秘密にしておく必要があります。
- Client secret
- アプリケーションがClient IDとともに検証する、一致する秘密鍵。
- これは通常、接続する予定のログイン済みアプリアカウントのSettingsページまたはIntegrationsページ（または同等のページ）にあり、秘密にしておく必要があります。
- OAuth2スコープ
- スコープは、アプリからリクエストできる権限です。
- これは通常、接続する予定のログイン済みアプリアカウントのSettingsページまたはIntegrationsページ（または同等のページ）にあります。
OAuth 2.0:リソースオーナーパスワードグラント
Workatoがユーザー資格情報（ユーザー名とパスワード）を使用してアプリケーションリソースにアクセスするためのトークンをリクエストする場合は、リソースオーナーパスワードグラントフローを使用します。
入力
- OAuth2トークンURL
- Workatoが認証トークンを取得するURL。 この認証トークンは、アプリとそのデータにアクセスする権限があることを確認するために使用されます。
- 接続先アプリのAPIドキュメントのAuthenticationセクションで公開されているのが一般的です。
- Client ID
- Workatoに関連付けられているOAuthアプリのパブリックID。
- これは通常、接続する予定のログイン済みアプリアカウントのSettingsページまたはIntegrationsページ（または同等のページ）にあり、秘密にしておく必要があります。
- Client secret
- アプリケーションがClient IDとともに検証する、一致する秘密鍵。
- これは通常、接続する予定のログイン済みアプリアカウントのSettingsページまたはIntegrationsページ（または同等のページ）にあり、秘密にしておく必要があります。
- ユーザー名
- これらのAPIコールを送信するユーザーの名前。
- パスワード
- これらのAPIコールを送信するユーザーのパスワード。
- これは秘密にしておく必要があります。
- OAuth2スコープ
- スコープは、アプリからリクエストする権限です。
- これは通常、接続する予定のログイン済みアプリアカウントのSettingsページまたはIntegrationsページ（または同等のページ）にあります。
Last updated: