MLflow 身份验证 REST API

MLflow 身份验证 REST API 允许您创建、获取、更新和删除用户、实验权限和注册模型权限。该 API 托管在 MLflow 跟踪服务器的 /api 路由下。例如，要在托管在 https://:5000 上的跟踪服务器上列出实验，请访问 https://:5000/api/2.0/mlflow/users/create。

重要提示

MLflow REST API 要求所有 POST 请求的内容类型为 application/json。

---

创建用户

端点	HTTP 方法
2.0/mlflow/users/create	POST

请求结构

字段名称	类型	描述
username	STRING	用户名。
password	STRING	密码。

响应结构

字段名称	类型	描述
user	用户	一个用户对象。

---

获取用户

端点	HTTP 方法
2.0/mlflow/users/get	GET

请求结构

字段名称	类型	描述
username	STRING	用户名。

响应结构

字段名称	类型	描述
user	用户	一个用户对象。

---

更新用户密码

端点	HTTP 方法
2.0/mlflow/users/update-password	PATCH

请求结构

字段名称	类型	描述
username	STRING	用户名。
password	STRING	新密码。

---

更新用户管理员状态

端点	HTTP 方法
2.0/mlflow/users/update-admin	PATCH

请求结构

字段名称	类型	描述
username	STRING	用户名。
is_admin	BOOLEAN	新的管理员状态。

---

删除用户

端点	HTTP 方法
2.0/mlflow/users/delete	DELETE

请求结构

字段名称	类型	描述
username	STRING	用户名。

---

创建实验权限

端点	HTTP 方法
2.0/mlflow/experiments/permissions/create	POST

请求结构

字段名称	类型	描述
experiment_id	STRING	实验 ID。
username	STRING	用户名。
permission	权限	要授予的权限。

响应结构

字段名称	类型	描述
experiment_permission	实验权限	一个实验权限对象。

---

获取实验权限

端点	HTTP 方法
2.0/mlflow/experiments/permissions/get	GET

请求结构

字段名称	类型	描述
experiment_id	STRING	实验 ID。
username	STRING	用户名。

响应结构

字段名称	类型	描述
experiment_permission	实验权限	一个实验权限对象。

---

更新实验权限

端点	HTTP 方法
2.0/mlflow/experiments/permissions/update	PATCH

请求结构

字段名称	类型	描述
experiment_id	STRING	实验 ID。
username	STRING	用户名。
permission	权限	要授予的新权限。

---

删除实验权限

端点	HTTP 方法
2.0/mlflow/experiments/permissions/delete	DELETE

请求结构

字段名称	类型	描述
experiment_id	STRING	实验 ID。
username	STRING	用户名。

---

创建注册模型权限

端点	HTTP 方法
2.0/mlflow/registered-models/permissions/create	CREATE

请求结构

字段名称	类型	描述
name	STRING	注册模型的名称。
username	STRING	用户名。
permission	权限	要授予的权限。

响应结构

字段名称	类型	描述
registered_model_permission	注册模型权限	一个注册模型权限对象。

---

获取注册模型权限

端点	HTTP 方法
2.0/mlflow/registered-models/permissions/get	GET

请求结构

字段名称	类型	描述
name	STRING	注册模型的名称。
username	STRING	用户名。

响应结构

字段名称	类型	描述
registered_model_permission	注册模型权限	一个注册模型权限对象。

---

更新注册模型权限

端点	HTTP 方法
2.0/mlflow/registered-models/permissions/update	PATCH

请求结构

字段名称	类型	描述
name	STRING	注册模型的名称。
username	STRING	用户名。
permission	权限	要授予的新权限。

---

删除注册模型权限

端点	HTTP 方法
2.0/mlflow/registered-models/permissions/delete	DELETE

请求结构

字段名称	类型	描述
name	STRING	注册模型的名称。
username	STRING	用户名。

数据结构

用户

字段名称	类型	描述
id	STRING	用户 ID。
username	STRING	用户名。
is_admin	BOOLEAN	用户是否为管理员。
experiment_permissions	一个 ExperimentPermission 数组	明确授予用户的权限。
registered_model_permissions	一个 RegisteredModelPermission 数组	明确授予用户的注册模型权限。

权限

用户对实验或注册模型的权限。

名称	描述
READ	可以读取。
EDIT	可以读取和更新。
MANAGE	可以读取、更新、删除和管理。
NO_PERMISSIONS	没有权限。

ExperimentPermission

字段名称	类型	描述
experiment_id	STRING	实验 ID。
user_id	STRING	用户 ID。
permission	权限	授予的权限。

RegisteredModelPermission

字段名称	类型	描述
name	STRING	注册模型的名称。
user_id	STRING	用户 ID。
permission	权限	授予的权限。