Role object

The Role object represents a role assignable to users to control access to functionality. The Role object is exposed to enable interaction with an account’s custom roles.

Structure

<Role
  parentId=""
  name=""
  accountId=""
  id="">
  <Privileges>
    <Privilege name=""/>
  </Privileges>
</Role>

Field	Type	Description
Filter	Filter	Filter
parentId	string	The ID of the role from which this role inherits privileges.
name	string	The name of the role.
accountId	string	The account ID under which the role exists.
id	string	The ID of the role.
Privileges	string	One or more privileges assigned to the role.

Supported operations

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

• The ordinary GET operation returns a single Role object based on the supplied role ID. The bulk GET operation returns multiple Role objects based on the supplied IDs, to a maximum of 100.

• You can use the following fields as QUERY filters for the Role object.

  Field	Allowed values
  parentId	Any string value.
  name	Any string value.

  Only the EQUALS operator is allowed for the Role object filters. 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 creates a Role object based on the supplied values. All fields are required for a CREATE request.

• The UPDATE operation updates a role as identified by its role ID. Therefore, you must supply the complete Role object, not only the fields you want to change.

• The DELETE operation deletes a Role object based on the supplied role ID.

note

Your account must have the Advanced User Security feature enabled to query for custom roles and create, update, or delete custom roles. If you do not enable this feature, you can only query for default roles.

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>Role</api:objectType>
           <api:objectId>f3fb5e19-fc47-442e-a978-c47db961ecfb</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:Role" name="JsonRole5" accountId="account-12345" id="f3fb5e19-fc47-442e-a978-c47db961ecfb">
              <bns:Description>my role description</bns:Description>
              <bns:Privileges>
                 <bns:Privilege name="VIEW_RESULT"/>
                 <bns:Privilege name="EMBED"/>
                 <bns:Privilege name="EXECUTE"/>
                 <bns:Privilege name="ATOM_MANAGEMENT"/>
              </bns:Privileges>
           </bns:result>
        </bns:getResponse>
     </S:Body>
  </S:Envelope>

• QUERY operation

  The following example query returns all roles.

  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>Role</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="3">
              <bns:result xsi:type="bns:Role" name="Extend Support" accountId="accountId-12345" id="3456789a-bcde-f012-3456-789abcdef012">
                 <bns:Description>role description</bns:Description>
              </bns:result>
              <bns:result xsi:type="bns:Role" name="Soap Role" accountId="accountId-12345" id="4f62691f-f30a-43eb-a106-1d55260872b6">
                 <bns:Description>my role description</bns:Description>
              </bns:result>
              <bns:result xsi:type="bns:Role" parentId="ca7f37b3-f976-4d06-b885-81520b467a69" name="Other Role" accountId="account-12345" id="939f8472-c279-4b65-93b0-ee56c2881b3e">
                 <bns:Description>Modified role</bns:Description>
                 <bns:Privileges>
                    <bns:Privilege name="API"/>
                    <bns:Privilege name="BUILD"/>
                 </bns:Privileges>
              </bns:result>
           </bns:results>
        </bns:queryResponse>
     </S:Body>
  </S:Envelope>

  The following example query returns roles based on supplied filters.

  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>Role</api:objectType>
           <api:queryConfig>
              <api:QueryFilter>
                 <api:expression operator="and"
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:GroupingExpression">
                   <api:nestedExpression operator="EQUALS" property="name"
                     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                     <api:argument>other role</api:argument>
                   </api:nestedExpression>
  			  <api:nestedExpression operator="EQUALS" property="parentId"
                     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:type="api:SimpleExpression">
                     <api:argument>ca7f37b3-f976-4d06-b885-81520b467a69</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:Role" parentId="ca7f37b3-f976-4d06-b885-81520b467a69" name="Other Role" accountId="account-12345" id="939f8472-c279-4b65-93b0-ee56c2881b3e">
                 <bns:Description>Modified role</bns:Description>
                 <bns:Privileges>
                    <bns:Privilege name="API"/>
                    <bns:Privilege name="BUILD"/>
                 </bns:Privileges>
              </bns:result>
           </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>
        <bns:create>
            <object xsi:type="api:Role" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/" 
            parentId="" name="Soap Role" accountId="account-12345">
            <bns:Description>my role description</bns:Description>
            <bns:Privileges>
                    <bns:Privilege name="DEPLOY"/>
                    <bns:Privilege name="SCHEDULE_MAINTENANCE"/>
                    <bns:Privilege name="VIEW_RESULT"/>
                    <bns:Privilege name="EXECUTE"/>
                    <bns:Privilege name="ATOM_MANAGEMENT"/>
                 </bns:Privileges>
           </object>
        </bns: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:Role" name="Soap Role" accountId="accountId-12345" id="2ab5db48-1c5f-4baa-ad61-98bf8b780c24">
              <bns:Description>my role description</bns:Description>
              <bns:Privileges>
                 <bns:Privilege name="EXECUTE"/>
                 <bns:Privilege name="DEPLOY"/>
                 <bns:Privilege name="ATOM_MANAGEMENT"/>
                 <bns:Privilege name="SCHEDULE_MAINTENANCE"/>
                 <bns:Privilege name="VIEW_RESULT"/>
              </bns:Privileges>
           </result>
        </bns:createResponse>
     </S:Body>
  </S:Envelope>

• UPDATE 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_USERNAME</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>
        <bns:update>
            <object xsi:type="api:Role" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:bns="http://api.platform.boomi.com/" 
            parentId="" name="My Role" accountId="account-12345" id="dde27095-4ad8-4f90-a632-2686aa28cd82">
            <bns:Description>Updated role with new name</bns:Description>
            <bns:Privileges>
                    <bns:Privilege name="DEPLOY"/>
                    <bns:Privilege name="SCHEDULE_MAINTENANCE"/>
                 </bns:Privileges>
           </object>
        </bns: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">
           <result xsi:type="bns:Role" name="My Role" accountId="account-12345" id="dde27095-4ad8-4f90-a632-2686aa28cd82">
              <bns:Description>Updated Role with new name</bns:Description>
              <bns:Privileges>
                 <bns:Privilege name="DEPLOY"/>
                 <bns:Privilege name="SCHEDULE_MAINTENANCE"/>
              </bns:Privileges>
           </result>
        </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>
           <objectType>Role</objectType>
           <objectId>39f8319c-b80c-4f70-aafe-9bab46aafcc6</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>