MLflow Authentication REST API

The MLflow Authentication REST API allows you to create, get, update and delete users, experiment permissions and registered model permissions. The API is hosted under the /api route on the MLflow tracking server. For example, to list experiments on a tracking server hosted at http://localhost:5000, access http://localhost:5000/api/2.0/mlflow/users/create.

Important

The MLflow REST API requires content type application/json for all POST requests.

---

Create User

Endpoint	HTTP Method
2.0/mlflow/users/create	POST

Request Structure

Field Name	Type	Description
username	STRING	Username.
password	STRING	Password.

Response Structure

Field Name	Type	Description
user	User	A user object.

---

Get User

Endpoint	HTTP Method
2.0/mlflow/users/get	GET

Request Structure

Field Name	Type	Description
username	STRING	Username.

Response Structure

Field Name	Type	Description
user	User	A user object.

---

Update User Password

Endpoint	HTTP Method
2.0/mlflow/users/update-password	PATCH

Request Structure

Field Name	Type	Description
username	STRING	Username.
password	STRING	New password.

---

Update User Admin

Endpoint	HTTP Method
2.0/mlflow/users/update-admin	PATCH

Request Structure

Field Name	Type	Description
username	STRING	Username.
is_admin	BOOLEAN	New admin status.

---

Delete User

Endpoint	HTTP Method
2.0/mlflow/users/delete	DELETE

Request Structure

Field Name	Type	Description
username	STRING	Username.

---

Create Experiment Permission

Endpoint	HTTP Method
2.0/mlflow/experiments/permissions/create	POST

Request Structure

Field Name	Type	Description
experiment_id	STRING	Experiment id.
username	STRING	Username.
permission	Permission	Permission to grant.

Response Structure

Field Name	Type	Description
experiment_permission	ExperimentPermission	An experiment permission object.

---

Get Experiment Permission

Endpoint	HTTP Method
2.0/mlflow/experiments/permissions/get	GET

Request Structure

Field Name	Type	Description
experiment_id	STRING	Experiment id.
username	STRING	Username.

Response Structure

Field Name	Type	Description
experiment_permission	ExperimentPermission	An experiment permission object.

---

Update Experiment Permission

Endpoint	HTTP Method
2.0/mlflow/experiments/permissions/update	PATCH

Request Structure

Field Name	Type	Description
experiment_id	STRING	Experiment id.
username	STRING	Username.
permission	Permission	New permission to grant.

---

Delete Experiment Permission

Endpoint	HTTP Method
2.0/mlflow/experiments/permissions/delete	DELETE

Request Structure

Field Name	Type	Description
experiment_id	STRING	Experiment id.
username	STRING	Username.

---

Create Registered Model Permission

Endpoint	HTTP Method
2.0/mlflow/registered-models/permissions/create	CREATE

Request Structure

Field Name	Type	Description
name	STRING	Registered model name.
username	STRING	Username.
permission	Permission	Permission to grant.

Response Structure

Field Name	Type	Description
registered_model_permission	RegisteredModelPermission	A registered model permission object.

---

Get Registered Model Permission

Endpoint	HTTP Method
2.0/mlflow/registered-models/permissions/get	GET

Request Structure

Field Name	Type	Description
name	STRING	Registered model name.
username	STRING	Username.

Response Structure

Field Name	Type	Description
registered_model_permission	RegisteredModelPermission	A registered model permission object.

---

Update Registered Model Permission

Endpoint	HTTP Method
2.0/mlflow/registered-models/permissions/update	PATCH

Request Structure

Field Name	Type	Description
name	STRING	Registered model name.
username	STRING	Username.
permission	Permission	New permission to grant.

---

Delete Registered Model Permission

Endpoint	HTTP Method
2.0/mlflow/registered-models/permissions/delete	DELETE

Request Structure

Field Name	Type	Description
name	STRING	Registered model name.
username	STRING	Username.

Data Structures

User

Field Name	Type	Description
id	STRING	User ID.
username	STRING	Username.
is_admin	BOOLEAN	Whether the user is an admin.
experiment_permissions	An array of ExperimentPermission	All experiment permissions explicitly granted to the user.
registered_model_permissions	An array of RegisteredModelPermission	All registered model permissions explicitly granted to the user.

Permission

Permission of a user to an experiment or a registered model.

Name	Description
READ	Can read.
EDIT	Can read and update.
MANAGE	Can read, update, delete and manage.
NO_PERMISSIONS	No permissions.

ExperimentPermission

Field Name	Type	Description
experiment_id	STRING	Experiment id.
user_id	STRING	User id.
permission	Permission	Permission granted.

RegisteredModelPermission

Field Name	Type	Description
name	STRING	Registered model name.
user_id	STRING	User id.
permission	Permission	Permission granted.