販売者ダッシュボードでクライアント ID とクライアント シークレットを作成または更新するCreate or update client IDs and secrets in the Seller Dashboard

販売者ダッシュボードで、クライアント ID とクライアント シークレットを作成または削除して、期限切れのクライアント シークレットを更新または置換し、それらをアドインと関連付けて SharePoint アドインの OAuth を有効化します。Create or delete client IDs and secrets, update or replace expiring client secrets, and associate them with your add-ins in the Seller Dashboard to enable OAuth in your SharePoint Add-ins.

SharePoint アドインの期限切れのクライアント シークレットを更新するには: To update expiring client secrets in SharePoint Add-ins:

  1. 販売者ダッシュボードで新しいクライアント シークレットを生成および追加して、その特定のアドイン クライアント ID に関連付けます。Generate and add a new client secret in the Seller Dashboard to associate with that particular add-in client ID. 具体的な手順については、この記事で後述する「クライアント ID に関連付けられたクライアント シークレットを更新する」の「追加のクライアント シークレットを生成するには」を参照してください。For specific steps, see To generate additional client secrets in Update the client secret associated with your client ID later in this article.

  2. 新しいクライアント シークレットを使用するようにリモート Web アプリケーションを更新します。Update your remote web application to use the new client secret. Microsoft Office Developer Tools for Visual Studio を使用して更新する方法については、「SharePoint アドインで期限が切れたクライアント シークレットを置換する方法」の「Visual Studio でリモート Web アプリケーションを更新し、新しいシークレットを使用する」を参照してください。For information about how to do this using Microsoft Office Developer Tools for Visual Studio, see Update the remote web application in Visual Studio to use the new secret in Replace an expiring client secret in a SharePoint Add-in.

  3. リモート Web アプリケーションを再発行します。Republish your remote web application.

重要

Microsoft Office Developer Tools for Visual Studio は、期限切れのクライアント シークレットの更新に使用できる、セカンダリ クライアント シークレットの設定をサポートしています。Important: Microsoft Office Developer Tools for Visual Studio supports setting a secondary client secret that you can use to update your expiring client secret.

アドインを認証および承認するための OAuth の使用Using OAuth to authenticate and authorize add-ins

OAuth (Open Authorization) は承認のためのオープンなプロトコルです。OAuth では、デスクトップや Web アプリケーションから単純で標準的な方法を使って安全に承認を行うことができます。ユーザーは OAuth を使うことにより、自分のユーザー名やパスワードを共有することなく、アプリが自分の代理として動作することを許可できます。たとえばユーザーは、あるサイトに保存されているプライベートなリソースやデータ (連絡先リスト、ドキュメント、写真、動画など) を、自身の資格情報 (一般的には、ユーザー名とパスワード) を提供することなく、別のサイトと共有することができます。Open Authorization (OAuth) is an open protocol for authorization. OAuth enables secure authorization from desktop and web applications in a simple and standard way. It lets users approve an application to act on their behalf without sharing their user name and password. For example, users can share their private resources or data (contact list, documents, photos, videos, and so on) that are stored on one site with another site, without having to provide their credentials (typically user name and password).

OAuth を使用すれば、ユーザーはサービス プロバイダー (たとえば、SharePoint) を承認し、特定のサービス プロバイダー (たとえば、SharePoint) によってホストされているデータに、資格情報 (たとえば、ユーザー名とパスワード) ではなくトークンを提供することができます。With OAuth, users can authorize a service provider (for example, SharePoint) to provide tokens instead of credentials (for example, user name and password) to their data that is hosted by a given service provider (for example, SharePoint). 各トークンは、特定のサイト (たとえば、SharePoint ドキュメント リポジトリ)、特定のリソース (たとえば、フォルダーのドキュメント)、定義期間に対するアクセスを許可します。Each token grants access to a specific site (for example, a SharePoint document repository), for specific resources (for example, documents from a folder), and for a defined duration. ユーザーはその後、ユーザー名とパスワードや、SharePoint にあるすべてのデータを共有することなく、他のサービス プロバイダー (たとえば、SharePoint) に保存されている情報へのサードパーティ サイトのアクセスを許可します。Users can then grant a third-party site access to information that is stored with another service provider (for example, SharePoint), without sharing their user name and password and without sharing all the data that they have on SharePoint.

