Editing/EditACLs

NAME
    EditACLs - manage the access control lists for a LUMP structural unit

DESCRIPTION
    The EditACLs CGI script allows the access control lists (ACLs) for a
    LUMP Structural Unit to be managed.

PARAMETERS
  Standard
    *username* - Name of user running this CGI script. Required unless web
    server authentication is in use (when it is, the web server
    authenticated user is used instead).
    *password* - Password for the user. This is only required if the web
    server is not handling the user authentication and if no security hash
    parameter is being given.
    *security_hash* - An opaque value used to authenticate the user without
    requiring the password to be sent. This value is generated by a previous
    execution of a LUMP API script and may well be time limited. It is only
    required if no password or webserver authentication is done.
    *act_as* - Users in the SysAdmins group can elect to act on the behalf
    of other users once they are themselves authenticated. If this parameter
    is present it should contain the username of the user that should be
    switched to if this option is available and the real user has been
    authenticated successfully. Optional.
    *session_id* - An opaque string as far as the server is concerned that
    is intended solely to allow async clients to differentiate different
    results more easily. Optional.

  Specific for this script
    *operation* - The operation requested on the ACLs. Defaults to "addacl"
    if not given. Valid operations are "addacl" (add an ACL), "removeacl"
    (Remove an ACL from the system), "listuseracls" (list ACLs for the given
    Structural Unit for the given *acl_username*), "listusergroupacls" (list
    ACLs for the given Structural Unit for the user group given by the
    *user_group_id* parameter) and "listallacls" (list all the ACLs for the
    given Structural Unit).
    *suid* - The ID of the Structural Unit that the ACLs apply to. Required.
    *aclid* - The ID of a specific ACL. Required unless creating a new ACL.
    *user_group_id* - ID of a user group associated with an ACL.
    *acl_username* - Username associated with the ACL.
    *use_defaults* - If specified use the ACL Defaults to create an ACL.
    *edit* - Set the ACL edit field. Should be either 'Y' to allow editing
    or 'N' to disallow it. Not required if use_defaults is in effect.
    *view* - Set the ACL view field. Should be either 'Y' to allow viewing
    or 'N' to disallow it. Not required if use_defaults is in effect.

RESULTS
    For the "removeacl" operation, the <returns> section of the XML result
    is empty and the <error_code> is used to indicate success or failure of
    the operation. For all other operations, a sucessful result will also
    return a list of ACLs (including the ACL just created in the case of the
    "addacl" operation).

SEE ALSO
    GetStructuralUnit

    FindSuid

    LUMP-XML-Response

COPYRIGHT
    Copyright 2009 Loughborough University Library <library@lboro.ac.uk>.

    Permission is granted to copy, distribute and/or modify this document
    under the terms of the GNU Free Documentation License, Version 1.2 or
    any later version published by the Free Software Foundation; with no
    Invariant Sections, with no Front-Cover Texts, and with no Back-Cover
    Texts.
Go to Top