Waiting for engine...
Skip to main content

Account User Federation object

The Account User Federation object represents the linkage between an user enabled for single sign-on, an account used by that user, and the user's federation ID. The implementation of single sign-on with SAML uses unique federation IDs to identify users.

Structure​

<AccountUserFederation federationId="" userId="" accountId="" id=""/>
FieldTypeDescription
FilterFilterFilter
federationIdstringThe federation ID uniquely identifies the user.
userIdstringThe user ID.
accountIdstringThe account ID.
idstringThe object’s conceptual ID, which is synthesized from the federation, user, and account IDs.

Supported operations​

GETQUERYCREATEUPDATEEXECUTEDELETE
Not supportedSupportedSupportedSupportedSupported

Notes:

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

    FieldAllowed values
    federationIdAny string value.

    The operators allowed for the Account User Federation 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 enables single sign-on for a specific user under a specific account using a specific federation ID. The user is not visible in the Setup page unless you assign one or more roles to that user.

  • The UPDATE operation updates the federation ID of a specific user in a specific account.

  • The DELETE operation disables single sign-on for the user specified by the conceptual Account User Federation object ID.

SOAP implementation​

  • QUERY operation

    The following example query returns the Account User Federation object for the user whose federation ID is user123.

    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>AccountUserFederation</api:objectType>
             <api:queryConfig>
                <api:QueryFilter>
                   <api:expression operator="EQUALS" property="federationId"
                     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                      <api:argument>user123</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:AccountUserFederation" federationId="user123" userId="user123@company.biz" accountId="account-123456"  id="Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts"/>
             </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:AccountUserFederation" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
              userId="user123@company.biz" accountId="account-123456" federationId="user123">
            </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:AccountUserFederation" federationId="user123" userId="user123@company.biz" accountId="account-123456" id="Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts"/>
          </bns:createResponse>
       </S:Body>
    </S:Envelope>

  • UPDATE operation

    This example updates the federation ID of the user with the ID user123@company.biz to user456.

    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:update>
                   <object xsi:type="api:AccountUserFederation" federationId="user456"  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" accountId ="account-123456" userId="user123@company.biz"> 
                   </object>
          </api:update>
       </soapenv:Body>
    </soapenv:Envelope>

    Response:

    <S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
       <S:Body>
          <bns:updateResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
             <bns:result xsi:type="bns:AccountUserFederation" federationId="user456" userId="user123@company.biz" accountId="account-123456" id="Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts"/>
          </bns:updateResponse>
       </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>AccountUserFederation</objectType>
             <!--Optional:-->
             <objectId>Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts</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