Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • Accepts multiple groups or subjects or membershipIds (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):
    • 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)


Example getting groups with attribute and value assigned

Code Block
[mchyzer@flash pennGroupsClient-2.5.0]$ java -jar grouperClient-2.5.36.jar --operation=getAttributeAssignmentsWs --attributeAssignType=group --attributeDefNameNames=penn:etc:pspng:provision_to --attributeDefValueType=string --value=pspng_oneprod --debug=true
Reading resource: grouper.client.properties, from: /home/mchyzer/grouper/pennGroupsClient-2.5.0/grouper.client.properties
WebService: connecting as user: 'mchyzer'
WebService: connecting to URL: 'https://grouperWs.server.whatever/grouperWs/servicesRest/2.5.36/attributeAssignments'

################ REQUEST START (indented) ###############

POST /grouperWs/servicesRest/2.5.36/attributeAssignments HTTP/1.1
Connection: close
Authorization: Basic xxxxxxxxxxxxxxxx
User-Agent: Jakarta Commons-HttpClient/3.1
Host: grouperWs.server.whatever:-1
Content-Length: 360
Content-Type: text/xml; charset=UTF-8

<WsRestGetAttributeAssignmentsRequest>
  <attributeDefValueType>string</attributeDefValueType>
  <theValue>pspng_oneprod</theValue>
  <attributeAssignType>group</attributeAssignType>
  <wsAttributeDefNameLookups>
    <WsAttributeDefNameLookup>
      <name>penn:etc:pspng:provision_to</name>
    </WsAttributeDefNameLookup>
  </wsAttributeDefNameLookups>
</WsRestGetAttributeAssignmentsRequest>

################ REQUEST END ###############



################ RESPONSE START (indented) ###############

HTTP/1.1 200 OK
Date: Tue, 30 Mar 2021 15:54:49 GMT
Content-Type: application/xml;charset=UTF-8
Transfer-Encoding: chunked
Connection: close
Server: Apache/2.4.6 (CentOS) OpenSSL/1.0.2k-fips
Strict-Transport-Security: max-age=15768000
X-Grouper-resultCode: SUCCESS
X-Grouper-success: T
X-Grouper-resultCode2: NONE

