Table of contents
TOC
目次を折りたたむ
目次を展開する
最終更新日: 2017/11/10

OneNote の認証とアクセス許可

適用対象: OneDrive のコンシューマー ノートブック | Office 365 のエンタープライズ ノートブック

OneNote では、OneNote ノートブックへのセキュリティで保護されたアクセスを提供するために Microsoft アカウント (以前の Live Connect) および Azure Active Directory を使用します。ノートブックにアクセスする前に、まず Microsoft アカウントまたは Azure AD を使用して認証し、アクセス トークンを取得する必要があります。

プラットフォームを選ぶ:


OneDrive のコンシューマー ノートブックにアクセスするためには Microsoft アカウントが使用され、Office 365 のエンタープライズ ノートブックにアクセスするためには Azure AD が使用されます。

どちらの承認サービスも、OneNote との対話操作のために必要なアクセス トークンを提供するために OAuth 2.0 プロトコルを実装しています。 OneNote API に対するすべての要求は、Authorization ヘッダーに有効なアクセス トークンを含める必要があります。

この記事では、認証に関連するプロセスのうち、ユーザーのアクションが必要な部分について説明します。クライアント ID を取得するためにアプリを登録し、必要なアクセス許可を指定し、承認サービスを呼び出してユーザーのサインインを行い、アクセス トークンを取得します。

プラットフォームによっては、SDK を使用して認証フローを簡略化できる場合があります。

OneNote は今後、単一の認証モデルおよび v2.0 アプリ モデルによるアプリ登録をサポートする予定です。 関連する最新ニュースに関しては OneNote 開発者ブログをご覧ください。

API を試してみる

API を試してみる場合、対話型コンソールの 1 つを使用して、OneDrive のコンシューマー ノートブックを呼び出すことができます。 または、この記事の手順に従うことによって、Fiddler など自分のお気に入りのネットワーク ツールを使用してアクセス トークンを取得することもできます。

Microsoft アカウントを使用して認証する (コンシューマー アプリ)

  1. アプリケーションを登録し、クライアント ID およびシークレットを取得する
  2. OneNote のアクセス許可を選ぶ
  3. ユーザーをサインインさせ、アクセス トークンを取得する
  4. アクセス トークンの期限が切れた後、新しいアクセス トークンを取得する

アプリケーションを登録し、クライアント ID とシークレットを取得する (コンシューマー アプリ)

開始するには、アプリケーションを Microsoft に登録する必要があります。このプロセスでは、アプリからリンクするサービス プリンシパルを作成し、承認サービスに送信するクライアント ID およびシークレットを生成します。

アプリがコンシューマー ノートブックのみにアクセスする場合、またはコンシューマー ノートブックおよびエンタープライズ ノートブックの両方にアクセスする場合に、これを行ってください。

  1. Microsoft アカウントで、Microsoft アカウント デベロッパー センターにサインインします (Windows ストア アプリを開発している場合は、代わりにこちらの方法で進めてください)。

    Microsoft アカウントをお持ちでない場合は、作成する必要があります。 定期的にチェックするメール アドレスを使う必要があります。 おすすめのアプリ ページでお客様のアプリを取り上げる場合や、アプリから予期しないネットワーク トラフィックが届いた場合などに、ご連絡を差し上げることがあります。 迷惑メールを送ったり、個人情報を販売したりすることはありません。

  2. [アプリケーションの作成] を選択します。

  3. アプリへのアクセス許可を付与するようにユーザーに求めるときに表示する名前を入力し、アプリの優先言語を選択します。

  4. 使用条件とプライバシーおよび Cookie ポリシーに同意する場合は、[同意] を選択して登録を続けます。

  5. API 設定ページで、アプリの種類を選択し、アプリに関する情報を提供します。

    Web アプリケーション (サーバー側アプリ)


    a. モバイルまたはデスクトップ クライアント アプリの場合は、[いいえ] を選択してください。

    b.ターゲット ドメインに関して、サービス URL を入力します。

    c.認証が完了し、アプリへのアクセス許可を付与した後にユーザーが移動するリダイレクト URL を入力します。


    ネイティブ アプリケーション (デバイスにインストールされたもの)


    a. モバイルまたはデスクトップ クライアント アプリの場合は、[はい] を選択してください。

    b.(オプション) ターゲット ドメインに関して、モバイル サービス URL を入力します。

    c.(オプション) リダイレクト URL に関して、有効な URL を入力します。これはアプリのための識別子として機能します。物理的なエンドポイントである必要はありません。*


アプリ設定ページで表示されるクライアント ID およびクライアント シークレット、および入力している場合はリダイレクト URL を保存します。

Windows ストア アプリ