アドインでこの種類の承認が必要な場合は、OAuth クライアント ID およびクライアント シークレットをアドインと関連付ける必要があります。OAuth クライアント ID およびクライアント シークレットは Microsoft の販売者ダッシュボードで生成することができ、それがアドインのコードに追加されます。If your add-in requires this type of authorization, you have to associate OAuth client ID and client secrets with your add-in. You can generate OAuth client ID and client secrets in the Microsoft Seller Dashboard, and then add them to the code of your add-in.

ユーザーが、クライアント ID とクライアント シークレットが関連付けられたアドインをインストールすると、同意を求めるダイアログ ボックスが表示されます。ユーザーが同意すると、アドインはユーザーに代わってアドインで必要なデータにアクセスできます。ユーザーは、自分が持っている権限だけを付与できます。付与は、ユーザーが持っている権限がアドインに委任されたことを表します。When a user installs an add-in that has an associated client ID and client secret, a consent dialog box appears. If the user gives consent, the add-in can act on behalf of the user to access the data that the add-in requires. Users can only grant the permissions that they have. Grants represent the permissions that a user has delegated to an add-in.

たとえば、アドインが、Office 365 SharePoint サイト上の IFRAME として開く旅行予定表アドインである場合を考えてみます。For example, your add-in could be a trip calendar add-in that opens as an IFRAME on an Office 365 SharePoint site. OAuth を使用すると、アドインは旅行予定表の使用者であるユーザーを特定できます。または、旅行予定表アドインがリソースや予定表情報など、Office 365 のその他の要素にアクセスする必要がある場合、サインインしたユーザーの代わりにそれらの要素にアクセスできます。OAuth would allow the add-in to identify the user to whom the trip calendar belongs, or if the trip calendar add-in needed to access other aspects of Office 365, such as resources or calendar information, it could access those on behalf of the signed-in user.

注意

OAuth、クライアント ID およびクライアント シークレットの詳細については、「SharePoint アドインの認証と承認」、「SharePoint アドインのコンテキスト トークン OAuth フロー」、および「SharePoint アドイン 2013 を登録する」を参照してください。Note: For more information about OAuth, client ID and client secrets, see Authorization and authentication of SharePoint Add-ins, Context Token OAuth flow for SharePoint Add-ins, and Register SharePoint Add-ins 2013.

クライアント ID とクライアント シークレットを追加するAdd a client ID and client secret

アドインに関連付けることができるクライアント ID は 1 つだけですが、複数のクライアント シークレットを 1 つのクライアント ID に関連付けることができます。セキュリティおよび管理上の理由により、1 つのクライアント ID に関連付けるクライアント シークレットの数を制限することをお勧めします。You can associate only one client ID with your add-in, but you can associate multiple client secrets with a client ID. For security and administrative purposes, we recommend limiting the number of client secrets associated with a client ID.

重要

OAuth を使用する SharePoint アドインを提出して、そのアドインを中国に配布するには: Important: To submit a SharePoint Add-in that uses OAuth, and distribute it to China, you must use a separate client ID and client secret for China.

  • 中国向けの個別クライアント ID とクライアント シークレットを使用する必要があります。Use a separate client ID and client secret for China.
  • 中国向け専用の、別個のアドイン パッケージを追加します。Add a separate add-in package specifically for China.
  • 中国を除くすべての国のアクセスをブロックします。Block access for all countries except China.
  • 中国向けに、別個のアドイン登録リストを作成します。Create a separate add-in listing for China.

アプリまたはアドインの提出とアクセスのブロック方法の詳細については、「販売者ダッシュボードを使用して Office ストアにソリューションを提出する」を参照してください。For more information about submitting apps or add-ins and blocking access, see Use the Seller Dashboard to submit solutions to the Office Store. 中国向けのアドインを配布する方法の詳細については、「中国で 21Vianet が運営する Office 365 用アプリを提出する」を参照してください。For more information about distributing add-ins for China, see Submit apps for Office 365 operated by 21Vianet in China.

