elidactyl v0.1.0 Elidactyl.Users

This module is responsible for listing and modifying Pterodactyl users.

Link to this section Summary

Link to this section Functions

Link to this function

create_user(params)

Specs

create_user(map()) :: %Elidactyl.User{
  "2fa": term(),
  created_at: term(),
  email: term(),
  external_id: term(),
  first_name: term(),
  id: term(),
  language: term(),
  last_name: term(),
  password: term(),
  root_admin: term(),
  updated_at: term(),
  username: term(),
  uuid: term()
}
Link to this function

delete_user(id)

Specs

delete_user(binary() | integer()) :: :ok
Link to this function

edit_user(id, params)

Specs

edit_user(binary() | integer(), map()) :: %Elidactyl.User{
  "2fa": term(),
  created_at: term(),
  email: term(),
  external_id: term(),
  first_name: term(),
  id: term(),
  language: term(),
  last_name: term(),
  password: term(),
  root_admin: term(),
  updated_at: term(),
  username: term(),
  uuid: term()
}
Link to this function

get_user_by_external_id(id)

Specs

get_user_by_external_id(binary() | integer()) :: %Elidactyl.User{
  "2fa": term(),
  created_at: term(),
  email: term(),
  external_id: term(),
  first_name: term(),
  id: term(),
  language: term(),
  last_name: term(),
  password: term(),
  root_admin: term(),
  updated_at: term(),
  username: term(),
  uuid: term()
}
Link to this function

get_user_by_id(id)

Specs

get_user_by_id(binary() | integer()) :: %Elidactyl.User{
  "2fa": term(),
  created_at: term(),
  email: term(),
  external_id: term(),
  first_name: term(),
  id: term(),
  language: term(),
  last_name: term(),
  password: term(),
  root_admin: term(),
  updated_at: term(),
  username: term(),
  uuid: term()
}

Specs

list_users() ::
  {:ok,
   [
     %Elidactyl.User{
       "2fa": term(),
       created_at: term(),
       email: term(),
       external_id: term(),
       first_name: term(),
       id: term(),
       language: term(),
       last_name: term(),
       password: term(),
       root_admin: term(),
       updated_at: term(),
       username: term(),
       uuid: term()
     }
   ]}
  | {:error, %Elidactyl.Error{details: term(), message: term(), type: term()}}

Request all users from server.