コネクタービルダーの承認ドキュメント
承認ヘルプトピックには、ユーザーが接続を作成・認証する上で役立つ、あらゆる関連情報を盛り込む必要があります。
作成者のコネクターをユーザーが初めてフローに追加する際に、Okta Workflowsはユーザーに接続の構成を求めます。この接続は、ユーザーのアカウントまたは環境の検証に使用されます。
前提条件
前提条件セクションには、接続の構成前にユーザーに求められるあらゆる事項を指定します。たとえば、APIキーを生成する、またはOAuthアプリ統合を構成する必要があるとします。例:
サンプル:APIトークンを生成する
APIへの認証は、インスタンスレベルのベアラートークンを介して制御されます。トークンを生成するには:
-
ログインして[Settings(設定)]をクリックします。
-
[Access(アクセス)]タブをクリックします。
-
インスタンスに固有のAPI URLを特定します。
-
[Add(追加)]をクリックしてAPIキーを作成します。
-
APIトークンの名前を[Name(名前)]に指定します。
-
[Save(保存)]をクリックします。
-
APIトークンが提供されるダイアログで、可視性の記号をクリックしてAPIトークンを表示します。
-
[Copy(コピー)]をクリックしてAPIトークンをクリップボードにコピーします。
-
[Close(閉じる)]をクリックします。
接続の構成
認証トピックには、サービスとの接続の作成方法を盛り込む必要があります。例:
サンプル:接続を作成する
-
[Connections(接続)]ページの[New Connection(新規接続)]をクリックします。
-
[New Connection(新規接続)]ダイアログの[Connection Nickname(接続ニックネーム)]に文字列を追加します。これは、複数の接続の作成してチームで共有する場合に便利です。
-
前提条件セクションで作成したAPIトークンを[API Token(APIトークン)]フィールドに貼り付けます。
-
[Create(作成)]をクリックします。
サポートされるスコープ
OAuthまたはトークンベースのその他の認証向けに、コネクターの使用に必要なスコープのリストを盛り込む必要があります。スコープのセットアップに必要なものがあれば、その詳細を前提条件または構成セクションに盛り込みます。例:
サンプル:サポートされるスコープ
-
https://www.googleapis.com/auth/userinfo.profile
-
https://www.googleapis.com/auth/userinfo.email
-
https://www.googleapis.com/auth/gmail.settings.basic
例
参考情報については、コネクタービルダー の承認トピックを参照してください。
-
BoxコネクターのAuthorization(承認)。
-
FreshserviceコネクターのAuthorization(承認)。