アドインへの受信データは、1 つの署名クライアント シークレットのみを使用して署名されます。Inbound data to your add-in is signed by using only one signing client secret. 販売者ダッシュボードでは、このクライアント シークレットの隣には緑のチェック マークが付いています。In the Seller Dashboard, this is the client secret with a green check mark next to it. アドインが使用する署名クライアント シークレットを削除すると、次の有効なクライアント シークレットが代わりに使用されます。If you delete the signing client secret that your add-in uses, the next valid client secret is used instead.

アドインは有効なクライアント シークレットをパスワードとして使用し、Microsoft と通信することができます。クライアント シークレットの期限が切れると、パスワードとして使用できなくなります。クライアント ID に関連付けられているクライアント シークレットが 1 つしかない場合は、そのクライアント シークレットを削除すると、アドインが必要なデータにアクセスできなくなります。Your add-in can use any valid client secrets as passwords to communicate with Microsoft. When a client secret expires, it can no longer be used as a password. If there is only one client secret associated with your client ID, deleting that secret can prevent your add-in from accessing the data it needs.

アドインがサービスであり、OAuth クライアント ID とクライアント シークレットを必要とする場合は、次の手順に従ってください。If your add-in is a service and it will need OAuth client IDs and client secrets, follow these steps.

クライアント ID を追加するにはTo add a client ID

  1. Microsoft アカウントを使用して、販売者ダッシュボードにサインインします。Sign in to the Seller Dashboard with your Microsoft account.

  2. [クライアント ID] タブで、[新しい Oauth クライアント ID の追加] を選択します。On the Client ids tab, choose Add a new oauth client id.

  3. [詳細の入力] ページで、次の情報を提供します。On the Provide details page, provide the following information.

    アイテムItem 提供する情報Information to provide
    クライアント ID のフレンドリ名Friendly client ID Name このクライアント ID を使用するアドインの識別に役立つ名前 (たとえば、"calendar app") を選択します。Choose a name to help you recognize which add-in will use this client ID; for example, "calendar app".
    アプリ ドメインApp domain アドインを実行するドメイン指定します。Provide the domain on which your add-in will run. 例: app.contoso.comFor example: app.contoso.com.
    これは所有する有効なドメイン名である必要があります。http:// または https:// を含んではならず、This must be a valid domain name that you own; it must not include http:// or https://; and it must not be an international domain name (IDN).
    国際ドメイン名 (IDN) であってはなりません。and it must not be an international domain name (IDN).
    アプリのリダイレクト URLApp redirect URL 同意ダイアログ ボックスでユーザーがアドインのアクセス要件に同意した後にユーザーを転送するリダイレクト URL を指定します。Provide the redirect URL to send users to after they agree to your add-in's access requirements in the consent dialog box.
    この URL は https:// で開始する必要があります。This URL must start with https://.
    クライアント シークレットの有効期間Client secret valid for クライアント シークレットの有効期間を選択します。長い期間の場合よりもビジネス プロセス内での追跡がより容易になるため、推奨される期間は 1 年間です。ただし、さらに長い期間を選択した場合でも、セキュリティに影響を及ぼすことはありません。クライアント シークレットの有効期限が切れると、アドインを更新する必要があります。Choose how long your client secret will be valid. The recommended time period is one year, because this might be easier to track within your business processes than longer periods. However, there is no security impact to choosing a longer period of time. When the client secret is expiring, you will need to update your add-in.
    クライアント ID とシークレットの可用性Client ID and secret availability [このクライアント ID は世界中で利用可能なアドインに使用される] か、Choose This Client ID will be used for an add-in that is available worldwide, or This Client ID will be used for an add-in that is available in China only.
    [このクライアント ID は中国のみで利用可能なアドインに使用される] のどちらかを選択します。Choose This Client ID will be used for an add-in that is available worldwide, or This Client ID will be used for an add-in that is available in China only.
  4. [クライアント ID を生成する] を選択します。Choose Generate client ID.

  5. [クライアント シークレットを獲得する] ページで、クライアント ID とクライアント シークレットを安全な場所にコピーし、後で参照できるようにします。On the obtain client secret page, copy your client ID and client secret to a secure location so that you can refer to it later.

    重要

    クライアント シークレットはクライアント ID と関連付けられますが、販売者ダッシュボードに再び表示されることはありません。Important: The client secret is associated with your client ID, but it will not be shown in the Seller Dashboard again. クライアント シークレットの有効期間と有効期限日を認識できるように、開始日と終了日を記録しておく必要があります。You should also record the start and end dates, so that you will be aware of the client secret period of validity and its expiration date. クライアント シークレットの期限切れが間近になったときには、新しいクライアント シークレットを生成して、アドインを更新する必要があります。If your client secret is close to expiring, you will need to generate a new client secret and update your add-in. 詳細については、このトピックの「クライアント ID に関連付けられたクライアント シークレットを更新する」を参照してください。For more information, see Update the client secret associated with your client ID in this topic.

  6. [完了] を選択します。Select DONE.

  7. クライアント シークレットを安全な場所にコピーしなかった場合は、[クライアント シークレットをコピーしましたか?] ダイアログ ボックスで [キャンセル] を選択します。If you didn't copy your client secret to a secure location, choose Cancel in the Have you copied your client secret? dialog box. それ以外の場合は、[はい] を選択します。Otherwise, select YES.

