カスタムOAuth アプリケーションの作成

CData はOAuth アプリケーション認証情報を製品に組み込んでおり、デスクトップアプリケーションまたはヘッドレスマシン経由でSlack に接続する際に使用できます。（OAuthAccessToken およびその他の設定パラメータを取得および設定する方法についての情報は、 の デスクトップ認証セクションを参照してください。）

ただし、Web 経由で接続するには、カスタムOAuth アプリケーションの作成が必要です。また、カスタムOAuth アプリケーションは、一般的に使用される3つの認証フローをすべてシームレスにサポートするため、これらの認証フロー用にカスタムOAuth アプリケーションを作成（独自のOAuth アプリケーションクレデンシャルを使用）することもできます。

カスタムOAuth アプリケーションは、次のような場合に有用です。

• 認証ダイアログのブランディングをコントロールしたいとき
• ユーザー認証後にアプリケーションがユーザーをリダイレクトするためのリダイレクトURI をコントロールしたいとき
• ユーザーからのリクエストに対する許可をカスタマイズしたいとき

手順

OAuth 資格情報のOAuthClientId、OAuthClientSecret、CallbackURL を取得するには、OAuth アプリケーションの作成が必要です。 これには、アプリケーション本体の作成、アプリケーションのコールバックURL の設定、パーミッションスコープの設定が含まれます。

アプリケーションの作成

OAuth アプリケーションを作成すると、2つのOAuth クライアント資格情報、OAuthClientId およびOAuthClientSecret が取得されます。

1. https://api.slack.com/apps に移動します。
2. Create New App > From scratch をクリックします。
3. アプリケーションの名前とワークスペースを指定し、ワークスペースを選択してCreate App をクリックします。新しいアプリのBasic Information > App Credentials ページが開きます。
4. OAuth 2.0 で認証する場合（AuthScheme がOAuth に設定されている場合）は、今後使用するためにClient Id とClient Secret を控えておきます。

コールバックURL の設定

アプリケーションを作成したら、CallbackURL を定義します。

1. アプリケーション設定で、Features > OAuth & Permissions に移動します。
2. Redirect URL セクションでAdd a New Redirect URL をクリックします。
3. コールバックURL をhttps://127.0.0.1:33333、もしくはお好みのポートに設定し、Add > Save URLs をクリックします。
4. URL を控えておきます。

権限スコープの設定

すべての利用可能な機能を使用するには、アプリケーション自体で必要なスコープを指定する必要があります。

OAuth アプリケーションで適切なスコープを設定するには：

1. アプリ設定で、Features > OAuth & Permissions > Scopes に移動します。
2. 通常のユーザーを認証する場合はUser Token Scopes に、ボットユーザーを認証する場合はBot Token Scopes に移動します。
3. Add an OAuth Scope をクリックして、Add permission by Scope or API method... というスコープセレクタを開きます。
4. リストから目的のスコープを選択します。
5. 目的のスコープを追加し終えるまで、ステップ3～4を繰り返します。

最新のアプリに必要なスコープ（V2 OAuth 2.0）：

OAuthVersion をv2 に設定した場合（Slack のOAuth2.0 "V2" 実装）、以下のスコープを有効にします。

• calls:read
• calls:write
• channels:read
• channels:history
• channels:write
• chat:write
• dnd:read
• dnd:write
• files:read
• files:write
• groups:read
• groups:history
• groups:write
• im:read
• im:history
• im:write
• links:read
• links:write
• mpim:read
• mpim:history
• mpim:write
• pins:read
• pins:write
• reactions:read
• reactions:write
• reminders:read
• reminders:write
• search:read
• stars:read
• stars:write
• team:read
• usergroups:read
• usergroups:write
• users:read
• users:read.email
• users.profile:write

"Sign in with Slack" アプリに必要なスコープ（OpenID Connect）：

OAuthVersion にopenid を設定した場合（"Sign in with Slack" OpenID Connect フロー）、以下のスコープのみを指定します：

• openid
• email
• profile

OAuth トークンの取得（トークン認証の場合のみ）

トークン認証で認証する場合（AuthScheme がToken に設定されている場合）、以下の手順でOAuth トークンを生成します：

1. Features > OAuth & Permissions > OAuth Tokens に移動し、Install to <ワークスペース名> をクリックします。トークン確認ページが開きます。
2. トークン確認ページでAllow をクリックします。OAuth & Permissions ページにリダイレクトされます。
3. OAuth トークンはOAuth Tokens > User OAuth Token に表示されます。後で使用するためにトークンの値を控えておきます。

カスタムOAuth アプリケーションの配布

OAuth アプリケーションを他のワークスペースのユーザーが利用できるようにし、インストールできるようにするには：

1. アプリケーションの設定（設定セクション）で、Manage Distribution をクリックします。
2. Activate Public Distribution をクリックします。