什么是WorkOS的企業(yè)SSO服務(wù)?

什么是WorkOS的企業(yè)SSO服務(wù)接口？

WorkOS的企業(yè)SSO服務(wù)有哪些核心功能？

WorkOS的企業(yè)SSO服務(wù)的技術(shù)原理是什么？

WorkOS的企業(yè)SSO服務(wù)的核心優(yōu)勢是什么？

在哪些場景會用到WorkOS的企業(yè)SSO服務(wù)？

1.將 SSO 添加到您的應(yīng)用程序
讓我們將 SSO 身份驗證工作流程構(gòu)建到您的應(yīng)用程序中。
安裝 WorkOS SDK
WorkOS 提供多種流行編程語言的本機(jī) SDK。選擇下面的語言以查看使用您的應(yīng)用程序語言的說明。

設(shè)定密鑰
要調(diào)用 WorkOS，請?zhí)峁?API 密鑰，在某些情況下還需要提供客戶端 ID。將這些值存儲為托管機(jī)密，例如WORKOS_API_KEY和WORKOS_CLIENT_ID ，并將它們作為環(huán)境變量或根據(jù)您的首選項直接傳遞到應(yīng)用程序的配置中。

環(huán)境變量
WORKOS_API_KEY='sk_example_123456789'
WORKOS_CLIENT_ID='client_123456789'

添加端點以啟動 SSO
通過 WorkOS API 啟動 SSO 的端點負(fù)責(zé)將身份驗證工作流程的其余部分移交給 WorkOS。下面顯示了幾個配置選項。

您可以使用可選的state參數(shù)對任意信息進(jìn)行編碼，以幫助恢復(fù)重定向之間的應(yīng)用程序狀態(tài)。

添加端點以啟動 SSO
通過 WorkOS API 啟動 SSO 的端點負(fù)責(zé)將身份驗證工作流程的其余部分移交給 WorkOS。下面顯示了幾個配置選項。

您可以使用可選的state參數(shù)對任意信息進(jìn)行編碼，以幫助恢復(fù)重定向之間的應(yīng)用程序狀態(tài)。

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);
});

添加回調(diào)端點
接下來，我們添加重定向端點，該端點將在用戶通過其身份提供商進(jìn)行身份驗證后處理來自 WorkOS 的回調(diào)。此端點應(yīng)將 WorkOS 返回的授權(quán)代碼與經(jīng)過身份驗證的用戶的配置文件進(jìn)行交換。授權(quán)碼的有效期為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
轉(zhuǎn)到重定向儀表板中的頁面來配置允許的重定向 URI。這是您在上一節(jié)中使用的回調(diào)端點。

多租戶應(yīng)用程序通常會指定一個重定向 URI。您可以為單租戶應(yīng)用程序設(shè)置多個重定向 URI。您需要確保指定在 WorkOS 客戶端調(diào)用中使用哪個重定向 URI 來獲取授權(quán) URL。

身份提供商發(fā)起的 SSO
通常，您在 WorkOS 儀表板中配置的默認(rèn)重定向 URI 將用于所有身份提供商發(fā)起的 SSO 會話。這是因為 WorkOS 客戶端不用于啟動身份驗證流程。

但是，您的客戶可以指定一個單獨的重定向 URI，作為其 SAML 設(shè)置中的RelayState參數(shù)，用于所有 IdP 發(fā)起的會話。

3.端到端測試
如果您按照本指南操作，則可以使用暫存環(huán)境中可用的測試組織來啟動 SSO。這樣，您就可以端到端地測試您的集成了。

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

1.將 SSO 添加到您的應(yīng)用程序
讓我們將 SSO 身份驗證工作流程構(gòu)建到您的應(yīng)用程序中。
安裝 WorkOS SDK
WorkOS 提供多種流行編程語言的本機(jī) SDK。選擇下面的語言以查看使用您的應(yīng)用程序語言的說明。

設(shè)定密鑰
要調(diào)用 WorkOS，請?zhí)峁?API 密鑰，在某些情況下還需要提供客戶端 ID。將這些值存儲為托管機(jī)密，例如WORKOS_API_KEY和WORKOS_CLIENT_ID ，并將它們作為環(huán)境變量或根據(jù)您的首選項直接傳遞到應(yīng)用程序的配置中。

環(huán)境變量
WORKOS_API_KEY='sk_example_123456789'
WORKOS_CLIENT_ID='client_123456789'

添加端點以啟動 SSO
通過 WorkOS API 啟動 SSO 的端點負(fù)責(zé)將身份驗證工作流程的其余部分移交給 WorkOS。下面顯示了幾個配置選項。

您可以使用可選的state參數(shù)對任意信息進(jìn)行編碼，以幫助恢復(fù)重定向之間的應(yīng)用程序狀態(tài)。

添加端點以啟動 SSO
通過 WorkOS API 啟動 SSO 的端點負(fù)責(zé)將身份驗證工作流程的其余部分移交給 WorkOS。下面顯示了幾個配置選項。

您可以使用可選的state參數(shù)對任意信息進(jìn)行編碼，以幫助恢復(fù)重定向之間的應(yīng)用程序狀態(tài)。

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);
});

添加回調(diào)端點
接下來，我們添加重定向端點，該端點將在用戶通過其身份提供商進(jìn)行身份驗證后處理來自 WorkOS 的回調(diào)。此端點應(yīng)將 WorkOS 返回的授權(quán)代碼與經(jīng)過身份驗證的用戶的配置文件進(jìn)行交換。授權(quán)碼的有效期為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
轉(zhuǎn)到重定向儀表板中的頁面來配置允許的重定向 URI。這是您在上一節(jié)中使用的回調(diào)端點。

多租戶應(yīng)用程序通常會指定一個重定向 URI。您可以為單租戶應(yīng)用程序設(shè)置多個重定向 URI。您需要確保指定在 WorkOS 客戶端調(diào)用中使用哪個重定向 URI 來獲取授權(quán) URL。

身份提供商發(fā)起的 SSO
通常，您在 WorkOS 儀表板中配置的默認(rèn)重定向 URI 將用于所有身份提供商發(fā)起的 SSO 會話。這是因為 WorkOS 客戶端不用于啟動身份驗證流程。

但是，您的客戶可以指定一個單獨的重定向 URI，作為其 SAML 設(shè)置中的RelayState參數(shù)，用于所有 IdP 發(fā)起的會話。

3.端到端測試
如果您按照本指南操作，則可以使用暫存環(huán)境中可用的測試組織來啟動 SSO。這樣，您就可以端到端地測試您的集成了。

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