クライアント ID とクライアント シークレットをアドインに関連付けるにはTo associate your client ID and secret with your add-in

クライアント ID とクライアント シークレットを作成した後、アドインのコードに追加し、次に、クライアント ID を販売者ダッシュボードのアドインに関連付けることができます。After you create your client ID and client secret, you can add them to the code of your add-in and then associate your client ID with your add-in to the Seller Dashboard.

注意

クライアント ID とクライアント シークレットは、アドイン開発プロセスの任意の時点でコードに追加できます (開発中、テスト前、または販売者ダッシュボードにアドインを追加する前)。Note: You can add the client ID and client secret to your code at any point in your add-in development process: during development, before testing, or before adding your add-in to the Seller Dashboard. ただし、アドインを完全にテストするために、テスト前に追加することをお勧めします。However, to fully test your add-in, we recommend that you add them before you test. クライアント ID とシークレットは、アドインの開発プロセスを通じて同じものを使用できます。You can use the same client ID and secret throughout your add-in development process. クライアント ID とクライアント シークレットをコードのどこに配置するべきかよくわからない場合は、開発しているアドインの種類ごとに提供されているドキュメントを参照してください。If you are unsure where to place the client ID and client secret in your code, refer to the documentation provided for the add-in type you are developing.

販売者ダッシュボードでアドインにクライアント ID とクライアント シークレットを関連付けるにはTo associate the client ID and client secret with your add-in in the Seller Dashboard

  1. アドインを追加または編集するときは、[概要] ページで [アドインはサービスであり、サーバー間の認証を必要とします] チェック ボックスをオンにします。When you're adding or editing your add-in, on the Overview page, select the My add-in is a service and requires server to server authorization check box.

    重要

    OAuth を使用する SharePoint アドインを提出して、中国に配布しようとしている場合は、次に示すように、中国向けの別個のクライアント ID とクライアント シークレットを使用する必要があります。Important: If you are submitting a SharePoint Add-in that uses OAuth, and you want to distribute it to China, you must use a separate client ID and client secret for China:

  2. アドインで使用する OAuth クライアント ID のフレンドリ名を選択します。Select the friendly name of the OAuth client ID that you want your add-in to use.

    詳細については、「販売者ダッシュボードを使用して Office ストアにソリューションを提出する」を参照してください。For more information, see Use the Seller Dashboard to submit solutions to the Office Store.

クライアント ID に関連付けられたクライアント シークレットを更新するUpdate the client secret associated with your client ID

