Waiting for engine...
Skip to main content

Installer Token object

The Installer Token object represents a unique token generated by that you can use to install a Runtime, Runtime cluster node, runtime cloud clusters, Authentication Broker, or API Gateway.

Using a token eliminates the need to specify credentials. When you create a token, it is valid only for the generating account.

Structure

<InstallerToken installType="" durationMinutes="" cloudId=""/>
FieldTypeDescription
installTypestring- ATOM
- MOLECULE
- CLOUD
- BROKER
durationMinutesintThe number of minutes for which the installer token is valid, from 30 to 1440.
cloudIdstring(For Runtime cloud installation) A unique ID assigned by the system to the Runtime cloud.

Supported operations

GETQUERYCREATEUPDATEEXECUTEDELETE
 Not supportedNot supported Supported Not supported  Not supported Not supported

The CREATE operation creates an installer token of a specific type that is valid for a specific number of minutes.

You must have the Runtime Management privilege to perform the CREATE operation. If you have the Runtime Management Read Access privilege, you cannot create installer tokens.

SOAP implementation

The following example creates an installer token for a runtime cloud clusters that remains valid for 60 minutes.

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:InstallerToken" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:bns="http://api.platform.boomi.com/" installType="CLOUD" cloudId="8128c7aa-9802-4231-9ec9-c4740473fe7c"
durationMinutes="60"/>
</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:InstallerToken" accountId="fakeaccount-KYZAI9" created="2017-02-07T21:57:30.044Z"
expiration="2017-02-07T22:57:30.044Z" token="cloud-9df25f36-2d03-4b1c-bdc7-7185628ae142"
cloudId="8128c7aa-9802-4231-9ec9-c4740473fe7c" installType="CLOUD"/>
</bns:createResponse>
</S:Body>
</S:Envelope>
On this Page