Windows アプリを作成している場合、代わりにアプリケーションを Windows デベロッパー センター に登録します。 これによりパッケージ ID (パッケージ SID) が提供され、クライアント ID の代わりに使用することになります。

  1. Microsoft アカウントで Windows デベロッパー センターにサインインします。
  2. ダッシュボードで、[新しいアプリの作成] を選択し、アプリ名を入力します。
  3. Visual Studio で、Windows ストア アプリ プロジェクトを右クリックし、[ストア]、[アプリケーションをストアと関連付ける] の順に選択します。
  4. [アプリケーションをストアと関連付ける] ウインドウで、Microsoft アカウントでサインインし、アプリを選択し、[次へ]、[関連付ける] の順に選択します。 これにより、必要な Windows ストア登録情報がアプリケーション マニフェストに追加されます。
  5. ユニバーサル Windows アプリに関しては、Windows Phone プロジェクトのための前述の 2 つのステップを繰り返します。

OneNote のアクセス許可のスコープを選択する (コンシューマー アプリ)

アクセス許可のスコープは、OneNote コンテンツへのアクセスのレベルを表します。アプリに必要なアクセス許可を要求し、ユーザーはアプリにサインインするときにアクセス許可を付与または拒否します。ユーザーは、保有するアクセス許可のみを付与することができます。

アプリの作業に必要な最低レベルのアクセス許可を選択します。複数のスコープを要求することができます。

スコープ (コンシューマー)説明
office.onenote_createユーザーの OneNote のノートブックのリストを表示すること、そして新しいページを作成することができますが、既存のページの表示または編集はできません。ユーザーのノートブックの階層を列挙して、任意の場所にページを作成することができます。
office.onenote_update_by_appアプリによって作成されるすべてのページの作成、表示、および変更ができます。
office.onenote_updateユーザーの OneNote のノートブックとページのすべてのコンテンツの作成、表示、および変更ができます。
office.onenoteOneNote のノートブックとページの表示ができますが、変更はできません。
wl.signinMicrosoft アカウントのアクセス許可のスコープ
アプリケーションによるシングル サインオン機能の利用を許可します。
wl.offline_accessMicrosoft アカウントのアクセス許可のスコープ
ユーザーがアクティブでないときでも、アプリケーションがオフラインで作業ができるように、更新トークンの受信を許可します。 このスコープはトークン フローでは使用できません。

Office 365 のノートブックにアクセスするためのアクセス許可については、「OneNote のアクセス許可を選択する (エンタープライズ アプリ)」を参照してください。

ユーザーをサインインさせ、アクセス トークンを取得する (コンシューマー アプリ)

アプリは承認サービスに接続してサインイン プロセスを開始します。ユーザーがまだサインインしていない、またはまだ同意していない場合、サービスはユーザーに対して認証情報の入力およびアプリが要求しているアクセス許可への同意を求めます。認証および承認が成功した場合、OneNote API に対する要求に含めるアクセス トークンを受け取ります。

重要! アクセス トークンおよび更新トークンは、ユーザーのパスワードの場合と同様に、安全な方法で扱ってください。

プラットフォームによっては、SDK を使用して認証フローを簡略化できる場合があります。

認証フローを選択します。どちらも標準の OAuth 2.0 フローです。

フロー説明
トークン フロー

一度の呼び出しでアクセス トークンを取得します。すばやくアクセスするのに有効ですが、長期的なアクセスに必要な更新トークンが提供されません。

これは暗黙的フローとも呼ばれます。

コード フロー

最初の呼び出しにおいて認証コードを取得し、2 回目の呼び出しでそのコードとアクセス トークンを交換します。 wl.offline-access アクセス許可スコープと共に使用する場合、アプリは長期的なアクセスを可能にする更新トークンを受け取ります。

これは認証コード フローとも呼ばれます。

トークン フローでユーザーをサインインさせる

Web ブラウザーまたは Web ブラウザー コントロールで、以下の URL 要求を読み込みます。

GET https://login.live.com/oauth20_authorize.srf
  ?response_type=token
  &client_id={client_id}
  &redirect_uri={redirect_uri}
  &scope={scope}
必須のクエリ文字列パラメーター説明
response_type使用している認証フローの種類 この場合は、token
client_idアプリケーション用に作成されたクライアント ID。
redirect_uriアプリケーション用に登録したリダイレクト URL。 これを指定していないモバイルおよびデスクトップ アプリは、次のものを使用できます: https://login.live.com/oauth20_desktop.srf
scopeアプリケーションで必要となるスコープ。
例: office.onenote%20wl.sign-in

認証および承認が成功すると、Web ブラウザーはリダイレクト URL へリダイレクトを行い、アクセス パラメーターを URL に追加します。次の例が示すとおり、パラメーターには、
access_tokentoken_type が含まれます。 アクセス トークンは、expires_in プロパティによって指定された秒数だけ有効です。

