You are here

SkyVault 2.0 » Developer guide » API guide » Reference » JavaScript API » Services API » Authority service

ScriptGroup object

A ScriptGroup object represents a SkyVault group.

Properties

authorityType
Get or set the authority type
allGroups
Gets all descendant subgroups
allUsers
Gets the users contained within this group and its subgroups
childUsers
Gets child users of this group
displayName
Get or set the display name for this group (requires administrator permission)
fullName
Get or set the full name of the group
shortName
Get or set the short name of the group
  • addAuthorityaddAuthority(fullAuthorityName) adds an existing authority as a child of this group.
  • createGroupcreateGroup(shortName, displayName) creates a new group as a child of this group.
  • deleteGroupdeleteGroup() deletes this group.
  • getAllGroupsgetAllGroups() returns all descendant groups of this group.
  • getAllParentGroups The getAllParentGroups() methods return all parent groups of this group.
  • getAllUsersgetAllUsers() returns all users contained in this group.
  • getChildAuthorities The getChildAuthorities(...) methods return the child authorities (users and groups) of this group.
  • getChildGroups The getChildGroups() methods return child groups of this group.
  • getChildUsers The getChildUsers(...) methods get the child users of this group.
  • getGroupCountgetGroupCount() returns the number of child groups contained within this group.
  • getGroupNodegetGroupNode() returns a script node object wrapping this group.
  • getParentGroups The getParentGroups() methods return the immediate parent groups of this group.
  • getUserCountgetUserCount() returns the number of users within this group.
  • getZonesgetZones() returns a set of zone names for this group. Zones provide a higher level way of organizing groups.
  • removeAuthorityremoveAuthority(fullAuthorityName) removes a child authority from this group.
  • removeGroupremoveGroup(shortName) removes a specified subgroup from this group. It does not delete the subgroup or its members.
  • removeUser The removeUser(shortName) removes a specified child user from this group. It does not delete the user.
Parent topic: Authority service

© 2017 TBS-LLC. All Rights Reserved.