次の場合にクライアント シークレットを更新します。Update your client secret in the following situations:

  • クライアント シークレットの有効期限日が近づいているYour client secret is expiring

    現在のクライアント シークレットが有効な間に、新しいクライアント シークレットを販売者ダッシュボードに追加することをお勧めします。新しいクライアント シークレットを使用してアドインを更新し、次に、有効期限が近づいているクライアント シークレットを販売者ダッシュボードから削除します。We recommend that you add a new client secret in the Seller Dashboard while your current client secret is still valid. Update your add-in with the new client secret, and then delete the client secret that is close to expiring from the Seller Dashboard.

    注意

    SharePoint アドインの期限切れクライアント シークレットを更新するには、次の手順を実行します。Note: To update expiring client secrets in SharePoint Add-ins, follow these steps. Microsoft Visual Studio Tools for the Microsoft Office System は、セカンダリ クライアント シークレットの設定をサポートしています。これを使用することで、期限切れのクライアント シークレットを更新できます。Note that Microsoft Office Developer Tools for Visual Studio supports setting a secondary client secret that you can use to update your expiring client secret.

  • クライアント シークレットのセキュリティが損なわれているThe security of your client secret is compromised

    セキュリティが損なわれている状況に迅速に対応するには、最初に、セキュリティが損なわれたクライアント シークレットを販売者ダッシュボードから削除して、新しいクライアント シークレットを追加し、次に、新しいクライアント シークレットを使用してアドインを更新します。To respond to a security compromise quickly, you can delete the compromised client secret from the Seller Dashboard first, add a new client secret, and then update your add-in with the new client secret.

重要

セキュリティが損なわれたクライアント シークレットを削除すると、新しいクライアント シークレットを追加するまでアドインが一時的に利用できなくなる場合があります。紛失または盗まれたクライアント シークレットがビジネスに及ぼす影響の重大度を考えれば、この状況は許容されるでしょう。After the compromised client secret is deleted and before the new client secret is added, your add-in might temporarily be unavailable. This might be acceptable depending on the severity of the business impact of a lost or stolen client secret.

追加のクライアント シークレットを生成するにはTo generate additional client secrets

  1. Microsoft アカウントを使用して、販売者ダッシュボードにサインインします。Sign in to the Seller Dashboard with your Microsoft account.

  2. [クライアント ID] タブで、追加のクライアント シークレットを関連付けるクライアント ID を選択します。On the Client ids tab, choose the client ID with which you want to associate additional client secrets.

  3. クライアント ID の要約ページで、[新しいクライアント ID を追加する] を選択します。On your client ID summary page, choose ADD NEW CLIENT SECRET.

  4. [クライアント シークレットを生成する] を選択します。Choose GENERATE CLIENT SECRET.

  5. クライアント シークレットを安全な場所にコピーし、後で参照できるようにします。Copy your client secret to a secure location so that you can refer to it later.

    重要

    クライアント シークレットはクライアント ID と関連付けられますが、販売者ダッシュボードに再び表示されることはありません。Important: The client secret is associated with your client ID, but it will not be shown in the Seller Dashboard again. クライアント シークレットの有効期間と有効期限日を認識できるように、開始日と終了日を記録してください。Record the start and end dates so that you will be aware of the client secret period of validity and its expiration date.

  6. [完了] を選択します。Select DONE.

  7. クライアント シークレットを安全な場所にコピーしなかった場合は、[クライアント シークレットをコピーしましたか?] ダイアログ ボックスで [キャンセル] を選択します。If you didn't copy your client secret to a secure location, choose Cancel in the Have you copied your client secret? dialog box. それ以外の場合は、[はい] を選択します。Otherwise, select YES.

    注意

    新しいクライアント シークレットは 15 分以内にアクティブになります。The new client secret will be active within 15 minutes.

クライアント シークレットを削除するにはTo delete a client secret

  1. Microsoft アカウントを使用して、販売者ダッシュボードにサインインします。Sign in to the Seller Dashboard with your Microsoft account.

  2. [クライアント ID] タブで、削除するクライアント シークレットを持つクライアント ID を選びます。On the Client ids tab, choose the client ID that has the client secret you want to delete.

  3. クライアント ID の要約ページの [クライアント シークレット] で、削除するクライアント シークレットの隣にある [X] を選択します。On your client ID summary page, under Client secrets, choose the X next to the client secret you want to delete.

    重要

    有効な追加のクライアント シークレットを作成してアドインに関連付けて、それらの追加のシークレットを使用するようにアドインを構成しない限り、クライアント シークレットを削除すると、アドインが必要なデータにアクセスできなくなることがあります。Deleting a client secret can prevent your add-in from accessing the data it needs, unless you created additional secrets that are valid and that are associated with your add-in, and you configured it to use these additional client secrets. クライアント ID に関連付けられているクライアント シークレットが 1 つしかない場合は、そのクライアント シークレットを削除する前に、追加のクライアント シークレットを生成します。If you have only one client secret associated with the client ID, you might want to generate an additional client secret before you delete it.

  4. このクライアント シークレットを削除する準備が整っていない場合は、[このクライアント シークレットを削除しますか?] ダイアログ ボックスで、[いいえ] を選択します。In the Are you sure you want to delete this client secret? dialog box, choose NO, if you are not ready to delete this client secret. このクライアント シークレットを削除する準備が整っている場合は、[はい] を選択します。If you are ready to delete the client secret, choose YES.