https://your-redirect-url
  #access_token=EwB4Aq...%3d
  &token_type=bearer
  &expires_in=3600
  &scope=office.onenote wl.signin
  &user_id=c519ea026ece84de362cfa77dc0f2348

コード フローでユーザーをサインインさせる

コード フローにおいて、アクセス トークンの取得は 2 段階の手順で行われます。

  1. ユーザーをサインインさせ、認証コードを取得します。
  2. コードをアクセス トークンと交換します。


手順 1. ユーザーをサインインさせ、認証コードを取得します。 サインイン プロセスを開始するために、Web ブラウザーまたは Web ブラウザー コントロールで以下の URL 要求を読み込みます。

https://login.live.com/oauth20_authorize.srf
  ?response_type=code
  &client_id={client-id}
  &redirect_uri={redirect-uri}
  &scope={scope}
必須のクエリ文字列パラメーター説明
response_type使用している認証フローの種類 この場合は、code
client_idアプリケーション用に作成されたクライアント ID。
redirect_uriアプリケーション用に登録したリダイレクト URL。 これを指定していないモバイルおよびデスクトップ アプリは、次のものを使用できます: https://login.live.com/oauth20_desktop.srf
scopeアプリケーションで必要となるスコープ。
例: office.onenote wl.signin wl.offline_access

次の例が示すように、認証および承認が成功すると、Web ブラウザーはリダイレクト URL へリダイレクトを行い、URL にコード パラメーターを付加します。 手順 2 で使用するために、コードの値をコピーします。 このコードは、数分間有効です。

https://your-redirect-uri
  ?code=M57010781-9e8c-e31e-ca0d-46bc104236c4

手順 2. 認証コードをアクセス トークンおよび更新トークンと交換します。 適切にエンコードされた URL 文字列をメッセージ本文に記載した次の HTTP 要求を送信します。

POST https://login.live.com/oauth20_token.srf
Content-Type: application/x-www-form-urlencoded

grant_type=authorization_code
&client_id={client-id}
&client_secret={client-secret}
&code={code}
&redirect_uri={redirect-uri}
必要な本文パラメーター説明
grant_type要求の許可の種類。 この例では、authorization_code
client_idアプリケーション用に作成されたクライアント ID。
client_secretアプリケーション用に作成されたクライアント シークレット。
code前の手順で URL パラメーターとして受け取ったコード。
redirect_uriアプリケーション用のリダイレクト URL。 これは、最初の要求における redirect_uri と一致する必要があります。

成功した場合、次の例に示すように、応答には access_token (および wl.offline_access スコープを要求した場合は、refresh_token) の入った JSON 文字列が含まれます。 アクセス トークンは、expires_in プロパティによって指定された秒数だけ有効です。

{
  "token_type":"bearer",
  "expires_in":3600,
  "scope":"office.onenote wl.sign-in wl.offline-access",
  "access_token":"EwCAAq...wE=",
  "refresh_token":"MCvePE...$$",
  "user_id":"c519ea026ece84de362cfa77dc0f2348"
}

OneNote API に対する要求にアクセス トークンを含める

OneNote API に対するすべての要求は、Authorization ヘッダー内でベアラー トークンとしてアクセス トークンを送信する必要があります。 たとえば、次の要求は 5 つのノートブックを取得し、それらはアルファベット順に名前で並べ替えられます。

GET https://www.onenote.com/api/v1.0/me/notes/notebooks?top=5
Authorization: Bearer {access-token}

アクセス トークンは 1 時間のみ有効であるため、その期限が切れた場合は新しいトークンを取得する必要があります。トークンを使用する前に、その有効期限をチェックし、必要に応じて新しいアクセス トークンを取得する必要があります。ユーザーはサインインした状態を保持することができ、サインアウトする場合やアクセス許可を取り消す場合を除き、アクセス許可に再度同意する必要はありません。

アクセス トークンの期限が切れた後、新しいアクセス トークンを取得する (コンシューマー アプリ)

更新トークンを使用するか、または認証手順を最初から再度行うことによって新しいアクセス トークンを要求することができます。

アクセス トークンの期限が切れた場合、API に対する要求は 401 Unauthorized 応答を返します。 アプリはこの応答を処理しなければならないため、要求を送信する前にトークンの有効期限を確認する必要があります。

適切にエンコードされた URL 文字列をメッセージ本文に記載した次の HTTP 要求を送信します。

wl.offline_access アクセス許可を要求し、コード フローを使用した場合、更新トークンを受け取ります。

POST https://login.live.com/oauth20_token.srf
Content-Type: application/x-www-form-urlencoded

