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

创建ZIAM资源

创建 ZIAM 资源,并可同步创建用户的初始关联关系。

POST/api/v1/ziam/resources/{collection}

操作 ID

ZiamCreateResource

起始版本

1.0.0

执行模式

同步

认证信息

需要认证

认证信息

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

Authorizationstring必填

Bearer 令牌

X-Tenant-IDstring

X-Tenant-ID

请求参数

application/json

请求体字段

  • uuid
    String必填

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

    示例: 11111111111111111111111111111111

  • name
    String必填

    资源名称。

    示例: alice

  • userName
    String必填

    用户名称。

    示例: alice

  • displayName
    String必填

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

    示例: Alice

  • description
    String必填

    资源的详细描述。

    示例: A brief description

响应状态

200 OK
200 OK

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

  • status
    String

    状态信息。

    示例: ok

  • data
    Object

    返回数据。

    • uuid
      String

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

      示例: 11111111111111111111111111111111

    • name
      String

      资源名称。

      示例: alice

    • userName
      String

      用户名称。

      示例: alice

    • displayName
      String

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

      示例: Alice

    • description
      String

      资源的详细描述。

      示例: A brief description

    • password
      String

      密码。

      示例: password123

    • confirmPassword
      String

      确认密码。

      示例: password123

    • email
      String

      邮箱地址。

      示例: alice@example.com

    • phone
      String

      联系电话。

      示例: +8613800138000

    • phoneNumber
      String

      电话数量。

      示例: +8613800138000

    • mobile
      String

      手机。

      示例: +8613800138000

    • source
      String

      来源信息。

      示例: ZIAM

    • status
      String

      状态信息。

      示例: Enabled

    • credentialStatus
      Object

      资源。

      • type
        String

        类型。

        示例: password

      • algorithm
        String

        密码验证器算法已使用内部ZIAM。

        示例: argon2id

      • version
        Long

        版本号。

        示例: 1

      • status
        String

        状态信息。

        示例: Active

      • mustChange
        Boolean

        变更。

        示例: false

      • createdAt
        String

        创建时间。

        示例: 2026-06-17T01:00:00Z

      • updatedAt
        String

        更新时间。

        示例: 2026-06-17T01:00:00Z

    • createdAt
      String

      创建时间。

      示例: 2026-06-16T10:00:00Z

    • updatedAt
      String

      更新时间。

      示例: 2026-06-16T10:30:00Z

    • lastLoginTime
      String

      最近一次登录时间。

      示例: 2026-06-16T10:00:00Z

    • lastLoginIp
      String

      最近一次登录IP。

      示例: 172.26.53.126

    • groups
      List

      用户组列表。

      示例: (nested array)

      • id
        String

        资源ID。

        示例: group-001

      • uuid
        String

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

        示例: group-001

      • source
        String

        来源信息。

        示例: ZIAM

      • ziamGroupId
        String

        ZIAM组ID。

        示例: group-001

      • name
        String必填

        资源名称。

        示例: Operators

      • displayName
        String

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

        示例: Operators

      • description
        String

        资源的详细描述。

        示例: A brief description

      • projectId
        String

        可选项目ID拥有组。

        示例: project-001

      • projectUuid
        String

        资源。

        示例: project-001

      • enabled
        Boolean

        是否启用。

        示例: true

      • active
        Boolean

        资源。

        示例: true

      • members
        List

        成员列表。

        示例: (nested array)

        • value
          String

          字段值。

          示例: 11111111111111111111111111111111

        • uuid
          String

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

          示例: 11111111111111111111111111111111

        • display
          String

          资源。

          示例: Alice

        • joinedAt
          String

          加入时间。

          示例: 2026-06-16T10:00:00Z

      • attributes
        Object

        资源。

        示例: (nested object)

      • resourceVersion
        Long

        单调递增版本已使用下游同步。

        示例: 10

      • status
        String

        状态信息。

        示例: Enabled

      • createdAt
        String

        创建时间。

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

      • updatedAt
        String

        更新时间。

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

      • userCount
        Long

        用户数量。

        示例: 1

      • directUserCount
        Long

        直接用户数量。

        示例: 1

      • projects
        List

        相关组。

        示例: (nested array)

        • id
          String

          资源ID。

          示例: project-001

        • uuid
          String

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

          示例: project-001

        • source
          String

          来源信息。

          示例: ZIAM

        • ziamProjectId
          String

          ZIAM项目ID。

          示例: project-001

        • name
          String必填

          资源名称。

          示例: Project A

        • displayName
          String

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

          示例: Project A

        • description
          String

          资源的详细描述。

          示例: A brief description

        • organizationId
          String

          组织ID。

          示例: dept-001

        • organizationUuid
          String

          资源。

          示例: dept-001

        • tenantId
          String

          租户ID。

          示例: tenant-001

        • tenantUuid
          String

          租户UUID。

          示例: tenant-001

        • accountId
          String

          可选下游账户ID。

          示例: account-001

        • accountUuid
          String

          资源。

          示例: account-001

        • linkAccountUuid
          String

          可选云项目关联账户UUID。

          示例: account-001

        • enabled
          Boolean

          是否启用。

          示例: true

        • active
          Boolean

          资源。

          示例: true

        • attributes
          Object

          资源。

          示例: (nested object)

        • resourceVersion
          Long

          单调递增版本已使用下游同步。

          示例: 10

        • status
          String

          状态信息。

          示例: Enabled

        • createdAt
          String

          创建时间。

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

        • updatedAt
          String

          更新时间。

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

        • userCount
          Long

          用户数量。

          示例: 1

        • directUserCount
          Long

          直接用户数量。

          示例: 1

        • groupCount
          Long

          组数量。

          示例: 1

        • userGroupCount
          Long

          用户组数量。

          示例: 1

        • joinedAt
          String

          加入时间。

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

      • projectNames
        List

        名称项目相关组。

        示例: item1,item2

      • projectCount
        Long

        项目数量。

        示例: 1

      • joinedAt
        String

        加入时间。

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

    • groupNames
      List

      组名称。

      示例: item1,item2

    • groupCount
      Long

      组数量。

      示例: 1

    • organizations
      List

      组织。

      示例: (nested array)

      • id
        String

        资源ID。

        示例: dept-001

      • uuid
        String

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

        示例: dept-001

      • source
        String

        来源信息。

        示例: ZIAM

      • ziamDepartmentId
        String

        ZIAM部门ID。

        示例: dept-001

      • name
        String必填

        资源名称。

        示例: Engineering

      • displayName
        String

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

        示例: Engineering

      • description
        String

        资源的详细描述。

        示例: A brief description

      • parentId
        String

        父项组织ID。

        示例: company-001

      • parentUuid
        String

        父级资源UUID。

        示例: company-001

      • rootId
        String

        可选根组织ID。

        示例: company-001

      • rootUuid
        String

        根部门UUID。为空时返回全量树。

        示例: company-001

      • type
        String

        类型。

        示例: Department

      • enabled
        Boolean

        是否启用。

        示例: true

      • active
        Boolean

        可选已启用标志已接受SCIM接收器。

        示例: true

      • members
        List

        成员列表。

        示例: (nested array)

        • value
          String

          字段值。

          示例: 11111111111111111111111111111111

        • uuid
          String

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

          示例: 11111111111111111111111111111111

        • display
          String

          资源。

          示例: Alice

        • joinedAt
          String

          加入时间。

          示例: 2026-06-16T10:00:00Z

      • attributes
        Object

        资源。

        示例: (nested object)

      • resourceVersion
        Long

        单调递增版本已使用下游同步。

        示例: 10

      • status
        String

        状态信息。

        示例: Enabled

      • createdAt
        String

        创建时间。

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

      • updatedAt
        String

        更新时间。

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

      • ownerUuid
        String

        组织负责人用户UUID已配置。

        示例: 11111111111111111111111111111111

      • ownerName
        String

        负责人名称。

        示例: Alice

      • departmentPath
        String

        部门路径。

        示例: Company/Engineering

      • departmentPathNames
        List

        组织树显示路径单独名称。

        示例: item1,item2

      • directUserCount
        Long

        直接用户数量。

        示例: 1

      • totalUserCount
        Long

        总用户数量。

        示例: 10

      • joinedAt
        String

        加入时间。

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

    • directOrganizations
      List

      用户列表显示聚合直接部门成员关系。

      示例: (nested array)

      • id
        String

        资源ID。

        示例: dept-001

      • uuid
        String

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

        示例: dept-001

      • source
        String

        来源信息。

        示例: ZIAM

      • ziamDepartmentId
        String

        ZIAM部门ID。

        示例: dept-001

      • name
        String必填

        资源名称。

        示例: Engineering

      • displayName
        String

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

        示例: Engineering

      • description
        String

        资源的详细描述。

        示例: A brief description

      • parentId
        String

        父项组织ID。

        示例: company-001

      • parentUuid
        String

        父级资源UUID。

        示例: company-001

      • rootId
        String

        可选根组织ID。

        示例: company-001

      • rootUuid
        String

        根部门UUID。为空时返回全量树。

        示例: company-001

      • type
        String

        类型。

        示例: Department

      • enabled
        Boolean

        是否启用。

        示例: true

      • active
        Boolean

        可选已启用标志已接受SCIM接收器。

        示例: true

      • members
        List

        成员列表。

        示例: (nested array)

        • value
          String

          字段值。

          示例: 11111111111111111111111111111111

        • uuid
          String

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

          示例: 11111111111111111111111111111111

        • display
          String

          资源。

          示例: Alice

        • joinedAt
          String

          加入时间。

          示例: 2026-06-16T10:00:00Z

      • attributes
        Object

        资源。

        示例: (nested object)

      • resourceVersion
        Long

        单调递增版本已使用下游同步。

        示例: 10

      • status
        String

        状态信息。

        示例: Enabled

      • createdAt
        String

        创建时间。

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

      • updatedAt
        String

        更新时间。

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

      • ownerUuid
        String

        组织负责人用户UUID已配置。

        示例: 11111111111111111111111111111111

      • ownerName
        String

        负责人名称。

        示例: Alice

      • departmentPath
        String

        部门路径。

        示例: Company/Engineering

      • departmentPathNames
        List

        组织树显示路径单独名称。

        示例: item1,item2

      • directUserCount
        Long

        直接用户数量。

        示例: 1

      • totalUserCount
        Long

        总用户数量。

        示例: 10

      • joinedAt
        String

        加入时间。

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

    • organizationNames
      List

      显示聚合相关组织名称。

      示例: item1,item2

    • departmentNames
      List

      显示聚合相关部门名称。

      示例: item1,item2

    • directOrganizationCount
      Long

      直接组织数量。

      示例: 1

    • projects
      List

      项目。

      示例: (nested array)

      • id
        String

        资源ID。

        示例: project-001

      • uuid
        String

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

        示例: project-001

      • source
        String

        来源信息。

        示例: ZIAM

      • ziamProjectId
        String

        ZIAM项目ID。

        示例: project-001

      • name
        String必填

        资源名称。

        示例: Project A

      • displayName
        String

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

        示例: Project A

      • description
        String

        资源的详细描述。

        示例: A brief description

      • organizationId
        String

        组织ID。

        示例: dept-001

      • organizationUuid
        String

        资源。

        示例: dept-001

      • tenantId
        String

        租户ID。

        示例: tenant-001

      • tenantUuid
        String

        租户UUID。

        示例: tenant-001

      • accountId
        String

        可选下游账户ID。

        示例: account-001

      • accountUuid
        String

        资源。

        示例: account-001

      • linkAccountUuid
        String

        可选云项目关联账户UUID。

        示例: account-001

      • enabled
        Boolean

        是否启用。

        示例: true

      • active
        Boolean

        资源。

        示例: true

      • attributes
        Object

        资源。

        示例: (nested object)

      • resourceVersion
        Long

        单调递增版本已使用下游同步。

        示例: 10

      • status
        String

        状态信息。

        示例: Enabled

      • createdAt
        String

        创建时间。

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

      • updatedAt
        String

        更新时间。

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

      • userCount
        Long

        用户数量。

        示例: 1

      • directUserCount
        Long

        直接用户数量。

        示例: 1

      • groupCount
        Long

        组数量。

        示例: 1

      • userGroupCount
        Long

        用户组数量。

        示例: 1

      • joinedAt
        String

        加入时间。

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

    • projectNames
      List

      显示聚合相关项目名称。

      示例: item1,item2

    • projectCount
      Long

      项目数量。

      示例: 1

    • userCount
      Long

      用户数量。

      示例: 1

    • directUserCount
      Long

      直接用户数量。

      示例: 1

    • userGroupCount
      Long

      用户组数量。

      示例: 1

    • ownerUuid
      String

      组织负责人用户UUID已配置。

      示例: 11111111111111111111111111111111

    • ownerName
      String

      负责人名称。

      示例: Alice

    • departmentPath
      String

      部门路径。

      示例: Company/Engineering

    • departmentPathNames
      List

      组织树显示路径单独名称。

      示例: item1,item2

    • totalUserCount
      Long

      总用户数量。

      示例: 10

    • groupUuids
      List

      组UUID。

      示例: item1,item2

    • projectUuids
      List

      项目UUID。

      示例: item1,item2

    • organizationUuids
      List

      组织UUID。

      示例: item1,item2

    • departmentUuids
      List

      部门UUID。

      示例: item1,item2

    • joinedAt
      String

      加入时间。

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

    • deletionTimestamp
      String

      软删除时间戳已删除用户。

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

    • deletionPhase
      String

      软已删除用户。

      示例: SoftDeleted

    • retentionUntil
      String

      保留截止。

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

    • finalizers
      List

      删除终结器应用软已删除用户。

      示例: item1,item2