MLflow Authentication REST API
The MLflow Authentication REST API allows you to create, get, update, and delete users,
manage user permissions, and manage roles and role-based access control (RBAC).
The API supports both legacy 2.0 endpoints for user management and new 3.0
endpoints for unified permission and role management introduced in MLflow 3.13.0.
The API is hosted under the /api route on the MLflow tracking server. For example, to create
a user 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.
Table of Contents
Create User
Endpoint |
HTTP Method |
|---|---|
|
|
Get User
Endpoint |
HTTP Method |
|---|---|
|
|
Update User Password
Endpoint |
HTTP Method |
|---|---|
|
|
Update User Admin
Endpoint |
HTTP Method |
|---|---|
|
|
Delete User
Endpoint |
HTTP Method |
|---|---|
|
|
List Users
Endpoint |
HTTP Method |
|---|---|
|
|
Get Current User
Endpoint |
HTTP Method |
|---|---|
|
|
Grant User Permission
Endpoint |
HTTP Method |
|---|---|
|
|
Revoke User Permission
Endpoint |
HTTP Method |
|---|---|
|
|
Get User Permission
Endpoint |
HTTP Method |
|---|---|
|
|
List User Permissions
Endpoint |
HTTP Method |
|---|---|
|
|
List Current User Permissions
Endpoint |
HTTP Method |
|---|---|
|
|
Create Role
Endpoint |
HTTP Method |
|---|---|
|
|
Get Role
Endpoint |
HTTP Method |
|---|---|
|
|
List Roles
Endpoint |
HTTP Method |
|---|---|
|
|
Update Role
Endpoint |
HTTP Method |
|---|---|
|
|
Delete Role
Endpoint |
HTTP Method |
|---|---|
|
|
Assign Role
Endpoint |
HTTP Method |
|---|---|
|
|
Unassign Role
Endpoint |
HTTP Method |
|---|---|
|
|
Add Role Permission
Endpoint |
HTTP Method |
|---|---|
|
|
Remove Role Permission
Endpoint |
HTTP Method |
|---|---|
|
|
List Role Permissions
Endpoint |
HTTP Method |
|---|---|
|
|
Update Role Permission
Endpoint |
HTTP Method |
|---|---|
|
|
List User Roles
Endpoint |
HTTP Method |
|---|---|
|
|
Response Structure
Field Name |
Type |
Description |
|---|---|---|
roles |
An array of Role |
List of roles assigned to user. |
List Role Users
Endpoint |
HTTP Method |
|---|---|
|
|
Skill Registry Response Permissions
When authentication is enabled, parent skill responses include an optional
allowed_actions field for non-admin users. This array of strings contains the
actions the current user can perform on that skill in its workspace.
The field is included in responses from these endpoints. Paths are relative to
/api/3.0/mlflow/skills.
Method |
Path |
Field location |
|---|---|---|
|
Base path |
Parent skill object |
|
Base path |
Each parent skill object in |
|
|
Parent skill object |
Possible values are USE, UPDATE, DELETE, and MANAGE. For example,
a user with EDIT permission receives "allowed_actions": ["USE", "UPDATE"].
A user with READ permission receives "allowed_actions": []. Read access
is implicit in a successful response; there is no READ action in this array.
The field is omitted for admins and when authentication is disabled. An omitted field is different from an empty array: an empty array indicates read-only access. Skill version responses do not include this field. The server continues to enforce permissions on each request.
Data Structures
User
Field Name |
Type |
Description |
|---|---|---|
id |
|
User ID. |
username |
|
Username. |
is_admin |
|
Whether the user is an admin. |
roles |
An array of Role |
Roles assigned to the user. |
Note
The roles field is only included in the response from
users/list. It is not present when calling users/get
or users/current. The users/current endpoint also
includes an additional is_basic_auth boolean field.