カスタムOAuth アプリケーションの作成
CData はOAuth アプリケーション認証情報を製品に組み込んでおり、デスクトップアプリケーションまたはヘッドレスマシン経由でSlack に接続する際に使用できます。(OAuthAccessToken およびその他の設定パラメータを取得および設定する方法についての情報は、「Slack への接続」の デスクトップ認証セクションを参照してください。)
ただし、Web 経由で接続するには、カスタムOAuth アプリケーションの作成が必要です。また、カスタムOAuth アプリケーションは、一般的に使用される3つの認証フローをすべてシームレスにサポートするため、これらの認証フロー用にカスタムOAuth アプリケーションを作成(独自のOAuth アプリケーションクレデンシャルを使用)することもできます。
カスタムOAuth アプリケーションは、次のような場合に有用です。
- 認証ダイアログのブランディングをコントロールしたいとき
- ユーザー認証後にアプリケーションがユーザーをリダイレクトするためのリダイレクトURI をコントロールしたいとき
- ユーザーからのリクエストに対する許可をカスタマイズしたいとき
プロシージャ
OAuth 資格情報のOAuthClientId、OAuthClientSecret、CallbackURL を取得するには、OAuth アプリケーションの作成が必要です。 これには、アプリケーション本体の作成、アプリケーションのコールバックURL の設定、パーミッションスコープの設定が含まれます。
アプリケーションの作成
OAuth アプリケーションを作成すると、2つのOAuth クライアント資格情報、OAuthClientId およびOAuthClientSecret が取得されます。
- https://api.slack.com/apps に移動します。
- アプリケーションの名前とワークスペースを指定します。クライアントId とクライアントシークレットは、[基本情報]の[アプリの認証情報]セクションにリストされています。
- 今後使用するために、クライアントId とクライアントシークレットを控えておきます。
コールバックURL の設定
アプリケーションを作成したら、CallbackURL を定義します。
- アプリケーション設定で、OAuth & Permissions に移動します。
- [リダイレクトURL]セクションで[新しいリダイレクトURLを追加]をクリックします。
- コールバック URL を http://127.0.0.1:33333、もしくはお好みのポートに設定します。
- URLを控えておきます。
権限スコープの設定
すべての利用可能な機能を使用するには、GetOAuthAuthorizationURL とGetOAuthAccessToken プロシージャ、およびアプリケーション自体で必要なスコープを指定する必要があります。
OAuth アプリケーションで適切なスコープを設定するには:
- アプリの設定で、OAuth & 権限 -> スコープに移動します。
- 権限スコープの選択に移動します。
- メニューをクリックして、スコープまたはAPI メソッドごとに権限を追加します。
必要なスコープ:
channels:read, groups:read, im:read, mpim:read, channels:write, groups:write, im:write, mpim:write, channels:history, groups:history,
im:history, mpim:history, search:read, chat:write:user, chat:write:bot, files:read, files:write:user, pins:read, pins:write, usergroups:read,
usergroups:write, reminders:read, reminders:write, users:read, users.profile:write.
これらの値はすべて、GetOAuthAuthorizationURL およびGetOAuthAccessToken プロシージャのデフォルトスコープとして送信されます。
カスタムOAuth アプリケーションの配布
OAuth アプリケーションを他のワークスペースのユーザーが利用できるようにし、インストールできるようにするには:- アプリケーションの設定(設定セクション)で、Manage Distribution をクリックします。
- コールバックURL の設定と権限の設定の手順を完了します。
- Activate Public Distribution をクリックします。