Użytkownicy

  • routy:
    /routes/vendor/icore/api/users.php
  • kontrolery:
    N1ebieski\ICore\Http\Controllers\Api\UserController
  • resource:
    N1ebieski\ICore\Http\Resources\User\UserResource


# Uprawnienia:

  • api.* - dostęp do wszystkich endpointów
  • api.users.* - dostęp do wszystkich endpointów użytkowników
  • api.users.view - dostęp do endpointu listy użytkowników


# GET, POST - /api/users/index

Wyświetla listę użytkowników.

Dostępne wyłącznie dla użytkowników z uprawnieniem: api.users.view oraz admin.users.view.

Request body:

  • page - integer, opcjonalny - stronicowanie
  • filter - array, opcjonalny - filtrowanie:
    • except - array zawierający ID, wykluczenie rekordów z listy
    • search - string, wyszukiwanie po haśle
    • status - integer, 1 - aktywne, 0 - nieaktywne (dostępne wyłącznie dla uprawnienia admin.users.view)
    • role - integer zawierający ID roli
    • orderby - string, sortowanie, dostępne: created_at|asc, created_at|desc, updated_at|asc, updated_at|desc
    • paginate - integer, ilość rekordów na liście, dostępne: 25, 50, 100


Response:

  • data[ ]:
    • id - integer
    • name - string
    • ip - string, (dostępne wyłącznie dla uprawnienia admin.users.view)
    • email - string, (dostępne wyłącznie dla uprawnienia admin.users.view, oraz właściciela rekordu)
    • status:
      • value - integer
      • label - string
    • marketing - (dostępne wyłącznie dla uprawnienia admin.users.view):
      • value - integer, zgoda na mailing
      • label - string
    • real_depth - integer, poziom w hierarchii
    • created_at - datetime
    • created_at_diff - string
    • updated_at - datetime
    • updated_at_diff - string
    • roles - array zawierający role
    • socialites - array zawierający podpięte logowania przez konta społecznościowe, (dostępne wyłącznie dla uprawnienia admin.users.view, oraz właściciela rekordu)
  • links - linki do zasobu
  • meta - informacje dotyczące stronicowania, filtrowania i sortowania