跳转到主要内容
API Explorer|API Explorer
运营管理/租户管理(Plus)/统一认证SSO相关接口
POSTSSO Operations起始版本 4.5.0同步需要认证

更新CAS客户端

更新CAS客户端

调试可用性

在线调试

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

请求参数

请求体字段

  • uuidString必填

    资源UUID。

  • descriptionString

    资源的详细描述。

  • nameString

    资源名称。

  • casServerLoginUrlString

    可选cas服务器login地址。

  • casServerUrlPrefixString

    可选cas服务器地址prefix。

响应状态

200 OK

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

  • successboolean必填

    操作是否成功。

  • inventoryCasClientInventory必填

    详情参考inventory

    • casServerLoginUrlString必填

      cas服务器login地址。

    • casServerUrlPrefixString必填

      cas服务器地址prefix。

    • serverNameString必填

      mn的地址(http://{mn_ip:port}/8080)

    • uuidString必填

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

    • nameString必填

      资源名称

    • descriptionString必填

      资源的详细描述

    • clientTypeString必填

      客户端类型。

    • loginTypeString必填

      登录的类型： cas-iam1 cas-ima2 oauth2-iam1 oauth2-iam2

    • loginMNUrlString必填

      免密登录的url

    • createDateTimestamp必填

      创建时间

    • lastOpDateTimestamp必填

      最后一次修改时间

    • accountUuidString必填

      账户UUID

    • stateCasState必填

      详情参考state

      • EnabledCasState必填

        已启用。

      • DisabledCasState必填

        已禁用。

  • errorErrorCode必填

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

    • codeString必填

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

    • descriptionString必填

      错误的概要描述

    • detailsString必填

      错误的详细信息

    • elaborationString必填

      保留字段，默认为null

    • opaqueLinkedHashMap必填

      保留字段，默认为null

    • causeErrorCode必填

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

请求地址

POST/zstack/v1/update/cas/client

/zstack/v1/update/cas/client

操作 ID

UpdateCasClient

永久链接

请求示例

curl -X POST 'http://{host}/zstack/v1/update/cas/client' -H 'Authorization: OAuth {sessionUuid}' -H 'Content-Type: application/json;charset=UTF-8' -d '{"uuid":"<uuid>","description":"<description>","name":"<name>","casServerLoginUrl":"<casServerLoginUrl>","casServerUrlPrefix":"<casServerUrlPrefix>","serverName":"<serverName>","loginType":"<loginType>","systemTags":["<systemTags>"],"userTags":["<userTags>"]}'

响应示例

200
{ "inventory": { "casServerLoginUrl": "http://zstack.com/login", "casServerUrlPrefix": "http://zstack.com", "serverName": "http://127.0.0.1:8080/", "uuid": "5068f4c641153a3d9353c3326dc1dd5e", "name": "test", "description": "test", "loginType": "iam2", "loginMNUrl": "http://127.0.0.1:8080/zstack/sso/cas/" } }

变更历史

此 API 暂无变更历史记录。

查看全部变更历史