<WsGetAttributeAssignmentsResults>
  <wsAttributeDefs>
    <WsAttributeDef>
      <idIndex>10058</idIndex>
      <extension>provision_to_def</extension>
      <name>penn:etc:pspng:provision_to_def</name>
      <uuid>48c65c683b224378afed66a90d49dbc6</uuid>
      <attributeDefType>type</attributeDefType>
      <multiAssignable>T</multiAssignable>
      <multiValued>F</multiValued>
      <valueType>string</valueType>
      <assignToAttributeDef>F</assignToAttributeDef>
      <assignToAttributeDefAssignment>F</assignToAttributeDefAssignment>
      <assignToEffectiveMembership>F</assignToEffectiveMembership>
      <assignToEffectiveMembershipAssignment>F</assignToEffectiveMembershipAssignment>
      <assignToGroup>F</assignToGroup>
      <assignToGroupAssignment>F</assignToGroupAssignment>
      <assignToImmediateMembership>F</assignToImmediateMembership>
      <assignToImmediateMembershipAssignment>F</assignToImmediateMembershipAssignment>
      <assignToMember>F</assignToMember>
      <assignToMemberAssignment>F</assignToMemberAssignment>
      <assignToStem>F</assignToStem>
      <assignToStemAssignment>F</assignToStemAssignment>
    </WsAttributeDef>
  </wsAttributeDefs>
  <wsAttributeDefNames>
    <WsAttributeDefName>
      <idIndex>12987</idIndex>
      <extension>provision_to</extension>
      <displayExtension>provision_to</displayExtension>
      <description>Defines what provisioners should process a group or groups within a folder</description>
      <displayName>penn:etc:pspng:provision_to</displayName>
      <name>penn:etc:pspng:provision_to</name>
      <uuid>9f861e04cc794ea0bf79c29c0b116f7b</uuid>
      <attributeDefId>48c65c683b224378afed66a90d49dbc6</attributeDefId>
      <attributeDefName>penn:etc:pspng:provision_to_def</attributeDefName>
    </WsAttributeDefName>
  </wsAttributeDefNames>
  <wsAttributeAssigns>
    <WsAttributeAssign>
      <disallowed>F</disallowed>
      <attributeAssignActionType>immediate</attributeAssignActionType>
      <attributeAssignDelegatable>FALSE</attributeAssignDelegatable>
      <attributeAssignActionId>549beae5b8ea4ecb9f9a4c445c86f62a</attributeAssignActionId>
      <attributeAssignActionName>assign</attributeAssignActionName>
      <attributeAssignType>group</attributeAssignType>
      <attributeDefNameId>9f861e04cc794ea0bf79c29c0b116f7b</attributeDefNameId>
      <attributeDefNameName>penn:etc:pspng:provision_to</attributeDefNameName>
      <attributeDefId>48c65c683b224378afed66a90d49dbc6</attributeDefId>
      <attributeDefName>penn:etc:pspng:provision_to_def</attributeDefName>
      <wsAttributeAssignValues>
        <WsAttributeAssignValue>
          <id>dcd4643ba58b4411bd7831d82c67e810</id>
          <valueSystem>pspng_oneprod</valueSystem>
        </WsAttributeAssignValue>
      </wsAttributeAssignValues>
      <createdOn>2018/10/10 14:14:03.421</createdOn>
      <enabled>T</enabled>
      <id>34664c9fd43140839184e061f1ad17db</id>
      <lastUpdated>2018/10/10 14:14:03.421</lastUpdated>
      <ownerGroupId>c1c03f104f34446a802358e5d763ce76</ownerGroupId>
      <ownerGroupName>penn:isc:ait:apps:O365:twoStepProd:o365_two_step_prod</ownerGroupName>
    </WsAttributeAssign>
    <WsAttributeAssign>
      <disallowed>F</disallowed>
      <attributeAssignActionType>immediate</attributeAssignActionType>
      <attributeAssignDelegatable>FALSE</attributeAssignDelegatable>
      <attributeAssignActionId>549beae5b8ea4ecb9f9a4c445c86f62a</attributeAssignActionId>
      <attributeAssignActionName>assign</attributeAssignActionName>
      <attributeAssignType>group</attributeAssignType>
      <attributeDefNameId>9f861e04cc794ea0bf79c29c0b116f7b</attributeDefNameId>
      <attributeDefNameName>penn:etc:pspng:provision_to</attributeDefNameName>
      <attributeDefId>48c65c683b224378afed66a90d49dbc6</attributeDefId>
      <attributeDefName>penn:etc:pspng:provision_to_def</attributeDefName>
      <wsAttributeAssignValues>
        <WsAttributeAssignValue>
          <id>4fb1e45bcfd44b45bfa4acfcdd0f6b2b</id>
          <valueSystem>pspng_oneprod</valueSystem>
        </WsAttributeAssignValue>
      </wsAttributeAssignValues>
      <createdOn>2020/12/21 12:42:41.950</createdOn>
      <enabled>T</enabled>
      <id>0627aae21b2e4df3920ff06bfd77335c</id>
      <lastUpdated>2020/12/21 12:42:41.950</lastUpdated>
      <ownerGroupId>dbfa18c3-a025-47b6-a9a0-be5ac02e8270</ownerGroupId>
      <ownerGroupName>test:testGroup</ownerGroupName>
    </WsAttributeAssign>
  </wsAttributeAssigns>
  <resultMetadata>
    <resultCode>SUCCESS</resultCode>
    <resultMessage>, Found 2 results.  </resultMessage>
    <success>T</success>
  </resultMetadata>
  <responseMetadata>
    <resultWarnings></resultWarnings>
    <millis>108</millis>
    <serverVersion>2.5.44</serverVersion>
  </responseMetadata>
  <wsGroups>
    <WsGroup>
      <extension>o365_two_step_prod</extension>
      <typeOfGroup>group</typeOfGroup>
      <displayExtension>o365_two_step_prod</displayExtension>
      <description>This group identifies users who have o365 two-step enabled.  Note, it might be because they are required or it might be because they opted in or someone assigned them.</description>
      <displayName>penn:isc:ait:apps:O365:twoStepProd:o365_two_step_prod</displayName>
      <name>penn:isc:ait:apps:O365:twoStepProd:o365_two_step_prod</name>
      <uuid>c1c03f104f34446a802358e5d763ce76</uuid>
      <idIndex>346899</idIndex>
      <enabled>T</enabled>
    </WsGroup>
    <WsGroup>
      <extension>testGroup</extension>
      <typeOfGroup>group</typeOfGroup>
      <displayExtension>testGroup</displayExtension>
      <description>testGroup</description>
      <displayName>test:testGroup</displayName>
      <name>test:testGroup</name>
      <uuid>dbfa18c3-a025-47b6-a9a0-be5ac02e8270</uuid>
      <alternateName>testdd:testGroupdd</alternateName>
      <idIndex>197979</idIndex>
      <enabled>T</enabled>
    </WsGroup>
  </wsGroups>
  <wsStems/>
  <wsMemberships/>
  <wsSubjects/>
</WsGetAttributeAssignmentsResults>

################ RESPONSE END ###############


Output template: Index: ${index}: attributeAssignType: ${wsAttributeAssign.attributeAssignType}, owner: ${ownerName}, attributeDefNameName: ${wsAttributeDefName.name}, action: ${wsAttributeAssign.attributeAssignActionName}, values: ${valuesString}, enabled: ${wsAttributeAssign.enabled}, id: ${wsAttributeAssign.id}, available variables: wsGetAttributeAssignmentsResults, grouperClientUtils, index, wsAttributeAssignment
Index: 0: attributeAssignType: group, owner: penn:isc:ait:apps:O365:twoStepProd:o365_two_step_prod, attributeDefNameName: penn:etc:pspng:provision_to, action: assign, values: pspng_oneprod, enabled: T, id: 34664c9fd43140839184e061f1ad17db
Index: 1: attributeAssignType: group, owner: test:testGroup, attributeDefNameName: penn:etc:pspng:provision_to, action: assign, values: pspng_oneprod, enabled: T, id: 0627aae21b2e4df3920ff06bfd77335c
Elapsed time: 943ms
[mchyzer@flash pennGroupsClient-2.5.0]$