grant_type=refresh_token
&client_id={client-id}
&client_secret={client-secret}
&redirect_uri={redirect-uri}
&refresh_token={refresh-token}
必要な本文パラメーター説明
grant_type要求の許可の種類。 この例では、refresh_token
client_idアプリケーション用に作成されたクライアント ID。
client_secretアプリケーション用に作成されたクライアント シークレット。
redirect_uriアプリケーション用のリダイレクト URL。 これはトークンを取得するために使用した redirect_uri と一致する必要があります。
refresh_token以前に受信した更新トークン。

成功した場合、次の例に示すように、POST 要求に対する応答には access_token および refresh_token の入った JSON 文字列が含まれます。

{
  "token_type":"bearer",
  "expires_in": 3600,
  "scope":"office.onenote wl.sign-in wl.offline-access",
  "access_token":"EwB4Aq...wE=",
  "refresh_token":"MCVw8k...$$",
  "user_id":"c519ea026ece84de362cfa77dc0f2348"
}

保存されたトークンを更新し、アプリが最も長い有効期限のトークンを保有するようにします。

ユーザーをサインアウトする (コンシューマー アプリ)

ユーザーをサインアウトするには、次の手順を実行します:

  1. 受信または保存しているすべてのキャッシュ アクセス トークンまたは更新トークンを削除します。
  2. アプリケーションにおいてすべてのサインアウト操作を実施します (たとえば、ローカルの状態のクリーンアップ、すべてのキャッシュ アイテムの削除等)。
  3. この URL を使用して承認サービスを呼び出します。
https://login.live.com/oauth20_logout.srf
  ?client_id={client_id}
  &redirect_uri={redirect_uri}

この呼び出しは、シングル サインオンを有効にするすべての Cookie を削除し、ユーザーがサインインを要求されるようにします。

必須のクエリ文字列パラメーター説明
client_idアプリケーション用に作成されたクライアント ID 値。
redirect_uriアプリケーション用のリダイレクト URL。 これはトークンを取得するために使用した redirect_uri と一致する必要があります。

Cookie を削除した後、ブラウザーはリダイレクト URL へのリダイレクトを行います。リダイレクト ページは、認証クエリ文字列オプションを指定することなく読み込まれます。このことはユーザーがログアウトしたことを意味します。

アクセス権の取り消し

ユーザーは Microsoft アカウントの管理ページから、アプリケーションのアカウントへのアクセス権を取り消すことができます。

アプリに関する同意が取り消された場合、以前にアプリに対して提供されたすべての更新トークンは無効となります。トークンを更新しようとすると、次の応答を受け取ります。

{
  "error":"invalid_grant",
  "error_description":"The request was denied because one or more scopes requested are unauthorized or expired. The user must first sign in and grant the client application access to the requested scope."
}

新しいアクセスおよび更新トークンを要求するために、認証フローを最初から再度行う必要があります。

Azure AD を使用して認証する (エンタープライズ アプリ)

アプリケーションで (代理のアクセス許可ではなく) アプリケーションのアクセス許可を使用する場合には、「OneNote 認証と Azure AD アプリケーションのアクセス許可」を参照してください。

  1. アプリケーションを登録し、クライアント ID およびシークレットを取得する
  2. OneNote のアクセス許可を選ぶ
  3. ユーザーをサインインさせ、アクセス トークンを取得する
  4. アクセス トークンの期限が切れた後、新しいアクセス トークンを取得する

アプリケーションを登録し、クライアント ID およびシークレットを取得する (エンタープライズ アプリ)

開始するには、アプリケーションを Microsoft に登録する必要があります。このプロセスでは、アプリからリンクするサービス プリンシパルを作成し、承認サービスに送信するクライアント ID およびシークレットを生成します。

アプリがエンタープライズ ノートブックのみにアクセスする場合、またはコンシューマー ノートブックおよびエンタープライズ ノートブックの両方にアクセスする場合に、これを行ってください。

