Adding authentication data structures

Author: pebeto

docs/src/reference/types.md

@@ -18,4 +18,8 @@ Metric
 RunData
 RunInfo
 RunInputs
+User
+Permission
+ExperimentPermission
+RegisteredModelPermission
 ```

src/MLFlowClient.jl

@@ -25,7 +25,7 @@ include("types/tag.jl")
 export Tag
 
 include("types/enums.jl")
-export ViewType, RunStatus, ModelVersionStatus
+export ViewType, RunStatus, ModelVersionStatus, Permission
 
 include("types/dataset.jl")
 export Dataset, DatasetInput
@@ -37,14 +37,17 @@ include("types/model_version.jl")
 export ModelVersion
 
 include("types/registered_model.jl")
-export RegisteredModel, RegisteredModelAlias
+export RegisteredModel, RegisteredModelAlias, RegisteredModelPermission
 
 include("types/experiment.jl")
-export Experiment
+export Experiment, ExperimentPermission
 
 include("types/run.jl")
 export Run, Param, Metric, RunData, RunInfo, RunInputs
 
+include("types/user.jl")
+export User
+
 include("api.jl")
 
 include("utils.jl")

src/types/enums.jl

@@ -50,3 +50,21 @@ View type for ListExperiments query.
     DELETED_ONLY = 2
     ALL = 3
 end
+
+"""
+    Permission
+
+Permission of a user to an experiment or a registered model.
+
+# Members
+- `READ`: Can read.
+- `EDIT`: Can read and update.
+- `MANAGE`: Can read, update, delete and manage.
+- `NO_PERMISSIONS`: No permissions.
+"""
+@enum Permission begin
+    READ = 1
+    EDIT = 2
+    MANAGE = 3
+    NO_PERMISSIONS = 4
+end

src/types/experiment.jl

@@ -24,3 +24,20 @@ Experiment(data::Dict{String,Any}) = Experiment(data["experiment_id"], data["nam
     data["artifact_location"], data["lifecycle_stage"], data["last_update_time"],
     data["creation_time"], [Tag(tag) for tag in get(data, "tags", [])])
 Base.show(io::IO, t::Experiment) = show(io, ShowCase(t, new_lines=true))
+
+"""
+    ExperimentPermission
+
+# Fields
+- `experiment_id::String`: [`Experiment`](@ref) id.
+- `user_id::String`: [`User`](@ref) id.
+- `permission::Permission`: [`Permission`](@ref) granted.
+"""
+struct ExperimentPermission
+    experiment_id::String
+    user_id::String
+    permission::Permission
+end
+ExperimentPermission(data::Dict{String,Any}) = ExperimentPermission(data["experiment_id"],
+    data["user_id"], Permission(data["permission"]))
+Base.show(io::IO, t::ExperimentPermission) = show(io, ShowCase(t, new_lines=true))

src/types/registered_model.jl

@@ -48,3 +48,20 @@ RegisteredModel(data::Dict{String,Any}) = RegisteredModel(data["name"],
     [Tag(tag) for tag in get(data, "tags", [])],
     [RegisteredModelAlias(alias) for alias in get(data, "aliases", [])])
 Base.show(io::IO, t::RegisteredModel) = show(io, ShowCase(t, new_lines=true))
+
+"""
+    RegisteredModelPermission
+
+# Fields
+- `name::String`: [`RegisteredModel`](@ref) name.
+- `user_id::String`: [`User`](@ref) id.
+- `permission::Permission`: [`Permission`](@ref) granted.
+"""
+struct RegisteredModelPermission
+    name::String
+    user_id::String
+    permission::Permission
+end
+RegisteredModelPermission(data::Dict{String,Any}) = RegisteredModelPermission(data["name"],
+    data["user_id"], Permission(data["permission"]))
+Base.show(io::IO, t::RegisteredModelPermission) = show(io, ShowCase(t, new_lines=true))

src/types/user.jl

@@ -0,0 +1,19 @@
+"""
+    User
+
+# Fields
+- `id::String`: User ID.
+- `username::String`: Username.
+- `is_admin::Bool`: Whether the user is an admin.
+- `experiment_permissions::Array{ExperimentPermission}`: All experiment permissions
+    explicitly granted to the user.
+- `registered_model_permissions::Array{RegisteredModelPermission}`: All registered model
+    explicitly granted to the user.
+"""
+struct User
+    id::String
+    username::String
+    is_admin::Bool
+    experiment_permissions::Array{ExperimentPermission}
+    registered_model_permissions::Array{RegisteredModelPermission}
+end