Account Group User Role object

The Account Group User Role object represents the linkage between an user, an account group, and a defined role for the primary account.

Structure

<AccountGroupUserRole roleId="" userId="" accountGroupId="" notifyUser="" id="" firstName="" lastName""/>

Field	Type	Description
roleId	string	The ID of the role.
userId	string	The user ID.
accountGroupId	string	The ID of the account group.
notifyUser	boolean	If true, which is the default, users receive an email notification when adding them to the account group.
id	string	The object’s conceptual ID, which is synthesized from the role, user, and account group IDs.
firstName	string	The first name of the user.
lastName	string	The last name of the user.

Supported operations

GET	QUERY	CREATE	UPDATE	EXECUTE	DELETE
Not supported	Supported	Supported	Not supported	Not supported	Supported

Notes:

You can use the following fields as QUERY filters for the Account Group User Role object:

Field Allowed values
userId Any string value.
accountGroupId Any string value.

The operators allowed for the Account Group User Role object filters are:
- EQUALS
- LIKE
- NOT_EQUALS
- IS_NULL
- IS_NOT_NULL
- BETWEEN
- GREATER_THAN
- GREATER_THAN_OR_EQUAL
- LESS_THAN
- LESS_THAN_OR_EQUAL
For general information about the structure of QUERY filters and how to handle paged results, see the Query filters and Query paging topics.
The CREATE operation adds a user to an account group.

Users must log in to the before adding them to an account group.
The DELETE operation removes the user from an account group specified by the conceptual Account Group User Role object ID.

Field	Allowed values
`userId`	Any string value.
`accountGroupId`	Any string value.

note

To facilitate these operations on this object in an integration process, use the Boomi Enterprise Platform Partner API connector instead of the Boomi Enterprise Platform API connector.

SOAP implementation

QUERY operation

The following example query returns the Account Group User Role objects for the user whose ID is user123@company.bi z.

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
   <soapenv:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
            <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
</soapenv:Header>
   <soapenv:Body>
      <api:query>
         <api:objectType>AccountGroupUserRole</api:objectType>
         <api:queryConfig>
            <api:QueryFilter>
               <api:expression operator="EQUALS" property="userId"
                 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                  <api:argument>user123@company.biz</api:argument>
               </api:expression>
            </api:QueryFilter>
         </api:queryConfig>
      </api:query>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <bns:queryResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <bns:results numberOfResults="1">
            <bns:result xsi:type="bns:AccountGroupUserRole" roleId="01234567-89ab-cdef-0123-456789abcdef" userId="user123@company.biz" accountGroupId="fedcba98-7654-3210-fedc-ba9876543c210" id="Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg firstName="John" lastName="Doe""/>
         </bns:results>
      </bns:queryResponse>
   </S:Body>
</S:Envelope>

CREATE operation

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
   <soapenv:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
         <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
            <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
            <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
         </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <api:create>
         <object xsi:type="api:AccountGroupUserRole" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" accountGroupId="fedcba98-7654-3210-fedc-ba9876543c210" userId="user123@company.biz" roleId="01234567-89ab-cdef-0123-456789abcdef" firstName="John" lastName="Doe">
        </object>
       </api:create>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <bns:createResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <bns:result xsi:type="bns:AccountGroupUserRole" roleId="01234567-89ab-cdef-0123-456789abcdef" userId="user123@company.biz" accountGroupId="fedcba98-7654-3210-fedc-ba9876543c210" id="Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg" firstName="John" lastName="Doe"/>
      </bns:createResponse>
   </S:Body>
</S:Envelope>

DELETE operation

Request:

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:api="http://api.platform.boomi.com/">
   <soapenv:Header>
      <wsse:Security
       xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd">
        <wsse:UsernameToken wsu:Id="UsernameToken" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
          <wsse:Username>ATOMSPHERE_USER_NAME</wsse:Username>
          <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">ATOMSPHERE_PASSWORD</wsse:Password>
        </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <api:delete>
         <!--Optional:-->
         <objectType>AccountGroupUserRole</objectType>
         <!--Optional:-->
         <objectId>Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg</objectId>
      </api:delete>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
   <S:Body>
      <bns:deleteResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
         <bns:successful>true</bns:successful>
      </bns:deleteResponse>
   </S:Body>
</S:Envelope>

Structure​

Supported operations​

SOAP implementation​

Structure

Supported operations

SOAP implementation