次の方法で共有


チュートリアル: iOS (Swift) アプリで保護された Web API を呼び出す

適用対象: 白いチェック マーク記号が付いた緑の円。 従業員テナント 白いチェック マーク記号が付いた緑の円。 外部テナント (詳細はこちら)

これは、Microsoft Entra ID を使用してユーザーをサインインさせ、保護された Web API を呼び出す方法について説明するチュートリアル シリーズの 4 番目のチュートリアルです。

このチュートリアルでは、次の操作を行います。

  • 保護された Web API を呼び出します。

前提条件

API の呼び出し

トークンを取得したら、アプリでそれを HTTP ヘッダーで使用して、許可された要求を Microsoft Graph に対して行うことができます。

ヘッダー キー 価値
認可 ベアラー <access-token>

以下のコードを ViewController クラスに追加します。

    func getContentWithToken() {

        // Specify the Graph API endpoint
        let graphURI = getGraphEndpoint()
        let url = URL(string: graphURI)
        var request = URLRequest(url: url!)

        // Set the Authorization header for the request. We use Bearer tokens, so we specify Bearer + the token we got from the result
        request.setValue("Bearer \(self.accessToken)", forHTTPHeaderField: "Authorization")

        URLSession.shared.dataTask(with: request) { data, response, error in

            if let error = error {
                self.updateLogging(text: "Couldn't get graph result: \(error)")
                return
            }

            guard let result = try? JSONSerialization.jsonObject(with: data!, options: []) else {

                self.updateLogging(text: "Couldn't deserialize result JSON")
                return
            }

            self.updateLogging(text: "Result from Graph: \(result))")

            }.resume()
    }

Microsoft Graph API の詳細については、Microsoft Graph API に関するページを参照してください。

アプリをテストする

アプリをビルドし、テスト デバイスまたはシミュレーターに展開します。 サインインして、Microsoft Entra ID または個人用 Microsoft アカウントのトークンを取得できるようになります。

ユーザーは、アプリに初めてサインインするときに、Microsoft Identity から、要求されたアクセス許可に同意するよう求められます。 ほとんどのユーザーは同意できますが、一部の Microsoft Entra テナントではユーザーによる同意が無効になっており、全ユーザーに代わって管理者が同意を行う必要があります。 このシナリオをサポートするには、アプリのスコープを登録します。

サインインした後、Microsoft Graph の /me エンドポイントから返されたデータがアプリに表示されます。

次のステップ

保護された Web API を呼び出すモバイル アプリを作成するには、複数のパートで構成される次のシナリオ シリーズを参照してください。

これは、Microsoft Entra External ID を使用してユーザーのサインインと保護された Web API の呼び出しについて説明するチュートリアル シリーズの 4 番目のチュートリアルです。

このチュートリアルでは、次の操作を行います。

  • 保護された Web API を呼び出します。

前提条件

API の呼び出し

iOS アプリから保護された Web API を呼び出すには、次のコードを使用します。

    func getContentWithToken() {
        // Specify the API endpoint in _Configuration.swift_ file you created earlier
        guard let url = URL(string: Configuration.kProtectedAPIEndpoint) else {
            let errorMessage = "Invalid API url"
            print(errorMessage)
            updateLogging(text: errorMessage)
            return
        }
        var request = URLRequest(url: url)

        // Set the Authorization header for the request. We use Bearer tokens, so we specify Bearer + the token we got from the result
        request.setValue("Bearer \(self.accessToken)", forHTTPHeaderField: "Authorization")

        self.updateLogging(text: "Performing request...")

        URLSession.shared.dataTask(with: request) { data, response, error in

            if let error = error {
                self.updateLogging(text: "Couldn't get API result: \(error)")
                return
            }

            guard let httpResponse = response as? HTTPURLResponse,
                  (200...299).contains(httpResponse.statusCode)
            else {
                self.updateLogging(text: "Couldn't get API result: \(error)")
                return
            }

            guard let data = data, let result = try? JSONSerialization.jsonObject(with: data, options: []) else {
                self.updateLogging(text: "Couldn't deserialize result JSON")
                return
            }

            self.updateLogging(text: """
                                Accessed API successfully using access token.
                                HTTP response code: \(httpResponse.statusCode)
                                HTTP response body: \(result)
                                """)

            }.resume()
    }

このコードでは、API エンドポイントを指定し、その有効性を確認します。 次に、要求オブジェクトを構築し、取得したアクセス トークンを使用して承認ヘッダーを設定します。 要求の開始をログに記録した後、URLSessionを使用して非同期的に要求を実行します。

完了後、要求中にエラーが発生したかどうかを確認します。 エラーが発生すると、対応するメッセージがログに記録されます。 次に、HTTP 応答の成功を検証し、200 から 299 の状態コードの範囲内であることを確認します。 その後、受信した JSON データを逆シリアル化します。 最後に、ログ テキストが更新され、API への正常なアクセスと関連する HTTP 応答の詳細が示されます。