Skip to content

Admin BFF GraphQL 接口 ​

Admin BFF 是管理后台使用的 GraphQL 接口,覆盖组织、用户、成员关系、角色、演示会话和活动日志。

端点 ​

功能地址
GraphQL 请求地址POST http://127.0.0.1:4010/graphql

/graphql 端点仅接受 POST 请求。本地启动服务后,可在浏览器中访问 http://127.0.0.1:4010/graphiql 使用 GraphiQL 交互式调试。

查询示例 ​

演示会话 ​

根据选中的演示账号,返回当前用户的资料、权限和可访问的组织。

graphql
query DemoSession($selectedUserId: ID) {
  demoSession(selectedUserId: $selectedUserId) {
    currentAccount {
      id
      displayName
      email
    }
    capabilities {
      orgManagement
      userManagement
    }
    userManagementOrganizations {
      id
      name
      kind
      status
    }
  }
}

变量:

json
{
  "selectedUserId": "user-tenant-admin"
}

组织列表 ​

查询当前上下文可见的所有组织。

graphql
query Organizations {
  organizations {
    id
    name
    kind
    status
    referenceId
  }
}

用户列表 ​

分页查询某个组织下的用户。

graphql
query OrganizationUsers($input: UserListInput!) {
  users(input: $input) {
    totalElements
    items {
      id
      displayName
      email
      status
      memberships {
        organizationId
        roles {
          id
          name
        }
      }
    }
  }
}

变量:

json
{
  "input": {
    "organizationId": "org-demo-001",
    "pageNumber": 0,
    "pageSize": 20
  }
}

活动日志 ​

带筛选、排序和分页的活动日志查询。

graphql
query AdminActivityLog($input: ActivityLogListInput!) {
  activityLogs(input: $input) {
    totalElements
    items {
      id
      eventTime
      action
      result
      summary
      actor {
        id
        displayName
        email
      }
      target {
        type
        id
        name
        email
      }
    }
  }
}

变量:

json
{
  "input": {
    "organizationId": "org-demo-001",
    "pageNumber": 0,
    "pageSize": 10
  }
}

可用查询和变更 ​

类别操作
会话demoSession
组织organizations, organization
用户users, user
角色roles
活动日志activityLogs
变更(Mutation)activateUser, deactivateUser, addUserToOrganizationByEmail, changeUserRoles, addMembershipRole, removeMembershipRole