什么是WorkOS的企业SSO服务?

什么是WorkOS的企业SSO服务？

WorkOS的企业SSO服务有哪些核心功能？

WorkOS的企业SSO服务的技术原理是什么？

WorkOS的企业SSO服务的核心优势是什么？

在哪些场景会用到WorkOS的企业SSO服务？

1.将 SSO 添加到您的应用程序
让我们将 SSO 身份验证工作流程构建到您的应用程序中。
安装 WorkOS SDK
WorkOS 提供多种流行编程语言的本机 SDK。选择下面的语言以查看使用您的应用程序语言的说明。

设定密钥
要调用 WorkOS，请提供 API 密钥，在某些情况下还需要提供客户端 ID。将这些值存储为托管机密，例如WORKOS_API_KEY和WORKOS_CLIENT_ID ，并将它们作为环境变量或根据您的首选项直接传递到应用程序的配置中。

环境变量
WORKOS_API_KEY='sk_example_123456789'
WORKOS_CLIENT_ID='client_123456789'

添加端点以启动 SSO
通过 WorkOS API 启动 SSO 的端点负责将身份验证工作流程的其余部分移交给 WorkOS。下面显示了几个配置选项。

您可以使用可选的state参数对任意信息进行编码，以帮助恢复重定向之间的应用程序状态。

添加端点以启动 SSO
通过 WorkOS API 启动 SSO 的端点负责将身份验证工作流程的其余部分移交给 WorkOS。下面显示了几个配置选项。

您可以使用可选的state参数对任意信息进行编码，以帮助恢复重定向之间的应用程序状态。

import type { NextApiRequest, NextApiResponse } from 'next';
import { WorkOS } from '@workos-inc/node';

const workos = new WorkOS(process.env.WORKOS_API_KEY);
const clientId = process.env.WORKOS_CLIENT_ID;

export default (_req: NextApiRequest, res: NextApiResponse) => {
  // Use the Test Organization ID to get started. Replace it with
  // the user’s real organization ID when you finish the integration.
  const organization = 'org_test_idp';

  // The callback URI WorkOS should redirect to after the authentication
  const redirectUri = 'https://dashboard.my-app.com';

  const authorizationUrl = workos.sso.getAuthorizationUrl({
    organization,
    redirectUri,
    clientId,
  });

  res.redirect(authorizationUrl);
};
const express = require('express');
const { WorkOS } = require('@workos-inc/node');

const app = express();

const workos = new WorkOS(process.env.WORKOS_API_KEY);
const clientId = process.env.WORKOS_CLIENT_ID;

app.get('/auth', (_req, res) => {
  // Use the Test Organization ID to get started. Replace it with
  // the user’s real organization ID when you finish the integration.
  const organization = 'org_test_idp';

  // The callback URI WorkOS should redirect to after the authentication
  const redirectUri = 'https://dashboard.my-app.com';

  const authorizationUrl = workos.sso.getAuthorizationUrl({
    organization,
    redirectUri,
    clientId,
  });

  res.redirect(authorizationUrl);
});

添加回调端点
接下来，我们添加重定向端点，该端点将在用户通过其身份提供商进行身份验证后处理来自 WorkOS 的回调。此端点应将 WorkOS 返回的授权代码与经过身份验证的用户的配置文件进行交换。授权码的有效期为10分钟。

import type { NextApiRequest, NextApiResponse } from 'next';
import { WorkOS } from '@workos-inc/node';

const workos = new WorkOS(process.env.WORKOS_API_KEY);
const clientId = process.env.WORKOS_CLIENT_ID;

export default async (req: NextApiRequest, res: NextApiResponse) => {
  const { code } = req.query;

  const { profile } = await workos.sso.getProfileAndToken({
    code,
    clientId,
  });

  // Use the Test Organization ID to get started. Replace it with
  // the user’s real organization ID when you finish the integration.
  const organization = 'org_test_idp';

  // Validate that this profile belongs to the organization used for authentication
  if (profile.organizationId !== organization) {
    return res.status(401).send({
      message: 'Unauthorized',
    });
  }

  // Use the information in `profile` for further business logic.

  res.redirect('/');
};

2.配置重定向 URI
转到重定向仪表板中的页面来配置允许的重定向 URI。这是您在上一节中使用的回调端点。

多租户应用程序通常会指定一个重定向 URI。您可以为单租户应用程序设置多个重定向 URI。您需要确保指定在 WorkOS 客户端调用中使用哪个重定向 URI 来获取授权 URL。

身份提供商发起的 SSO
通常，您在 WorkOS 仪表板中配置的默认重定向 URI 将用于所有身份提供商发起的 SSO 会话。这是因为 WorkOS 客户端不用于启动身份验证流程。

但是，您的客户可以指定一个单独的重定向 URI，作为其 SAML 设置中的RelayState参数，用于所有 IdP 发起的会话。

3.端到端测试
如果您按照本指南操作，则可以使用暂存环境中可用的测试组织来启动 SSO。这样，您就可以端到端地测试您的集成了。

详情查看链接：https://workos.com/docs/sso/1-add-sso-to-your-app/set-secrets