@autional/api-rbac
v0.4.1
Published
Autional Rbac API — auto-generated TypeScript client from rbac-service
Readme
@autional/api-rbac
Autional Rbac API — auto-generated TypeScript client from rbac-service (46 functions).
Auto-generated by
python sdk/scripts/generate-api-packages.py. Do not edit by hand.
Functions
| Function | Method | Path | Description |
|----------|--------|------|-------------|
| getAdminApprovalRequests(client, params?) | GET | /admin/approval-requests | 列出审批请求 |
| postAdminApprovalRequestsApproveByApprovalRequests(client, requestId: string, data: ApproveRejectRequest) | POST | /admin/approval-requests/{request_id}/approve | 批准审批请求 |
| postAdminApprovalRequestsRejectByApprovalRequests(client, requestId: string, data: ApproveRejectRequest) | POST | /admin/approval-requests/{request_id}/reject | 拒绝审批请求 |
| getAdminPermissions(client, params?) | GET | /admin/permissions | 查询权限列表 |
| postAdminPermissions(client, data: CreatePermissionRequest) | POST | /admin/permissions | 创建权限 |
| postAdminPermissionsSimulate(client, data: SimulatePermissionRequest) | POST | /admin/permissions/simulate | 权限模拟/试算 |
| deleteAdminPermissionsByPermissions(client, permissionId: string) | DELETE | /admin/permissions/{permission_id} | 删除权限 |
| getAdminPermissionsByPermissions(client, permissionId: string) | GET | /admin/permissions/{permission_id} | 获取权限详情 |
| putAdminPermissionsByPermissions(client, permissionId: string, data: UpdatePermissionRequest) | PUT | /admin/permissions/{permission_id} | 更新权限信息 |
| getAdminPermissionsRolesByPermissions(client, permissionId: string) | GET | /admin/permissions/{permission_id}/roles | 获取权限的角色列表 |
| getAdminPermissionsUsersByPermissions(client, permissionId: string) | GET | /admin/permissions/{permission_id}/users | 获取权限的用户列表 |
| getAdminRoles(client, params?) | GET | /admin/roles | 查询角色列表 |
| postAdminRoles(client, data: CreateRoleRequest) | POST | /admin/roles | 创建角色 |
| deleteAdminRolesBatchPermissions(client, data: BatchRevokePermissionsRequest) | DELETE | /admin/roles/batch/permissions | 批量撤销权限 |
| postAdminRolesBatchPermissions(client, data: BatchAssignPermissionsRequest) | POST | /admin/roles/batch/permissions | 批量分配权限 |
| getAdminRolesConflictPairs(client) | GET | /admin/roles/conflict-pairs | 列出职责分离冲突对 |
| postAdminRolesConflictPairs(client, data: CreateConflictPairRequest) | POST | /admin/roles/conflict-pairs | 创建职责分离(SoD)冲突对 |
| deleteAdminRolesConflictPairsByConflictPairs(client, pairId: string) | DELETE | /admin/roles/conflict-pairs/{pair_id} | 删除职责分离冲突对 |
| getAdminRolesDefaults(client) | GET | /admin/roles/defaults | 列出默认角色 |
| postAdminRolesDefaults(client, data: AddDefaultRoleRequest) | POST | /admin/roles/defaults | 添加租户默认角色 |
| deleteAdminRolesDefaultsByDefaults(client, roleId: string) | DELETE | /admin/roles/defaults/{role_id} | 移除默认角色 |
| deleteAdminRolesByRoles(client, roleId: string) | DELETE | /admin/roles/{role_id} | 删除角色 |
| getAdminRolesByRoles(client, roleId: string) | GET | /admin/roles/{role_id} | 获取角色详情 |
| putAdminRolesByRoles(client, roleId: string, data: UpdateRoleRequest) | PUT | /admin/roles/{role_id} | 更新角色信息 |
| postAdminRolesApprovalRequestsByRoles(client, roleId: string, data: RequestApprovalRequest) | POST | /admin/roles/{role_id}/approval-requests | 请求角色变更审批 |
| getAdminRolesChildrenByRoles(client, roleId: string) | GET | /admin/roles/{role_id}/children | 获取子角色列表 |
| postAdminRolesChildrenByRoles(client, roleId: string, data: AddRoleChildRequest) | POST | /admin/roles/{role_id}/children | 添加子角色 |
| deleteAdminRolesChildrenByRolesByChildren(client, roleId: string, childId: string) | DELETE | /admin/roles/{role_id}/children/{child_id} | 移除子角色 |
| postAdminRolesCloneByRoles(client, roleId: string, data: CloneRoleRequest) | POST | /admin/roles/{role_id}/clone | 克隆角色 |
| getAdminRolesEffectivePermissionsByRoles(client, roleId: string) | GET | /admin/roles/{role_id}/effective-permissions | 获取角色有效权限 |
| getAdminRolesParentsByRoles(client, roleId: string) | GET | /admin/roles/{role_id}/parents | 获取祖先角色链 |
| deleteAdminRolesPermissionsByRoles(client, roleId: string, data: RevokePermissionsRequest) | DELETE | /admin/roles/{role_id}/permissions | 撤销角色权限 |
| getAdminRolesPermissionsByRoles(client, roleId: string) | GET | /admin/roles/{role_id}/permissions | 获取角色直接分配的权限 |
| postAdminRolesPermissionsByRoles(client, roleId: string, data: AssignPermissionsRequest) | POST | /admin/roles/{role_id}/permissions | 为角色分配权限 |
| getAdminRolesUsersByRoles(client, roleId: string) | GET | /admin/roles/{role_id}/users | 获取角色的用户列表 |
| deleteAdminUsersBatchRoles(client, data: BatchRemoveRolesRequest) | DELETE | /admin/users/batch/roles | 批量移除角色 |
| postAdminUsersBatchRoles(client, data: BatchAssignRolesRequest) | POST | /admin/users/batch/roles | 批量分配角色 |
| deleteAdminUsersPermissionsByUsers(client, userId: string, data: RevokeDirectPermissionsRequest) | DELETE | /admin/users/{user_id}/permissions | 撤销用户直赋权限 |
| getAdminUsersPermissionsByUsers(client, userId: string) | GET | /admin/users/{user_id}/permissions | 获取用户有效权限列表 |
| postAdminUsersPermissionsByUsers(client, userId: string, data: AssignDirectPermissionsRequest) | POST | /admin/users/{user_id}/permissions | 为用户直赋权限 |
| deleteAdminUsersRolesByUsers(client, userId: string, data: RemoveRolesRequest) | DELETE | /admin/users/{user_id}/roles | 移除用户角色 |
| getAdminUsersRolesByUsers(client, userId: string) | GET | /admin/users/{user_id}/roles | 获取用户角色列表 |
| postAdminUsersRolesByUsers(client, userId: string, data: AssignRolesRequest) | POST | /admin/users/{user_id}/roles | 为用户分配角色 |
| postAdminUsersRolesValidateByUsers(client, userId: string) | POST | /admin/users/{user_id}/roles/validate | 验证用户角色冲突 |
| postAuthCheckPermission(client, data: CheckPermissionRequest) | POST | /auth/check-permission | 检查用户权限(用户侧) |
| postAuthCheckRole(client, data: CheckRoleRequest) | POST | /auth/check-role | 检查用户角色(用户侧) |
Install
npm install @autional/core @autional/api-rbacQuick Start
import { Autional, browserPlatform } from '@autional/core';
import { getAdminRolesDefaults } from '@autional/api-rbac';
const autional = new Autional({
appId: 'my-app',
issuer: 'https://auth.example.com', // your Autional server URL
platform: browserPlatform,
});
await autional.initialize();
// 返回值已由 ApiClient 解包为载荷(不是 { code, data, message } 信封)
const result = await getAdminRolesDefaults(autional.api);
console.log(result);Conventions
- Every function takes the
ApiClientas its first argument (autional.api). - Field names convert automatically:
camelCaseat the call site,snake_caseon the wire. - Return values are unwrapped payloads, not
{ code, data, message }envelopes.
See the root SDK README for tokens, refresh, and OAuth flows.