Office 365 サブスクリプションに関連付けられた Azure AD テナントにアプリを登録するには、次の作業が必要です。

  • Office 365 テナントへのグローバル管理者のアクセス許可を持つ Office 365 アカウントを取得する

    Office 365 Developer サブスクリプションをお試しいただくか、ご購入いただけます。あるいは、条件に合うプランをサブスクライブできます。

  • テナント用に OneDrive for Business をプロビジョニングする

    これにより、OneNote アプリケーションが利用可能になるため、OneNote のアクセス許可を指定することができます。 OneDrive for Business がプロビジョニングされているかどうかをチェックするため、Office 365 の資格情報 (someone@example.com または someone@example.onmicrosoft.com のような職場または学校アカウント) で OneNote Online にサインインします。

    ノートブックが表示されたら、これで設定は完了です。 "申し訳ございません。現在、ノートブックを取得できません..." と表示された場合、[マイ アカウントへ移動] > [次へ] を選択します。 OneDrive for Business ページが読み込まれたら、OneNote Online に戻って最新の情報に更新し、プロビジョニングを完了します。

    注:ユーザーのノートブックにアクセスする前に、ユーザーの個人用サイトを準備する必要があります。 OneNote API では、必要に応じて、サイトの自動プロビジョンが試行されます。

  • Office 365 サブスクリプションを Azure サブスクリプションと関連付ける

    これにより、Azure AD にアプリを登録し、管理することができます (詳細を見る)。

    Azure サブスクリプションがない場合は、次のセクションのオプション 1 を行います。Azure サブスクリプションがある場合は、オプション 2 を行います。

重要! 有効な Office 365 のライセンスのある Office 365 アカウントが必要です。 有効なライセンスのないユーザー アカウントでは、OneNote Online のノートブックを表示することができず、API によるノートブックの呼び出しも失敗します。 Office 365 の管理者は、状態の確認ならびにライセンスの割り当ておよび割り当て解除を行うことができます

MSDN サブスクライバー:無料の Office 365 Developer サブスクリプションを利用できる場合があり、Azure 特典を利用することによりコスト削減も可能です。 MSDN サブスクリプション ページで特典をご確認ください。

Azure サブスクリプションを Office 365 サブスクリプションと関連付ける

オプション 1:Office 365 サブスクリプションの管理者の資格情報を使用して、Azure サブスクリプションにサインアップします。 Azure サブスクリプションがない場合は、これを実行してください。 このプロセスでは、サブスクリプションを関連付けます。

  1. Office 365 管理者の資格情報 (someone@example.com または someone@example.onmicrosoft.com のような職場または学校アカウント) で、Azure 管理ポータルにサインインします。

  2. "サブスクリプションが見つかりません" のページで、[Microsoft Azure にサインアップ] を選択します。 サインアップ ページが読み込まれ、Office 365 サブスクリプションからの一部の情報が表示されます。 このアカウントは、新しい Azure サブスクリプションのサービス管理者になります。

    Office 365 サブスクリプションが試用版か、または有料版かでサインアップの方法が異なります:

    試用版のサブスクリプションの場合、お支払い情報を [無料試用版] ページで入力します。 有料サブスクリプションに変更しない限り、課金されることはありません。

    サブスクリプション契約、プランの詳細、およびプライバシーに関する声明に同意する場合、チェックボックスをオンにして、[購入] を選択します。 新しい Azure アカウントのサブスクリプション ページが開きます。 試用版サブスクリプションには 200 ドルのクレジットが発行され、30 日間使用できます。 いつでもこのページからサブスクリプションを取り消すことができます。

    有料版サブスクリプションの場合、連絡先情報を入力して、[サインアップ] を選択します。 サブスクリプションが作成された後、[サービスの管理を開始する] を選択し、Azure 管理ポータルを開きます。

オプション 2:既存の Azure サブスクリプションと Office 365 サブスクリプションを関連付けます。 Azure サブスクリプションのためのサービス管理者または共同管理者としての Microsoft アカウントがある場合は、これを実行してください。 このプロセスによって、Microsoft アカウントが Office 365 テナントのグローバル管理者となります。

  1. Microsoft アカウントの資格情報 (someone@live.com など) で、Azure 管理ポータルにサインインします。

  2. ページの下部にあるドロワーで、[新規] > [App Services] > [Active Directory] > [ディレクトリ] > [カスタム作成] を選びます。

  3. [ディレクトリの追加] ウィンドウで、ディレクトリについて [既存のディレクトリの使用] を選択します。

  4. [サインアウトする準備ができました] を選択し、チェック マークをクリックします。 これにより、ポータルからサインアウトします。

  5. 関連付けたい Office 365 テナントのグローバル管理者の資格情報を使用して再度サインインします (someone@example.com または someone@example.onmicrosoft.com のような職場または学校アカウント)。

  6. Azure でディレクトリを使用するかどうかを確認するメッセージが表示されたら、[続行] > [今すぐサインアウト] を選びます。

  7. ブラウザーを閉じ、もう一度 Azure 管理ポータルを開きます。

  8. Microsoft アカウントの資格情報で再度サインインし、ナビゲーション ウィンドウ内の [Active Directory] を選択します。 Office 365 のディレクトリ一覧が [ディレクトリ] タブに表示されます。

