Package nzilbb.labbcat.server.api.admin

Class Users

  • @RequiredRole("admin")
public class Users
extends TableServletBase
    /api/admin/users[/user] : Administration of user records.

    Allows administration (Create/Read/Update/Delete) of users records (including roles) via JSON-encoded objects with the following attributes:

    user
    ID of the user.
    email
    Email address of the user.
    resetPassword
    Whether the user is flagged to reset their password the next time they log in.
    roles
    An array of strings, which are the roles or groups the user belongs to.
    _cantDelete
    This is not a database field, but rather is present in records returned from the server that can not currently be deleted; a string representing the reason the record can't be deleted.

    The following operations, specified by the HTTP method, are supported:

    POST
    Create a new record.
    • Request Body - a JSON-encoded object representing the new record (excluding mediaTrack_id).
    • Response Body - the standard JSON envelope, with the model as an object representing the new record (including mediaTrack_id).
    • Response Status
      • 200 : The record was successfully created.
      • 409 : The record could not be added because it was already there.
    GET
    Read the records.
    • Parameters
      • pageNumber (integer) : The (zero-based) page to return.
      • pageLength (integer) : How many rows per page (default is 20).
      • Accept (string) : Equivalent of the "Accept" request header (see below).
    • "Accept" request header/parameter "text/csv" to return records as Comma Separated Values. If not specified, records are returned as a JSON-encoded array of objects.
    • Response Body - the standard JSON envelope, with the model as a corresponding list of records.
    • Response Status
      • 200 : The records could be listed.
    PUT
    Update an existing record, specified by the mediaTrack given in the request body.
    • Request Body - a JSON-encoded object representing the record.
    • Response Body - the standard JSON envelope, with the model as an object representing the record.
    • Response Status
      • 200 : The record was successfully updated.
      • 404 : The record was not found.
    DELETE
    Delete an existing record.
    • Request Path - /api/admin/users/user where user is the user ID of the user to delete.
    • Response Body - the standard JSON envelope, including a message if the request succeeds or an error explaining the reason for failure.
    • Response Status
      • 200 : The record was successfully deleted.
      • 400 : No user was specified in the URL path, or the record exists but could not be deleted.
      • 404 : The record was not found.

    Author:
    Robert Fromont robert@fromont.net.nz

    • Constructor Detail

      • Users

        public Users()