ServiceNow IDE の OAuth 2.0 を使用した Git プロバイダーへの接続

  • リリースバージョン: Yokohama
  • 更新日 2025年01月30日
  • 所要時間：7分

    • ServiceNow IDE から Git プロバイダーに接続するための OAuth 2.0 アプリケーションレジストリと認証情報を設定します。

    ServiceNow IDE の OAuth 2.0 アプリケーションレジストリの構成

    Git プロバイダーに関連付けられている OAuth 2.0 プロバイダーに、クライアント ID とシークレットを送信する方法を構成します。

    始める前に

    Git プロバイダーを使用して OAuth アプリケーションを作成し、インスタンスにリダイレクトするように構成します。この OAuth アプリケーションでは、インスタンス URL をホームページ URL として使用し、 https://<instance>/oauth_redirect.do を認証コールバック URL として使用します。デフォルトでは、 GitHub、 GitLab、 Bitbucket、および Azure リポジトリがサポートされています。

    重要:
    Azureリポジトリの場合、シークレットを追加する前に、[クライアントシークレット] フィールドの最大長を 2048 に更新する必要があります。
    1. 次のように移動する。 All (すべて) > システム定義 > テーブル.
    2. [名前] フィールドに「oauth_entity」と入力して、テーブルをフィルタリングします。
    3. アプリケーションレジストリ [oauth_entity] テーブルを選択します。
    4. [列] 関連リストで [クライアントシークレット] 列を見つけ、その [最大長] 属性の値として「2048」と入力します。
    5. [Update (更新)] を選択します。

    必要なロール：admin

    このタスクについて

    ServiceNow IDE で OAuth 2.0 認証を使用するには、Git プロバイダーから作成した OAuth アプリケーションを登録する必要があります。次の手順に従って、インスタンスで OAuth アプリケーションレジストリ [oauth_entity] を構成します。

    手順

    1. 次のように移動する。 All (すべて) > システム OAuth > アプリケーションレジストリー をクリックし、 新規 を選択します。
    2. [インターセプター] ページで、[サードパーティ OAuth プロバイダーに接続します] を選択します。
    3. フォームのフィールドに入力します。

      フォームのフィールドの詳細については、「Connect to a third-party OAuth provider」を参照してください。

      表 : 1. アプリケーションレジストリフォーム
      フィールド 説明
      名前 サードパーティ OAuth 接続のための一意の名前。
      クライアント ID Git プロバイダーの OAuth アプリケーションのクライアント ID。
      クライアントシークレット Git プロバイダーの OAuth アプリケーションのクライアントシークレット。
      OAuth API スクリプト 外部 OAuth プロバイダーへの要求および応答のカスタマイズに使用されるスクリプトGit プロバイダーに応じて、次のいずれかを選択します。
      • GitHub：OauthAPIScriptForGitHub
      • GitLab：OauthAPIScriptForGitLab
      • Bitbucket：OauthAPIScriptForBitbucket
      • Azure リポジトリ:OauthAPIScriptForAzureRepos
      注:
      他の Git プロバイダーを使用する場合は、これらのスクリプトを例として使用して、OAuth プロバイダー用に独自の OAuth API スクリプトを作成できます。スクリプトの名前は「Oauth」で始まる必要があります。
      デフォルトの権限許可タイプ トークンを確立するために使用するデフォルトの権限許可タイプ[認証コード] を選択します。

      アクセストークンを取得するためクライアントに認証コードが付与され、それがリソースへのアクセスを取得するために使用されます。
      リフレッシュ トークンの有効期間 リフレッシュトークンが有効になる時間 (秒)。
      アプリケーション このレコードを含むアプリケーションスコープです。
      アクセス可能 すべてのアプリケーションスコープから、またはこのスコープからのみアプリケーションレジストリにアクセスできるようにするオプション。
      アクティブ OAuth アプリケーションをオンまたはオフにするためのオプション。
      認証 URL Git ドメイン用 OAuth 認証コードのエンドポイント。例：
      • GitHub：https://github.com/login/oauth/authorize
      • GitLab：https://gitlab.com/oauth/authorize
      • Bitbucket：https://bitbucket.org/site/oauth2/authorize
      • Azure リポジトリ: https://app.vssps.visualstudio.com/oauth2/authorize
      トークン URL Git ドメインの OAuth サーバートークンエンドポイント。例：
      • GitHub：https://github.com/login/oauth/access_token
      • GitLab：https://gitlab.com/oauth/token
      • Bitbucket：https://bitbucket.org/site/oauth2/access_token
      • Azure リポジトリ: https://app.vssps.visualstudio.com/oauth2/token
      リダイレクト URL OAuth コールバックエンドポイント空の場合、インスタンスは値 https://<instance>/oauth_redirect.do を自動生成します。
      相互認証を有効にします 相互認証を使用するためのオプション。トークンの要求と失効に対する相互認証の使用をオフにするには、このオプションをオフにしておきます。
      認証情報の送信 OAuth クライアントが要求にクライアント認証情報を入力する方法。
      • [ GitHub]、[ GitLab]、または [ Bitbucket] で、[ 基本認証ヘッダーとして] を選択します。
      • Azureリポジトリの場合は、[要求本文内 (フォーム URL エンコード)] を選択します。
    4. [Submit (送信)] を選択します。

    次のタスク

    ServiceNow IDE を使用する開発者は、独自の OAuth 2.0 認証情報を構成する必要があります。

    OAuth 2.0 認証情報を構成して ServiceNow IDE で Git プロバイダーに接続する

    OAuth 2.0 認証情報を使用して Git ドメインまたはリポジトリに接続し、ServiceNow IDE からソースコントロールのアプリケーションを管理します。

    始める前に

    • アドミニストレーターは、Git プロバイダーに関連付けられた OAuth 2.0 プロバイダーにクライアント ID とシークレットを送信する方法を構成する必要があります。詳細については、「ServiceNow IDE の OAuth 2.0 アプリケーションレジストリの構成」を参照してください。
    • Git プロバイダー ( GitHub、 GitLab、 Bitbucket、 Azure Repos などのアプリケーションの専用 Git リポジトリを作成します。

    必要なロール: sn_glider.ide_git_user または admin

    手順

    1. 次のように移動する。 All (すべて) > アプリ開発 > ServiceNow IDE.
    2. コマンドパレットを開くには、次のいずれかのキーボードショートカットを使用します。
      • Windows：Ctrl-Shift-P
      • Mac：Cmd-Shift-P
    3. Git: Set IDE Git credentials と入力し、Enter キーを押します。
    4. [新規 Git 認証情報 (New Git credential)] フォームで [OAuth] を選択します。
    5. フォームのフィールドに入力します。
      表 : 2. [新規 Git 認証情報 (New Git credential)] フォーム
      Field (フィールド) Description (説明)
      Git リポジトリの URL (Git repository URL) Git プロバイダー認証情報に関連付けられた Git リポジトリへの URL。
      Git ユーザー名 (Git username) Git ユーザー名。
      OAuth プロファイルを選択 (Select an OAuth profile) Git プロバイダーの OAuth 2.0 認証情報。

      OAuth プロファイルはアプリケーションレジストリを使用して作成されます。アプリケーションレジストリはアドミニストレーターが設定する必要があります。
      この認証情報をすべてのリポジトリに使用 Git リポジトリ URL に関連付けられた Git ドメイン内のすべてのリポジトリの認証情報を使用するオプション。
    6. [送信] を選択します。

    タスクの結果

    Git コマンドを初めて使用するときは、Git プロバイダーからユーザーを承認するように求められます。

    次のタスク

    リポジトリを初期化またはクローンした後、ソースコントロールの使用を開始できます。詳細については、「ServiceNow IDE でソースコントロールを使用する」を参照してください。

    既存の Git 認証情報を管理するには、コマンドパレットから Git: Manage Git credentials コマンドを使用します。