Azure 管理ポータルでアプリを登録する

  1. Azure 管理ポータルにサインインします。 Azure サブスクリプションの管理者の資格情報を使用します。

  2. ナビゲーション ウィンドウ内で、[Active Directory] を選択します。

  3. アプリケーションを登録したいディレクトリを選択し、[アプリケーション] タブを開きます。

  4. ページの下部にあるドロワーで、[追加]、[組織で開発中のアプリケーションを追加] の順に選択します。

  5. アプリケーションのフレンドリ名を入力し、アプリケーションの種類を選択します:

    Web アプリケーションまたは Web API (ブラウザー ベースまたはサーバー アプリ)

    a. Web アプリケーションまたは Web API を選択します。

    b.サインオンの URL に関して、ユーザーがサインインし、アプリを使用する URL を入力します。

    c.アプリ ID の URL に関して、アプリの一意識別子を入力します。これは確認済みのカスタム ドメイン内にある必要があります。

    d.応答 URL に関して、OAuth 2.0 要求に応えてリダイレクトする URL を入力します。これは物理的なエンドポイントである必要はありませんが、有効な URI でなければなりません。

    e. アプリを外部の Azure テナントに利用可能なものとするため、[アプリケーションはマルチテナントです][はい] を選択します。

    ネイティブ クライアント アプリケーション (デバイスにインストールされたアプリ)

    a. ネイティブ クライアント アプリケーションを選択します。

    b.OAuth 2.0 要求に応えてリダイレクトする URI を入力します。これは物理的なエンドポイントである必要はありませんが、有効な URI でなければなりません。


Web アプリの場合、Azure はクライアント ID とアプリ シークレット (またはキー) の両方を生成します。ネイティブ クライアント アプリケーションに関して、Azure はクライアント ID を生成します。これらの値を保存します。

アプリの登録に関する詳細な説明は、Office 365 ドキュメントをご覧ください。

OneNote のアクセス許可のスコープを選択する (エンタープライズ アプリ)

アクセス許可のスコープは、OneNote コンテンツへのアクセスのレベルを表します。アプリに必要なアクセス許可を要求し、ユーザーはアプリにサインインするときにアクセス許可を付与または拒否します。ユーザーは、保有するアクセス許可のみを付与することができます。

  1. Azure 管理ポータルで、アプリの構成ページの [他のアプリケーションに対するアクセス許可] セクションで、[アプリケーションの追加] を選択します。

  2. OneNote アプリケーションを選択し、右下隅のチェック マークをクリックします。 OneNote が一覧にない場合、テナントに対して OneDrive for Business をプロビジョニングしたかどうかを確認してください。

  3. アプリの動作に必要な最低レベルのアクセス許可を選択し、変更を保存します。複数のスコープを要求することができます。


現在のユーザーが保有する個人用ノートブックのためのスコープ

OneDrive for Business の個人用ノートブックのみを使用する場合、次のスコープの中から選択します。

スコープ (エンタープライズ)Azure ポータルにおけるアクセス許可説明
Notes.Createユーザーのノートを作成する

サインイン ユーザー用の OneNote ノートをユーザーが作成できるようにします。

既存のページの表示または編集はできません。

Notes.ReadWrite.CreatedByApp指定されたアプリケーションを使用して作成したノートを表示および変更する

このアプリによって作成された OneNote ノートをユーザーが表示および変更できるようにします。

他のアプリにより作成されたノートや、パスワードで保護されたセクションにあるノートについては、表示や変更はできません。

Notes.Readユーザーのノートを表示する

サインイン ユーザー用の OneNote ノートをユーザーが表示できるようにします。

新しいページの作成、既存のページの変更、パスワードで保護されたセクションへのアクセスはできません。

Notes.ReadWriteユーザーのノートを表示および変更する

サインイン ユーザー用の OneNote ノートをユーザーが表示および変更できるようにします。

パスワードで保護されたセクションにアクセスすることはできません。


現在のユーザーがアクセスできるサイトおよびグループ ノートブックのためのスコープ

SharePoint サイトのノートブックまたは Office 365 グループのノートブックを使用している場合は、次のスコープの中から選びます。これらのアクセス許可は現在のユーザーの個人用ノートブックにも適用されますが、他のユーザーと共有している個人用ノートブックには適用されません。共有された個人用コンテンツへのアクセスは、現在サポートされていません。

スコープ (エンタープライズ)Azure ポータルにおけるアクセス許可説明
Notes.Read.Allユーザーのノートと、ユーザーによって共有されているノートを表示する

サインイン ユーザーがアクセスできる組織内の OneNote ノートをユーザーが表示できるようにします。

新しいページの作成、既存のページの変更、パスワードで保護されたセクションへのアクセスはできません。

Notes.ReadWrite.Allユーザーのノートと、ユーザーによって共有されているノートを表示および変更する

サインイン ユーザーがアクセスできる組織内の OneNote ノートをユーザーが表示および変更できるようにします。

