# User & Role Management

Manage Milvus users, passwords, roles, and permissions in Node.js, including role assignment and privilege grants.

SDK: `@zilliz/milvus2-sdk-node@3.0.10` · Tested with Milvus 3.0.6

Canonical documentation: https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/

## Section links

- [User Operations](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#user-operations)
- [Create User](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#create-user)
- [Update User](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#update-user)
- [Delete User](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#delete-user)
- [List Users](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#list-users)
- [Describe User](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#describe-user)
- [Role Operations](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#role-operations)
- [Create Role](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#create-role)
- [Drop Role](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#drop-role)
- [List Roles](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#list-roles)
- [Describe Role](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#describe-role)
- [Has Role](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#has-role)
- [User-Role Relationships](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#user-role-relationships)
- [Add User to Role](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#add-user-to-role)
- [Remove User from Role](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#remove-user-from-role)
- [Privilege Management](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#privilege-management)
- [Grant Privilege](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#grant-privilege)
- [Revoke Privilege](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#revoke-privilege)
- [Select Grant](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#select-grant)
- [List Grants](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#list-grants)
- [Privilege Groups](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#privilege-groups)
- [Create Privilege Group](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#create-privilege-group)
- [Drop Privilege Group](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#drop-privilege-group)
- [List Privilege Groups](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#list-privilege-groups)
- [Add Privileges to Group](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#add-privileges-to-group)
- [Remove Privileges from Group](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#remove-privileges-from-group)
- [RBAC v2](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#rbac-v2)
- [Grant Privilege v2](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#grant-privilege-v2)
- [Revoke Privilege v2](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#revoke-privilege-v2)
- [Backup RBAC](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#backup-rbac)
- [Restore RBAC](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#restore-rbac)
- [Drop All Roles](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#drop-all-roles)
- [Privilege Objects](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#privilege-objects)
- [Privilege Names](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#privilege-names)
- [Best Practices](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#best-practices)
- [Next Steps](https://milvus-io.github.io/milvus-sdk-node/management/user-role-management/#next-steps)

This guide covers user and role management, including authentication, authorization, and RBAC operations.

## User Operations

### Create User

Create a new user:

```javascript
await client.createUser({
  username: 'newuser',
  password: 'securepassword',
});
```

### Update User

Update user password:

```javascript
await client.updateUser({
  username: 'newuser',
  oldPassword: 'securepassword',
  newPassword: 'newpassword',
});
```

### Delete User

Delete a user:

```javascript
await client.deleteUser({
  username: 'newuser',
});
```

### List Users

List all users:

```javascript
const result = await client.listUsers();

console.log('Users:', result.usernames);
```

### Describe User

Get user information:

```javascript
const user = await client.describeUser({
  username: 'newuser',
});

console.log('User info:', user);
```

## Role Operations

### Create Role

Create a new role:

```javascript
await client.createRole({
  roleName: 'catalog_reader',
});
```

### Drop Role

Delete a role:

```javascript
await client.dropRole({
  roleName: 'catalog_reader',
});
```

### List Roles

List all roles:

```javascript
const result = await client.listRoles();

console.log('Roles:', result.results);
```

### Describe Role

Get role information:

```javascript
const role = await client.describeRole({
  roleName: 'catalog_reader',
});

console.log('Role info:', role);
```

### Has Role

Check if a role exists:

```javascript
const hasRole = await client.hasRole({
  roleName: 'catalog_reader',
});

console.log('Role exists:', hasRole.hasRole);
```

## User-Role Relationships

### Add User to Role

Assign a user to a role:

```javascript
await client.addUserToRole({
  username: 'newuser',
  roleName: 'catalog_reader',
});
```

### Remove User from Role

Remove a user from a role:

```javascript
await client.removeUserFromRole({
  username: 'newuser',
  roleName: 'catalog_reader',
});
```

## Privilege Management

Connect as an administrator to a Milvus server with authorization enabled before granting or revoking privileges.

### Grant Privilege

Grant privileges to a role:

```javascript
import { RbacObjects } from '@zilliz/milvus2-sdk-node';

await client.grantPrivilege({
  roleName: 'catalog_reader',
  object: RbacObjects.Collection,
  objectName: 'my_collection',
  privilegeName: 'Load',
});
```

### Revoke Privilege

Revoke privileges from a role:

```javascript
import { RbacObjects } from '@zilliz/milvus2-sdk-node';

await client.revokePrivilege({
  roleName: 'catalog_reader',
  object: RbacObjects.Collection,
  objectName: 'my_collection',
  privilegeName: 'Load',
});
```

### Select Grant

Get granted privileges:

```javascript
import { RbacObjects } from '@zilliz/milvus2-sdk-node';

const grants = await client.selectGrant({
  roleName: 'catalog_reader',
  object: RbacObjects.Collection,
  objectName: 'my_collection',
});

console.log('Grants:', grants.entities);
```

### List Grants

List all grants for a role:

```javascript
const grants = await client.listGrants({
  roleName: 'catalog_reader',
});

console.log('Grants:', grants.entities);
```

## Privilege Groups

### Create Privilege Group

Create a privilege group:

```javascript
await client.createPrivilegeGroup({
  group_name: 'readonly_group',
});
```

### Drop Privilege Group

Delete a privilege group:

```javascript
await client.dropPrivilegeGroup({
  group_name: 'readonly_group',
});
```

### List Privilege Groups

List all privilege groups:

```javascript
const groups = await client.listPrivilegeGroups();

console.log(
  'Groups:',
  groups.privilege_groups.map((group) => group.group_name)
);
```

### Add Privileges to Group

Add privileges to a group:

```javascript
await client.addPrivilegesToGroup({
  group_name: 'readonly_group',
  privileges: ['DescribeCollection'],
});
```

### Remove Privileges from Group

Remove privileges from a group:

```javascript
await client.removePrivilegesFromGroup({
  group_name: 'readonly_group',
  privileges: ['DescribeCollection'],
});
```

## RBAC v2

### Grant Privilege v2

Grant privileges using RBAC v2:

```javascript
await client.grantPrivilegeV2({
  role: 'catalog_reader',
  db_name: 'default',
  collection_name: 'my_collection',
  privilege: 'Load',
});
```

### Revoke Privilege v2

Revoke privileges using RBAC v2:

```javascript
await client.revokePrivilegeV2({
  role: 'catalog_reader',
  db_name: 'default',
  collection_name: 'my_collection',
  privilege: 'Load',
});
```

### Backup RBAC

Backup RBAC configuration:

```javascript
const backup = await client.backupRBAC();

console.log('Backup:', backup);
```

### Restore RBAC

Restore RBAC configuration:

```javascript
await client.restoreRBAC({
  RBAC_meta: backup.RBAC_meta,
});
```

## Drop All Roles

Drop all roles (use with caution):

```javascript
const results = await client.dropAllRoles();

console.log('Dropped roles:', results);
```

## Privilege Objects

Supported privilege objects:

- `Collection`
- `Global`
- `User`

## Privilege Names

Common privilege names:

- `Create`
- `Drop`
- `Describe`
- `Show`
- `Load`
- `Release`
- `Insert`
- `Delete`
- `Update`
- `Search`
- `Query`
- `Flush`
- `Compact`

## Best Practices

1. **Principle of least privilege**: Grant only necessary privileges
2. **Use roles**: Group users into roles for easier management
3. **Regular audits**: Review user and role assignments regularly
4. **Secure passwords**: Enforce strong password policies
5. **Backup RBAC**: Regularly backup RBAC configuration

## Next Steps

- Learn about [Client Configuration](https://milvus-io.github.io/milvus-sdk-node/core-concepts/client-configuration/)
- Explore [Best Practices](https://milvus-io.github.io/milvus-sdk-node/advanced/best-practices/)
