GroupInfo

Description

The GroupInfo type holds the name and other information about a group in SBM. The GroupInfo type parameters are listed below.

Parameters

Name Type Description
id GroupIdentifier Contains the complete identification information for a group.
accessType AccessType Shows the group's product-access type.
memo string Contains the contents of the group's memo field.
isDeleted boolean Specify true to delete a group during UpdateGroups. The default is false. When returned in the response, it indicates whether or not the group is marked as deleted.

Usage

The GroupInfo type provides complete information about a group in SBM. Use GetGroups to retrieve a list of attributes for a desired group.

XML

The following XML snippet shows the GroupInfo type in the group argument of the CreateGroups call.

<urn:group>
  <urn:id>
     <urn:displayName>New_Group1</urn:displayName>
     <urn:id></urn:id>
     <urn:uuid></urn:uuid>
  </urn:id>
  <urn:accessType>ACCESS-USER</urn:accessType>
  <urn:memo>This group contains regular users.</urn:memo>
  <urn:isDeleted></urn:isDeleted>
</urn:group>

The following XML snippet shows the GroupInfo type in the return element of the GetGroups response.

<ae:return>
  <ae:group>
     <ae:id xsi:type="ae:GroupIdentifier">
        <ae:displayName>New_Group1</ae:displayName>
        <ae:id>18</ae:id>
        <ae:uuid>cb90f9de-5cc8-4056-bbc6-29caf39bd047</ae:uuid>
     </ae:id>
     <ae:accessType>ACCESS-USER</ae:accessType>
     <ae:memo>This group contains regular users.</ae:memo>
     <ae:isDeleted>false</ae:isDeleted>
  </ae:group>
</ae:return>