パスワードで保護されたセクションにアクセスすることはできません。

OneDrive の個人用ノートブックにアクセスするためのアクセス許可については、「OneNote のアクセス許可を選択する (コンシューマー アプリ)」を参照してください。

ユーザーをサインインさせ、アクセス トークンを取得する (エンタープライズ アプリ)

アプリは承認サービスに接続してサインイン プロセスを開始します。ユーザーがまだサインインしていない、またはまだ同意していない場合、サービスはユーザーに対して認証情報の入力およびアプリが要求しているアクセス許可への同意を求めます。認証および承認が成功した場合、OneNote API に対する要求に含めるアクセス トークンを受け取ります。

重要! アクセス トークンおよび更新トークンは、ユーザーのパスワードの場合と同様に、安全な方法で扱ってください。

プラットフォームによっては、SDK を使用して認証フローを簡略化できる場合があります。

アクセス トークンの取得は 2 段階の手順で行われます:

  1. ユーザーをサインインさせ、認証コードを取得します。
  2. コードをアクセス トークンと交換します。


このプロセスは 認証コード付与フローを表します。 暗黙的フローを使用する場合、マニフェスト ファイルを編集する必要があります。 「ブラウザー ベースの Web アプリを登録する」の「OAuth 2.0 の暗黙的な付与フローを許可するようアプリケーションを構成する」を参照してください。


手順 1. ユーザーをサインインさせ、認証コードを取得します。 サインイン プロセスを開始するために、Web ブラウザーまたは Web ブラウザー コントロールで以下の URL 要求を読み込みます。

次の URL では、任意のアプリケーションに対して有効である共通のテナント エンドポイントを使用します。

https://login.microsoftonline.com/common/oauth2/authorize
  ?response_type=code
  &client_id={client-id}
  &redirect_uri={redirect-uri}
  &resource=https://onenote.com/
必須のクエリ文字列パラメーター説明
response_type使用している認証フローの種類 この場合は、code
client_idアプリケーション用に作成されたクライアント ID。
redirect_uriアプリケーション用のリダイレクト URL。
resourceアクセスが必要なリソース この例では、https://onenote.com/

次の例が示すように、認証および承認が成功すると、Web ブラウザーはリダイレクト URI へリダイレクトを行い、URL にコード パラメーターを付加します。 手順 2 で使用するために、コードの値をコピーします。 このコードは、数分間有効です。

https://your-redirect-uri/
  ?code=AAABAA...AA
  &session_state=d56e3523-614e-4fbe-bf89-3ba0f065954b

手順 2. 認証コードをアクセス トークンおよび更新トークンと交換します。 適切にエンコードされた URL 文字列をメッセージ本文に記載した次の HTTP 要求を送信します。

POST https://login.microsoftonline.com/common/oauth2/token
Content-Type: application/x-www-form-urlencoded

grant_type=authorization_code
&client_id={client-id}
&client_secret={client-secret}
&redirect_uri={redirect-uri}
&code={code}
&resource=https://onenote.com/
必要な本文パラメーター説明
grant_type要求の許可の種類。 この例では、authorization_code
client_idアプリケーション用に作成されたクライアント ID。
client_secretWeb アプリケーションおよび Web API のみアプリケーション用に作成されたクライアント シークレット。
code前の手順で URL パラメーターとして受け取ったコード。
redirect_uriアプリケーション用のリダイレクト URL。 これは、最初の要求における redirect_uri と一致する必要があります。
resourceアクセスが必要なリソース この例では、https://onenote.com/

成功した場合、次の例に示すように、応答にはaccess_token および refresh_token の入った JSON 文字列が含まれます。 アクセス トークンは、expires_in プロパティによって指定された秒数だけ有効です。

{
  "token_type":"Bearer",
  "expires_in":"3600",
  "scope":"Notes.ReadWrite",
  "expires_on":"1446588136",
  "not_before":"1446584236",
  "resource":"https://onenote.com/",
  "access_token":"eyJ0eX...2-w",
  "refresh_token":"AAABAAA...IAA",
  "id_token":"eyJ0eX...fQ."
}

要求において使用可能な追加パラメーターを含むコード付与フローの Azure AD 実装の詳細については、「認証コード付与フロー」を参照してください。

OneNote API に対する要求にアクセス トークンを含める

OneNote API に対するすべての要求は、Authorization ヘッダー内でベアラー トークンとしてアクセス トークンを送信する必要があります。 たとえば、次の要求は 5 つのノートブックを取得し、それらはアルファベット順に名前で並べ替えられます。

GET https://www.onenote.com/api/v1.0/me/notes/notebooks?top=5
Authorization: Bearer {access-token}

