grouper-dev - get attribute assignments web service
Subject: Grouper Developers Forum
List archive
- From: Chris Hyzer <>
- To: Grouper Dev <>
- Subject: get attribute assignments web service
- Date: Fri, 9 Apr 2010 02:53:36 -0400
- Accept-language: en-US
- Acceptlanguage: en-US
Hey,
I made a "get attribute assignments" web service for Grouper 1.6.
https://spaces.internet2.edu/display/GrouperWG/v1.6.0+Get+Attribute+Assignments
Here are the client instructions:
getAttributeAssignmentsWs web service usage:
java -jar grouperClient.jar --operation=getAttributeAssignmentsWs
--attributeAssignType=group|member|stem|any_mem|imm_mem|attr_def
[--includeAssignmentsOnAssignments=T|F] [--attributeDefNames=a:b,b:c]
[--attributeDefUuids=1a,2b] [--attributeDefNameNames=a:b,b:c]
[--attributeDefNameUuids=1a,2b] [--ownerAttributeDefNames=a:b,b:c]
[--ownerAttributeDefUuids=1a,2b] [--ownerGroupNames=a:b:c,a:b:d]
[--ownerGroupUuids=1234,abcd] [--owner0SubjectId=subjId0]
[--owner0SubjectIdentifier=subjIdent0] [--owner0SubjectSource=source0]
[--ownerMembershipUuids=abc,bcd] [--ownerStemNames=a:b,b:c]
[--ownerStemUuids=1a,2b] [--ownerMembershipAny0SubjectId=12]
[--ownerMembershipAny0SubjectIdentifier=ab]
[--ownerMembershipAny0SourceId=xyz] [--ownerMembershipAny0GroupName=3c]
[--ownerMembershipAny0GroupUuid=1a] [--attributeAssignUuids=a:b,b:c]
[--enabled=A|T|F] [--actions=read,write] [--includeGroupDetail=true|false]
[--includeSubjectDetail=true|false] [--subjectAttributeNames=name0,name1]
[--actAsSubjectId=subjId] [--actAsSubjectIdentifier=subjIdent]
[--actAsSubjectSource=source] [--saveResultsToFile=fileName]
[--outputTemplate=somePattern] [--paramName0=name0] [--paramValue0=value1]
[--paramNameX=xthParamName] [--paramValueX=xthParamValue] [--debug=true]
[--clientVersion=someVersion]
e.g.: java -jar grouperClient.jar --operation=getAttributeAssignmentsWs
--attributeAssignType=group
--attributeDefNames=test:testAttributeAssignDefNameDef
output line: Index: 0: attributeAssignType: group, owner:
test:groupTestAttrAssign, attributeDefName test:testAttributeAssignDefName,
action: assign, values: 15,5,5, enabled: T, id:
a9c83eeb78c04ae5befcea36272d318c
###############################
web service docs:
###############################
Description
Get attribute assignments. These attributes can be on groups, stems,
members, memberships (immediate or any), or attribute definitions. If you
want to retrieve attribute assignments assigned to other attributes, then
pass a flag to the assignment lookup to include assignments on the returned
assignments.
You can lookup attributes by attribute definition, attribute definition name,
attribute assign id, or the owner lookup (e.g. group name or stem uuid).
All returned attribute assignments will be filtered for security based on the
logged in or acted as user (security rules are on attribute framework wiki)
The returned data will include the attribute assignments, value(s) on those
assignments, and a normalized list of references (owner objects e.g.
group/stem/etc, attribute definitions, attribute names, etc)
You can lookup assignments by multiple owners, definitions, etc
Features
* Can base attribute assign list based on action, active, etc
* Lookup owner or other objects by object lookup (by id, name, etc)
* Returns group / subject information, can be detailed or not
* Can actAs another user
Get attribute assignments lite service
* Accepts one group, or one subject, or stem, etc to get attribute
assignments for
* Documentation: SOAP (click on getAttributeAssignmentsLite), REST (click
on getAttributeAssignmentsLite)
* For REST, the request can put data in query string (in URL or request
body)
* REST request (colon is escaped to %3A):
o GET /grouper-ws/servicesRest/v1_6_000/attributeAssignments
o Note: if passing data in request body e.g. actAs, use a POST
* (see documentation above for details): Request object, response object
* Response codes
* Samples (all files with "Lite" in them, click on "download" to see file)
Get attribute assignments service
* Accepts multiple groups or subjects or memberhipIds (or combination)
etc to retrieve lists of attribute assignments
* Documentation: SOAP (click on getAttributeAssignments), REST (click on
getAttributeAssignments)
* REST request (colon is escaped to %3A):
o POST /grouper-ws/servicesRest/v1_6_000/attributeAssignments
* (see documentation above for details): Request object, response object
* Response codes overall
* Returns an overall status
* Samples (all files without "Lite" in them, click on "download" to see
files)
Regards,
Chris
- get attribute assignments web service, Chris Hyzer, 04/09/2010
Archive powered by MHonArc 2.6.16.