您现在访问的是微软AZURE全球版技术文档网站,若需要访问由世纪互联运营的MICROSOFT AZURE中国区技术文档网站,请访问 https://docs.azure.cn.

创建和发布应用程序的单一登录文档Create and publish single sign-on documentation for your application

网站上的文档Documentation on your site

易用性是企业软件决策中的一个重要因素。Ease of adoption is a significant factor in enterprise software decisions. 明确的易于理解的文档在采用旅程中支持客户并降低支持成本。Clear easy-to-follow documentation supports your customers in their adoption journey and reduces support costs. Microsoft 使用成千上万个软件供应商。Working with thousands of software vendors, Microsoft has seen what works.

建议你至少在网站上包含以下各项。We recommend that your documentation on your site at a minimum include the following items.

  • SSO 功能简介Introduction to your SSO functionality

    • 支持的协议Protocols supported

    • 版本和 SKUVersion and SKU

    • 支持的标识提供者列表和文档链接Supported Identity Providers list with documentation links

  • 应用程序的授权信息Licensing information for your application

  • 用于配置 SSO 的基于角色的访问控制Role-based access control for configuring SSO

  • SSO 配置步骤SSO Configuration Steps

    • 具有提供程序中的预期值的 SAML 的 UI 配置元素UI configuration elements for SAML with expected values from the provider

    • 要传递给标识提供程序的服务提供程序信息Service provider information to be passed to identity providers

  • If OIDC/OAuthIf OIDC/OAuth

    • 同意业务理由所需的权限列表List of permissions required for consent with business justifications
  • 试验用户的测试步骤Testing steps for pilot users

  • 疑难解答信息,包括错误代码和消息Troubleshooting information, including error codes and messages

  • 客户的支持机制Support mechanisms for customers

Microsoft 网站上的文档Documentation on the Microsoft Site

当你使用 Azure Active Directory 应用程序库列出你的应用程序(该应用程序也会在 Azure Marketplace 中发布应用程序)时,Microsoft 将为我们的共同客户生成文档,其中介绍了分步过程。When you list your application with the Azure Active Directory Application Gallery, which also publishes your application in the Azure Marketplace, Microsoft will generate documentation for our mutual customers explaining the step-by-step process. 可在此处查看示例。You can see an example here. 此文档是基于你提交到库的创建的,如果你使用 GitHub 帐户对应用程序进行更改,则可以轻松地对其进行更新。This documentation is created based on your submission to the gallery, and you can easily update it if you make changes to your application using your GitHub account.

后续步骤Next Steps

在 Azure AD 应用程序库中列出你的应用程序List your application in the Azure AD Application Gallery