クライアント ID を削除するDelete a client ID

特定の状況でクライアント ID を削除できます。次のような場合です。You might want to delete a client ID in certain situations, for example:

  • アドインの提供を停止する場合You no longer want to offer your add-in.

  • 前のバージョンのアドインの提供を停止し、新しいバージョンを提供する場合。この場合、前のバージョンのアドインと関連付けられているクライアント ID を削除できます。You want to offer a new version of your add-in and no longer want to offer the previous version. In this situation, you might want to delete the client ID you associated with the previous version of your add-in.

警告

アドインに関連付けられたクライアント ID を削除すると、関連するすべてのクライアント シークレットが削除され、アドインは必要なデータにアクセスできなくなります。アドインに関連付けられたクライアント ID を削除した後、アドインを使用しているすべてのお客様がダウンタイムを経験します。Deleting a client ID that is associated with your add-in deletes all associated client secrets and prevents it from accessing the data it needs. Any customer using your add-in will experience downtime after you delete a client ID that is associated with it.

クライアント ID を削除するにはTo delete a client ID

  1. Microsoft アカウントを使用して、販売者ダッシュボードにサインインします。Sign in to the Seller Dashboard with your Microsoft account.

  2. [クライアント ID] タブで、削除するクライアント ID を選択します。On Client ids tab, choose the client ID that you want to delete.

  3. クライアント ID の要約ページの [OAuth クライアント ID] で、[削除] を選択します。On your client ID summary page, under OAUTH CLIENT ID, choose DELETE.

    警告

    アドインに関連付けられたクライアント ID を削除すると、関連するすべてのクライアント シークレットが削除され、アドインは必要なデータにアクセスできなくなります。アドインに関連付けられたクライアント ID を削除した後、アドインを使用しているすべてのお客様がダウンタイムを経験します。Deleting a client ID that is associated with your add-in deletes all associated client secrets and prevents it from accessing the data it needs. Any customer using your add-in will experience downtime after you delete a client ID that is associated with it.

  4. このクライアント ID を削除する準備が整っていない場合は、[<クライアント ID 名>を削除しますか?] If you are not ready to delete this client ID, in the Are you sure you want to delete {your client ID's name}? ダイアログ ボックスで、[いいえ] を選択します。dialog box, choose NO. このクライアント ID を削除する準備が整っている場合は、[はい] を選択します。If you are ready to delete this client ID, choose YES.

クライアント ID を削除するものの、アドインの提供を継続するにはTo delete a client ID, but continue offering your add-in

  1. 別のクライアント ID と少なくとも 1 つの有効なクライアント シークレットを追加します。Add another client ID and at least one valid client secret.

    詳細については、「 クライアント ID とクライアント シークレットを追加する」を参照してください。For more information, see Add a client ID and client secret.

  2. コードからクライアント ID を削除します。Delete the client ID from your code.

    注意

    アドインに関連付けられたクライアント ID の削除後に、アドインを使用している顧客にダウンタイムが発生します。Customers using your add-in will experience downtime after you delete a client ID that is associated with your add-in.

  3. 販売者ダッシュボードからクライアント ID を削除します。詳細については、前の手順を参照してください。Delete the client ID from the Seller Dashboard, as described in the previous procedure.

  4. 新しいクライアント ID とクライアント シークレットをコードに追加します。Add the new client ID and client secret to your code.

  5. 販売者ダッシュボードで、更新したアドインを提出して承認を求めますSubmit your updated add-in for approval in the Seller Dashboard.

    注意

    コードの更新中と販売者ダッシュボードの承認プロセスの進行中に、アドインを使用している顧客にダウンタイムが発生します。Note: Customers using your add-in will experience downtime during the update to your code and the Seller Dashboard approval process.

関連項目See also