跳转到主要内容
API Explorer|API Explorer
基础设施相关接口/联邦与 SSO
POSTFederation起始版本 1.0同步需要认证

创建单点登录配置

SSO配置增删改查创建新全局SSO配置。

调试可用性

在线调试

使用当前认证信息和示例参数提交 Mock 请求。

请求参数

请求体字段

  • tenantUuidString必填

    租户UUID。

    示例： deprecated-tenant-uuid

  • displayNameString必填

    显示名称。用于界面展示。

    示例： Corporate SSO

  • providerTypeString必填

    身份提供方类型。

    示例： OIDC

  • protocolString必填

    认证协议。

    示例： oidc

  • oidcConfigObject必填

    OIDC配置信息。

    • clientIdString

      客户端ID。

      示例： my-client-id

    • clientSecretString

      客户端密钥。

      示例： s3cr3t

    • wellKnownUrlString

      OIDC发现端点地址。

      示例： https://idp.example.com/.well-known/openid-configuration

    • redirectUriString

      重定向地址。

      示例： https://zcf.example.com/sso/callback

    • scopeString

      作用范围。

      示例： openid profile email

    • configNameString

      配置名称。

      示例： Corporate OIDC

响应状态

200 OK

该 API 成功时返回以下响应结构。

  • uuidString

    资源的UUID，唯一标识该资源。

    示例： sso-cfg-001

  • tenantUuidString

    租户UUID。

    示例： deprecated-tenant-uuid

  • issuerString

    签发方。

    示例： https://idp.example.com

  • displayNameString

    显示名称。用于界面展示。

    示例： Corporate SSO

  • providerTypeString

    身份提供方类型。

    示例： OIDC

  • protocolString

    认证协议。

    示例： oidc

  • oidcConfigObject

    OIDC配置信息。

    • clientIdString

      客户端ID。

      示例： my-client-id

    • clientSecretString

      客户端密钥。

      示例： s3cr3t

    • wellKnownUrlString

      OIDC发现端点地址。

      示例： https://idp.example.com/.well-known/openid-configuration

    • redirectUriString

      重定向地址。

      示例： https://zcf.example.com/sso/callback

    • scopeString

      作用范围。

      示例： openid profile email

    • configNameString

      配置名称。

      示例： Corporate OIDC

  • samlConfigObject

    SAML配置信息。

    • idpEntityIdString

      身份提供方实体ID。

      示例： https://idp.example.com/saml/metadata

    • idpSsoUrlString

      身份提供方单点登录地址。

      示例： https://idp.example.com/saml/sso

    • idpSloUrlString

      身份提供方单点登出地址。

      示例： https://idp.example.com/saml/slo

    • idpCertificateString

      身份提供方证书。

      示例： -----BEGIN CERTIFICATE----- ...

    • idpMetadataUrlString

      身份提供方元数据地址。

      示例： https://idp.example.com/saml/metadata.xml

    • spEntityIdString

      服务提供方实体ID。

      示例： https://zcf.example.com/saml/sp

    • nameIdFormatString

      用户标识格式。

      示例： urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress

    • signRequestsBoolean

      是否对请求签名。

      示例： true

    • forceAuthnBoolean

      是否强制重新认证。

      示例： false

    • spCertificatePemString

      服务提供方证书内容。

      示例： -----BEGIN CERTIFICATE----- ...

  • ldapConfigObject

    LDAP配置信息。

    • serverAddressString

      服务地址。

      示例： ldap.example.com

    • portInteger

      端口号。

      示例： 389

    • baseDnString

      LDAP搜索基础路径。

      示例： dc=example,dc=com

    • bindDnString

      连接LDAP服务器使用的绑定路径。

      示例： cn=admin,dc=example,dc=com

    • bindPasswordString

      LDAP绑定密码。

      示例： bindP@ssw0rd

    • userSearchBaseString

      用户搜索基础路径。

      示例： ou=users,dc=example,dc=com

    • userSearchFilterString

      用户搜索过滤条件。

      示例： (uid=%s)

    • useSslBoolean

      是否使用加密连接。

      示例： true

  • userProvisioningString

    用户自动开通配置。

    示例： auto

  • groupProvisioningString

    用户组自动开通配置。

    示例： sync

  • attributeMappingsLinkedHashMap

    属性映射关系。

    示例： (nested object)

  • groupMappingsList

    用户组映射关系。

    示例： (nested array)

    • idpGroupString

      身份提供方用户组。

      示例： idp-admins

    • zcfRoleString

      分配给该身份源组的角色名称。

      示例： admin

  • sourceString

    来源信息。

    示例： manual

  • statusString

    状态信息。

    示例： active

  • enabledBoolean

    是否启用。

    示例： true

  • lastTestAtString

    最近一次测试时间。

    示例： 2026-01-15T08:00:00Z

  • lastTestResultString

    最近一次连通性测试结果消息。

    示例： success

  • createdAtString

    创建时间。

    示例： 2026-01-15T08:00:00Z

  • updatedAtString

    更新时间。

    示例： 2026-01-15T08:00:00Z

请求地址

POST/api/v1/sso/configurations

/api/v1/sso/configurations

操作 ID

CreateSSOConfig

永久链接

请求示例

curl -X POST '{host}/api/v1/sso/configurations' -H 'Authorization: Bearer {token}' -H 'Content-Type: application/json' -d '{"tenantUuid":"deprecated-tenant-uuid","displayName":"Corporate SSO","providerType":"OIDC","protocol":"oidc","oidcConfig":{"clientId":"my-client-id","clientSecret":"s3cr3t","wellKnownUrl":"https://idp.example.com/.well-known/openid-configuration","redirectUri":"https://zcf.example.com/sso/callback","scope":"openid profile email","configName":"Corporate OIDC"},"samlConfig":{"idpEntityId":"https://idp.example.com/saml/metadata","idpSsoUrl":"https://idp.example.com/saml/sso","idpSloUrl":"https://idp.example.com/saml/slo","idpCertificate":"-----BEGIN CERTIFICATE-----\n...","idpMetadataUrl":"https://idp.example.com/saml/metadata.xml","spEntityId":"https://zcf.example.com/saml/sp","nameIdFormat":"urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress","signRequests":true,"forceAuthn":false,"spCertificatePem":"-----BEGIN CERTIFICATE-----\n..."},"ldapConfig":{"serverAddress":"ldap.example.com","port":389,"baseDn":"dc=example,dc=com","bindDn":"cn=admin,dc=example,dc=com","bindPassword":"bindP@ssw0rd","userSearchBase":"ou=users,dc=example,dc=com","userSearchFilter":"(uid=%s)","useSsl":true},"userProvisioning":"auto","groupProvisioning":"sync","attributeMappings":"(nested object)","groupMappings":"(nested array)"}'

响应示例

200
{
  "uuid": "sso-cfg-001",
  "issuer": "https://idp.example.com",
  "displayName": "Corporate SSO",
  "providerType": "OIDC",
  "protocol": "oidc",
  "oidcConfig": {},
  "samlConfig": {}
}

变更历史

此 API 暂无变更历史记录。

查看全部变更历史