アクセス トークンは 1 時間のみ有効であるため、その期限が切れた場合は新しいトークンを取得する必要があります。トークンを使用する前に、その有効期限をチェックし、必要に応じて新しいアクセス トークンを取得する必要があります。ユーザーはサインインした状態を保持することができ、サインアウトする場合やアクセス許可を取り消す場合を除き、アクセス許可に再度同意する必要はありません。

アクセス トークンの期限が切れた後、新しいアクセス トークンを取得する (エンタープライズ アプリ)

更新トークンを使用するか、または認証手順を最初から再度行うことによって新しいアクセス トークンを要求することができます。

アクセス トークンの期限が切れた場合、API に対する要求は 401 Unauthorized 応答を返します。 アプリはこの応答を処理しなければならないため、要求を送信する前にトークンの有効期限を確認する必要があります。

適切にエンコードされた URL 文字列をメッセージ本文に記載した次の HTTP 要求を送信します。

次の例の URL では、任意のアプリケーションに対して有効である共通のテナント エンドポイントを使用します。

POST https://login.microsoftonline.com/common/oauth2/token
Content-Type: application/x-www-form-urlencoded

grant_type=refresh_token
&client_id={client-id}
&client_secret={client-secret}
&redirect_uri={redirect-uri}
&refresh_token={refresh-token}
&resource={resource-id}
必要な本文パラメーター説明
grant_type要求の許可の種類。 この例では、refresh_token
client_idアプリケーション用に作成されたクライアント ID。
client_secretWeb アプリケーションおよび Web API のみアプリケーション用に作成されたクライアント シークレット。
redirect_uriアプリケーション用のリダイレクト URL。
refresh_token以前に受信した更新トークン。
resourceアクセスが必要なリソース この例では、https://onenote.com/

成功した場合、次の例に示すように、POST 要求に対する応答には access_token および refresh_token の入った JSON 文字列が含まれます。

{
  "token_type":"Bearer",
  "expires_in":"3600",
  "scope":"Group.Read.All Notes.ReadWrite",
  "expires_on":"1447656020",
  "not_before":"1447652120",
  "resource":"https://onenote.com/",
  "access_token":"eyJ0eX...Jww",
  "refresh_token":"AAABAAA...IAA"
}

保存されたトークンを更新し、アプリが最も長い有効期限のトークンを保有するようにします。

OneNote の開発のための SDK

OneNote アプリは、OneNote API に対するすべての要求に必要なアクセス トークンを取得するのに OneDrive API SDK を使用することができます。 SDK は認証を簡単にします。 ID 情報を提供し、いくつかの呼び出しを統合するだけで、SDK はサインインから、トークンの取得、格納、更新への同意まですべてを処理します。 それから、OneNote API への REST 呼び出しを行うことができます。 iOS チュートリアル は、SDK を OneNote アプリで使う方法を説明します。

コンシューマー ノートブックの場合、すべてのバージョンの SDK は Microsoft アカウント認証をサポートします。エンタープライズ ノートブックの場合、一部のバージョンの SDK は Azure Active Directory もサポートします。 現在サポートされるプラットフォームの一覧については、OneDrive ドキュメント をご覧ください。

OneDrive API SDK は、Live SDK を置き換えます。 Live SDK は廃止されましたが、それを使用する既存の OneNote アプリケーションを引き続きサポートします。 新しい開発では、OneDrive API SDK を使用してください。

ある時点で、認証の処理と OneNote API へのネイティブ呼び出しのサポートの両方を行うライブラリが提供されるかもしれませんが、今は OneDrive API SDK をお使いください。

または、エンタープライズ アプリは、Active Directory Authentication Library (ADAL) を使用して、Office 365 と SharePoint ホスト型のノートブックにアクセスできます。 お使いのプラットフォームで利用可能な SDK がない場合や、認証プロセスをさらに制御する場合は、ADAL を直接使用することを検討してください。 ASP.NET MVC チュートリアル は、ADAL を OneNote アプリで使う方法を説明します。

重要! OneNote コンテンツとリソースを操作するには、常に OneNote API を使う必要があります。 OneDrive API を使用しないでください。

エラー

認証でエラーが発生した場合、Web ブラウザーはエラー ページへとリダイレクトされます。 エラー ページでは、エンドユーザーにわかりやすいメッセージが表示されますが、そのページの URL には問題を解決するのに役立つ追加パラメーターが含まれます。 この URL パラメーターはブックマークとして含まれています。たとえば、#error={error_code}&error_description={message} です。

ユーザーがアプリケーションに同意しない場合、フローはリダイレクト URL にリダイレクトされ、エラー パラメーターが含まれます。

エラーの処理について詳しくは、「OAuth 2.0 でのエラー処理」をご覧ください。

その他の技術情報

© 2018 Microsoft