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

  • リリースバージョン: Xanadu
  • 更新日 2024年08月01日
  • 所要時間：6分

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

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

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

    始める前に

    Git プロバイダー ( GitHub、 GitLab、 Bitbucket など) を使用して OAuth アプリケーションを作成し、インスタンスにリダイレクトするように構成します。この OAuth アプリケーションでは、ホームページ URL としてインスタンス URL を使用し、認証コールバック URL として https://<instance>/oauth_redirect.do を使用します。

    必要なロール：admin

    このタスクについて

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

    手順

    1. 移動先 すべて > システム 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
      注:
      他の Git プロバイダーを使用する場合は、これらのスクリプトを例として使用して、OAuth プロバイダー用に独自の OAuth API スクリプトを作成できます。スクリプトの名前は「Oauth」で始まる必要があります。
      デフォルトの権限許可タイプ トークンを確立するために使用するデフォルトの権限許可タイプ[認証コード] を選択します。

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

    次のタスク

    ServiceNow IDE を使用する開発者は、独自の OAuth 2.0 認証情報を構成する必要があります。詳細については、「Git プロバイダーに接続するための OAuth 2.0 認証情報の構成 ServiceNow IDE」を参照してください。

    Git プロバイダーに接続するための OAuth 2.0 認証情報の構成 ServiceNow IDE

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

    始める前に

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

    必要なロール：admin

    手順

    1. 移動先 すべて > ServiceNow IDE.
    2. コマンドパレットを開くには、次のいずれかのキーボードショートカットを使用します。
      • Windows：Ctrl-Shift-P
      • Mac：Cmd-Shift-P
    3. Git に入る: IDE Git 資格情報を設定し、Enter キーを押します。
    4. [新規 Git 認証情報] フォームで [ OAuth] を選択します。
    5. フォームのフィールドに入力します。
      表 : 2. 新しい Git 認証情報フォーム
      Field (フィールド) Description (説明)
      Git リポジトリ URL Git プロバイダーのドメイン名またはリポジトリ URL。

      Git プロバイダーのドメイン名を指定すると、この認証情報がドメイン内のすべてのリポジトリに使用されます。
      Git ユーザー名 Git ユーザー名。
      OAuth プロファイルを選択 Git プロバイダーの OAuth 2.0 認証情報。

      OAuth プロファイルはアプリケーションレジストリを使用して作成されます。アプリケーションレジストリはアドミニストレーターが設定する必要があります。
    6. [送信] を選択します。

    タスクの結果

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

    次のタスク

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

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