Waiting for engine...
Skip to main content

Account User Role object

The Account User Role object represents the linkage between an user, the user's account, and a defined role for the account.

Structure​

<AccountUserRole id="" accountId="" userId="" roleId="" notifyUser="" firstName="" lastName=""/>
FieldTypeDescription
idstringThe object’s conceptual ID, which is synthesized from the role, user, and account IDs.
accountIdstringThe account ID.
userIdstringThe user ID.
roleIdstringThe ID of the role.
notifyUserstringIf true, which is the default, the system sends an email to the user after adding them to the account.
firstNamestringThe first name of a user in the account.
lastNamestringThe last name of a user in the account.

Supported operations​

GETQUERYCREATEUPDATEEXECUTEDELETE
Not Supported Supported  Supported Not SupportedNot Supported Supported 

Notes:

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

    FieldAllowed values
    userIdAny string value.

    The operators allowed for the Account 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. If you provide a user ID (email address) that does not exist, the system creates the user and adds them to the account.

    When creating a new user, the API request does not require the firstName and lastName fields. If you do not provide those fields, it assigns the default firstName or lastName values automatically. If you include the firstName and lastName fields in a CREATE request for a user name that exists, the request ignores those fields.

  • The DELETE operation removes the specified user by a specified conceptual Account User Role object ID from an account.

SOAP implementation​

  • QUERY operation

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

    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>
             <!--Optional:-->
             <api:objectType>AccountUserRole</api:objectType>
             <!--Optional:-->
             <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="2">
                <bns:result xsi:type="bns:AccountUserRole" roleId="01234567-89ab-cdef-0123-456789abcdef" userId="user123@company.biz" accountId="account-123456" id="Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg" firstName="John" lastName="Doe"/>
                <bns:result xsi:type="bns:AccountUserRole" roleId="fedcba98-7654-3210-fedc-ba9876543210" userId="user123@company.biz" accountId="account-123456" id="gAb0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1H" 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:AccountUserRole" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" accountId="account-123456" 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:AccountUserRole" roleId="01234567-89ab-cdef-0123-456789abcdef" userId="user123@company.biz" accountId="account-123456" 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>AccountUserRole</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>

On this Page