跳转到主要内容
API Explorer|API Explorer
系统管理/统一认证服务器相关接口
POSTSingle Sign-On Server Interfaces起始版本 4.3.0同步需要认证

添加LDAP服务器

添加LDAP服务器

调试可用性

在线调试

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

请求参数

请求体字段

  • nameString必填

    资源名称。

  • descriptionString

    资源的详细描述。

  • urlString必填

    LDAP服务器访问地址。

  • baseString必填

    LDAP服务器查询基础DN。

  • usernameString必填

    用户名。

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • errorErrorCode必填

    错误码，若不为null，则表示操作失败, 操作成功时该字段为null。 详情参考error

    • codeString必填

      错误码号，错误的全局唯一标识，例如SYS.1000, HOST.1001

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

      根错误，引发当前错误的源错误，若无原错误，该字段为null

  • inventoryLdapServerInventory必填

    详情参考inventory

    • uuidString必填

      资源的UUID，唯一标示该资源

    • nameString必填

      资源名称

    • typeString必填

      用户源类型，一般是ldap

    • descriptionString必填

      资源的详细描述

    • urlString必填

      地址。

    • baseString必填

      LDAP服务器访问地址

    • usernameString必填

      用于访问LDAP服务器的用户名

    • passwordString必填

      密码

    • encryptionString必填

      加密方式

    • serverTypeString必填

      服务器类型，可能是OpenLdap或WindowsAD，如果不确定会返回Unknown

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

请求地址

POST/zstack/v1/ldap/servers

/zstack/v1/ldap/servers

操作 ID

AddLdapServer

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/ldap/servers' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"name":"<name>","description":"<description>","url":"<url>","base":"<base>","username":"<username>","password":"<password>","encryption":"<encryption>","systemTags":["<systemTags>"],"userTags":["<userTags>"],"serverType":"<serverType>","usernameProperty":"<usernameProperty>","filter":"<filter>","syncCreatedAccountStrategy":"<syncCreatedAccountStrategy>","syncDeletedAccountStrategy":"<syncDeletedAccountStrategy>"}'

响应示例

200
{ "inventory": { "uuid": "01b489793e3d31728ccbbc4fdfd99ed0", "name": "miao", "description": "miao desc", "url": "ldap://localhost:1888", "base": "dc\u003dexample,dc\u003dcom", "username": "", "password": "", "encryption": "None" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史