跳转到主要内容
身份与访问控制相关接口/ZIAM

更新ZIAM登录路由

保存密码登录使用的路由规则,并支持乐观锁。

PUT/api/v1/ziam/login-routing

操作 ID

ZiamUpdateLoginRouting

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

调用该 API 时需要在请求头中携带以下认证信息。

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • resourceVersion
    Long必填

    资源版本。

    示例: 1

  • reason
    String必填

    原因说明。

    示例: rotate default zstack application

  • value
    Object必填

    字段值。

    • admin
      Object必填

      资源。

      • username
        String

        用户名。

        示例: admin

      • organization
        String必填

        资源。

        示例: zstack

      • application
        String必填

        资源。

        示例: ziam-default-app

      • clientId
        String

        客户端ID。

        示例: 9f5b7df0-7ca2-47f0-aaf3-657a1b8d2d31

      • clientSecret
        String

        客户端密钥。

        示例: ******

      • clientSecretRef
        String

        客户端密钥引用。

        示例: env:ZIAM_DEFAULT_LOGIN_CLIENT_SECRET

    • default
      Object必填

      默认。

      • username
        String

        用户名。

        示例: admin

      • organization
        String必填

        资源。

        示例: zstack

      • application
        String必填

        资源。

        示例: ziam-default-app

      • clientId
        String

        客户端ID。

        示例: 9f5b7df0-7ca2-47f0-aaf3-657a1b8d2d31

      • clientSecret
        String

        客户端密钥。

        示例: ******

      • clientSecretRef
        String

        客户端密钥引用。

        示例: env:ZIAM_DEFAULT_LOGIN_CLIENT_SECRET

响应状态

200 OK
200 OK

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

  • status
    String

    状态信息。

    示例: ok

  • data
    Object

    返回数据。

    • namespace
      String

      命名空间。

      示例: auth

    • key
      String

      键。

      示例: loginRouting

    • scopeType
      String

      资源。

      示例: global

    • scopeId
      String

      资源。

      示例: default

    • schemaVersion
      Integer

      规则格式版本。

      示例: 1

    • resourceVersion
      Long

      资源。

      示例: 1

    • status
      String

      状态信息。

      示例: active

    • description
      String

      资源的详细描述。

      示例: A brief description

    • value
      Object

      字段值。

      • admin
        Object必填

        资源。

        • username
          String

          用户名。

          示例: admin

        • organization
          String必填

          资源。

          示例: zstack

        • application
          String必填

          资源。

          示例: ziam-default-app

        • clientId
          String

          客户端ID。

          示例: 9f5b7df0-7ca2-47f0-aaf3-657a1b8d2d31

        • clientSecret
          String

          客户端密钥。

          示例: ******

        • clientSecretRef
          String

          客户端密钥引用。

          示例: env:ZIAM_DEFAULT_LOGIN_CLIENT_SECRET

      • default
        Object必填

        默认。

        • username
          String

          用户名。

          示例: admin

        • organization
          String必填

          资源。

          示例: zstack

        • application
          String必填

          资源。

          示例: ziam-default-app

        • clientId
          String

          客户端ID。

          示例: 9f5b7df0-7ca2-47f0-aaf3-657a1b8d2d31

        • clientSecret
          String

          客户端密钥。

          示例: ******

        • clientSecretRef
          String

          客户端密钥引用。

          示例: env:ZIAM_DEFAULT_LOGIN_CLIENT_SECRET