Environment Connection Field Extension Summary object

You can use the Environment Connection Field Extension Summary object to obtain the URL for OAuth 2.0 access token generation.

Through the Environment Extensions endpoint, you can programmatically set almost all extensible connection fields for those used in processes attached to environments. The only current exception is the accessToken field in a connection that uses OAuth 2.0 authentication. You can obtain the URL for OAuth 2.0 access token generation using a QUERY operation on the Environment Connection Field Extension Summary object.

From the time you generate it, the URL returned by the operation is valid for up to 15 minutes only.

Structure

<EnvironmentConnectionFieldExtensionSummary processId="" id="" connectionId="" extensionGroupId="" environmentId="">
   <field oauth2AuthorizationUrl="" componentOverride="" usesEncryption="" encryptedValueSet="" id=""/>
</EnvironmentConnectionFieldExtensionSummary>

Field	Type	Description
processId	string	The ID of the process.
id	string	The ID of the object. This is a conceptual ID synthesized from the IDs of the - Process - Ponnection - Multi-install integration pack (extensionGroupId), if applicable - Environment
connectionId	string	The ID of the connection.
extensionGroupId	string	If the process is in a multi-install integration pack, this is its ID, which is the same as the process's ID.
environmentId	string	The ID of the environment.
field	string	The extensions template for the OAuth 2.0 accessToken field is a superset of the standard connection field template. There is one additional field: oauth2AuthorizationUrl. The oauth2AuthorizationUrl value is the URL for manually generating the access token.

Supported operations

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

Note: The Boomi Enterprise Platform API and Partner API connectors do not support operations on the Environment Connection Field Extension Summary object.

The following fields can be used as QUERY filters for the Environment Connection Field Extension Summary object:

Field	Allowed value
environmentId	Any string value.
extensionGroupId	Any string value.
connectionId	Any string value.
fieldId	Any string value.

All filters are required except for extensionGroupId, which is for a multi-install integration pack only. You can obtain valid values for each filter by using the QUERY operation on the Environment Extensions object.

Only the EQUALS operator is allowed for the Environment Connection Field Extension Summary object filters. It returns one result only.

SOAP implementation

The following example query returns the URL for manually generating the access token for the OAuth 2.0 connection whose ID is bcdef012-3456-789a-bcde-f0123456789a in a process attached to the environment whose ID is 456789ab-cdef-0123-4567-89abcdef0123.

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>EnvironmentConnectionFieldExtensionSummary</api:objectType>
         <api:queryConfig>
            <api:QueryFilter>
               <api:expression operator="and" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="GroupingExpression">
                  <api:nestedExpression operator="EQUALS" property="environmentId" xsi:type="SimpleExpression">
                     <api:argument>456789ab-cdef-0123-4567-89abcdef0123</api:argument>
                  </api:nestedExpression>
                  <api:nestedExpression operator="EQUALS" property="connectionId" xsi:type="SimpleExpression">
                     <api:argument>bcdef012-3456-789a-bcde-f0123456789a</api:argument>
                  </api:nestedExpression>
                  <api:nestedExpression operator="EQUALS" property="fieldId" xsi:type="SimpleExpression">
                     <api:argument>oauthOptions/OAuth2Config/credentials/@accessToken</api:argument>
                  </api:nestedExpression>
               </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:EnvironmentConnectionFieldExtensionSummary" 
              environmentId="456789ab-cdef-0123-4567-89abcdef0123" processId="789abcde-f012-3456-789a-bcdef0123456" 
              connectionId="bcdef012-3456-789a-bcde-f0123456789a"
              extensionGroupId="" id="Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg"> 
               <bns:field oauth2AuthorizationUrl="https://accounts.google.com/o/oauth2/auth?scope=https%3A%2F%2Fwww.googleapis.com%2Fauth%2Fcalendar+...&amp;client_id=315699396546-pbq8qpjbnf80vb5gmgv3o210tq9v8bhi.apps.googleusercontent.com" componentOverride="false" usesEncryption="false" encryptedValueSet="false" id="oauthOptions/OAuth2Config/credentials/@accessToken"/>
            </bns:result>
         </bns:results>
     </bns:queryResponse>
   </S:Body>
</S:Envelope>