...
Panel | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
This topic is discussed in the "Grouper API - Part 2" training video. |
Subpages:
Children Display |
---|
GrouperShell (gsh)
gsh is a command line shell for administering and interacting with the Grouper API. See architectural diagram. It can be used in both a batch and interactive manner. For Grouper 2.3.0 patch 72+, it is built on GroovyShell. For older versions of Grouper, it is built on Java BeanShell. The legacy BeanShell version is now deprecated, but you can switch back to it by using one of the options:
...
No Format |
---|
gsh 0% GrouperSession.startRootSession(); gsh 0% subj = findSubject("SD00125") subject: id='SD00125' type='person' source='kitn-person' name='Barton, Tom' gsh 1% sess = GrouperSession.start(subj) edu.internet2.middleware.grouper.GrouperSession: 29c40f97-9fb0-4e45-88bc-a14877a6c9b5,'SD00125','person' gsh 2% member = MemberFinder.findBySubject(sess, subj) member: id='SD00125' type='person' source='kitn-person' uuid='d0fa765e-1439-4701-89b1-9b08b4ce9daa' gsh 3% member.getGroups() group: name='etc:sysadmingroup' displayName='Grouper Administration:SysAdmin Group' uuid='6f77fb36-b466-481a-84a7-7af609f1ad09' |
GrouperSessions
Group insert / update / delete
Groups
Command | Description |
---|---|
addGroup(parent stem name, extension, displayExtension) | Add group to registry |
delGroup(name) | Delete group from registry |
getGroupAttr(group name, attr) | Get value of group attribute |
getGroups(name) | Find all groups with a matching naming attribute value, returns a Set of groups When using Java 1.8+ and Grouper 2.3 (later patches)+ this can be handy to print the group.getName() values for all groups that are found. getGroups("Wheel").each{it -> println "${it.getName()}"} |
setGroupAttr(group name, attr, value) | Set value of group attribute |
GroupFinder.findByName(grouperSession, name) | Find one group by name |
GroupFinder.findByUuid(grouperSession, name) | Find one group by uuid |
...