RT 3.8.17 Documentation

RT::Principal Overlay

Go to latest version →

IsGroup

Returns true if this principal is a group. Returns undef, otherwise

IsUser

Returns true if this principal is a User. Returns undef, otherwise

Object

Returns the user or group associated with this principal

GrantRight { Right => RIGHTNAME, Object => undef }

A helper function which calls RT::ACE->Create

   Returns a tuple of (STATUS, MESSAGE);  If the call succeeded, STATUS is true. Otherwise it's 
   false.

RevokeRight { Right => "RightName", Object => "object" }

Delete a right that a user has

   Returns a tuple of (STATUS, MESSAGE);  If the call succeeded, STATUS is true. Otherwise it's 
      false.

sub CleanupInvalidDelegations { InsideTransaction => undef }

Revokes all ACE entries delegated by this principal which are inconsistent with this principal's current delegation rights. Does not perform permission checks, but takes no action and returns success if this principal still retains DelegateRights. Should only ever be called from inside the RT library.

If this principal is a group, recursively calls this method on each cached user member of itself.

If called from inside a transaction, specify a true value for the InsideTransaction parameter.

Returns a true value if the deletion succeeded; returns a false value and logs an internal error if the deletion fails (should not happen).

sub HasRight (Right => 'right' Object => undef)

Checks to see whether this principal has the right "Right" for the Object specified. If the Object parameter is omitted, checks to see whether the user has the right globally.

This still hard codes to check to see if a user has queue-level rights if we ask about a specific ticket.

This takes the params:

    Right => name of a right

    And either:

    Object => an RT style object (->id will get its id)

Returns 1 if a matching ACE was found.

Returns undef if no ACE was found.

_HasRight

Low level HasRight implementation, use HasRight method instead.

RolesWithRight

Returns list with names of roles that have right on set of objects. Takes Right, EquiveObjects, IncludeSystemRights and IncludeSuperusers arguments.

IncludeSystemRights is true by default, rights granted on system level are not accouned when option is set to false value.

IncludeSuperusers is true by default, SuperUser right is not checked if it's set to false value.

← Back to index