Environment Role object

The Environment Role object represents the linkage between an environment, an account where there is a defined environment, and a defined role for the environment.

Structure

<EnvironmentRole environmentId="" roleId="" id=""/>

Field	Type	Description
environmentId	string	The environment ID.
roleId	string	The ID of the role.
id	string	The object’s conceptual ID, which is synthesized from the role and environment IDs.

Supported operations

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

Notes:

The ordinary GET operation returns a single Environment Role object based on the supplied environment role ID. The bulk GET operation returns multiple Environment Role objects based on the supplied IDs, to a maximum of 100.
You can use the following fields as QUERY filters for the Environment Role object:

Field Allowed values
environmentId Any string value.
roleId Any string value.

The operators allowed for the Environment Role object filters are EQUALS and NOT_EQUALS. If the QUERY includes multiple filters, you can connect the filters with a logical AND or a logical OR operator.

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 associates a role with an environment. Therefore, the environmentId and roleId that you specify must already exist.

You must have the Runtime Management privilege to perform the CREATE operation. If you have the Runtime Management Read Access privilege, you cannot associate roles with environments.
The DELETE operation removes the association between a role and an environment.

You must have the Runtime Management privilege to perform the DELETE operation. If you have the Runtime Management privilege, you cannot delete associations between roles and environments.

Field	Allowed values
environmentId	Any string value.
roleId	Any string value.

SOAP implementation

GET 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:get>
         <api:objectType>EnvironmentRole</api:objectType>
         <api:objectId>RU5WX1JPTEVhYzQ3ZDczZS04ZmE3LTQ1NWMtYjE0OC04MmI4YWJlMDFiMTM6MThjZmRjZDctNTUyMS00MWUxLTkzZTItYjgzMTdlMzFkZTY0</api:objectId>
      </api:get>
   </soapenv:Body>
</soapenv:Envelope>

Response:

<S:Envelope xmlns:S="http://schemas.xmlsoap.org/soap/envelope/">
    <S:Body>
        <bns:getResponse xmlns:bns="http://api.platform.boomi.com/" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
            <bns:result xsi:type="bns:EnvironmentRole" roleId="userRole" environmentId="myEnvironment"/>
        </bns:getResponse>
    </S:Body>
</S:Envelope>

QUERY operation

The following example query returns all Environment Role objects.

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>EnvironmentRole</api:objectType>
      </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="4">
                <bns:result xsi:type="bns:EnvironmentRole" roleId="userRole" environmentId="myEnvironment" id="RU5WX1JPTEVkOTRlMTEzZC04ZTE2LTQwMWQtOGQ0OS03OGEzYzYyZmI3MTI6MThjZmRjZDctNTUyMS00MWUxLTkzZTItYjgzMTdlMzFkZTY0"/>
                <bns:result xsi:type="bns:EnvironmentRole" roleId="adminRole" environmentId="myEnvironment" id="RU5WX1JPTEVkYjg4MTZhZi0xNmMxLTQ1MmEtYjQwNS1lMzZmNGEwMTQ1NjU6MThjZmRjZDctNTUyMS00MWUxLTkzZTItYjgzMTdlMzFkZTY0"/>
                <bns:result xsi:type="bns:EnvironmentRole" roleId="testRole" environmentId="myEnvironment" id="RU5WX1JPTEVhYzQ3ZDczZS04ZmE3LTQ1NWMtYjE0OC04MmI4YWJlMDFiMTM6MThjZmRjZDctNTUyMS00MWUxLTkzZTItYjgzMTdlMzFkZTY0"/>
            </bns:results>
        </bns:queryResponse>
    </S:Body>
</S:Envelope>

The following example query illustrates the NOT_EQUALS filter.

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">boomi</wsse:Password>
        </wsse:UsernameToken>
      </wsse:Security>
   </soapenv:Header>
   <soapenv:Body>
      <api:query>
         <!--Optional:-->
         <api:objectType>EnvironmentRole</api:objectType>
         <!--Optional:-->
         <api:queryConfig>
            <api:QueryFilter>
                 <api:expression operator="NOT_EQUALS" property="roleId"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                     <api:argument>testRole</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:EnvironmentRole" roleId="userRole" environmentId="myEnvironment" id="RU5WX1JPTEVkYjg4MTZhZi0xNmMxLTQ1MmEtYjQwNS1lMzZmNGEwMTQ1NjU6MThjZmRjZDctNTUyMS00MWUxLTkzZTItYjgzMTdlMzFkZTY0"/>
            <bns:result xsi:type="bns:EnvironmentRole" roleId="adminRole" environmentId="myEnvironment" id="RU5WX1JPTEVkOTRlMTEzZC04ZTE2LTQwMWQtOGQ0OS03OGEzYzYyZmI3MTI6M2I3NWNmOWEtZmQzNy00YWQ3LThhYmMtNDM3OTYyYTllMjY0"/>
         </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:EnvironmentRole" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
					environmentId="myEnvironment"  roleId="userRole">
         </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">
         <result xsi:type="bns:EnvironmentRole" roleId="userRole" environmentId="myEnvironment" id="RU5WX1JPTEVkYjg4MTZhZi0xNmMxLTQ1MmEtYjQwNS1lMzZmNGEwMTQ1NjU6MThjZmRjZDctNTUyMS00MWUxLTkzZTItYjgzMTdlMzFkZTY0"/>
      </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>
         <objectType>EnvironmentRole</objectType>
         <objectId>RU5WX1JPTEVkYjg4MTZhZi0xNmMxLTQ1MmEtYjQwNS1lMzZmNGEwMTQ1NjU6MThjZmRjZDctNTUyMS00MWUxLTkzZTItYjgzMTdlMzFkZTY0</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">
         <successful>true</successful>
      </bns:deleteResponse>
   </S:Body>
</S:Envelope>

Structure​

Supported operations​

SOAP implementation​

Structure

Supported operations

SOAP implementation