Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - AtomSecurityPolicies

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

AtomSecurityPolicies

The Atom Security Policies object represents custom updates to the current Java Virtual Machine (JVM) HIGH security policy for a Runtime cloud or a Runtime cluster with forked execution enabled. As the owner of a Runtime cloud or Runtime cluster, you can retrieve any custom updates to the HIGH security policy for your container. You can also update the policy by adding, changing, or removing custom runtime permissions. Refer to the topic Security policies for Clouds and Runtime clusters for more information. Retrieving a security policy is an asynchronous process:

  • The client sends a GET request that specifies a container ID to the .
  • The platform returns a security policy token for the specified Runtime cloud or Runtime cluster.
  • You send one or more GET requests that include the security policy token.
  • The platform returns one of the following:
    • Status code 202 while the request is in progress.
    • Status code 200 with the custom contents of the security policy when the request is complete.

Required Privileges

You need these privileges in the target environment:

Write access

  • API — Use the Boomi Platform API to access account data.
  • ATOM_MANAGEMENT — Configure and administer integration runtimes.

Read access

  • API — Use the Boomi Platform API to access account data.
  • ATOM_MANAGEMENT_READ_ONLY — Read only access to runtime configuration and administration.

Modifies or updates an AtomSecurityPolicies object

Updates the security policy for the specified Runtime cloud or Runtime cluster. You can add, update, or delete permissions by using the UPDATE operation. You can add custom Java runtime permissions you specify in an UPDATE operation to the appropriate High-security policy file. In addition, all High-security policy files contain custom permissions that you specify in the section. As confirmation of the changes made, the UPDATE operation returns a copy of the request.

Authorizations:
basicAuth
path Parameters
id
required
string

The runtime (container) id for the applicable runtime (accepts only Runtime cloud cluster and regular Runtime cluster types, no basic runtimes or cloud attachments).

Request Body schema:
optional
atomId
required
string

The ID of the Runtime cloud or Runtime cluster.

required
object (AtomSecurityPoliciesType)
object (AtomSecurityPoliciesType)
object (AtomSecurityPoliciesType)
object (AtomSecurityPoliciesType)

Responses

Response Schema:
atomId
required
string

The ID of the Runtime cloud or Runtime cluster.

required
object (AtomSecurityPoliciesType)
object (AtomSecurityPoliciesType)
object (AtomSecurityPoliciesType)
object (AtomSecurityPoliciesType)

Request samples

Content type
{
  • "atomId": "8f535694-c152-42f3-9923-2f805a17775a",
  • "common": {
    • "policies": [
      ]
    }
}

Response samples

Content type
{
  • "@type": "AtomSecurityPolicies",
  • "common": {
    • "@type": "AtomSecurityPoliciesType",
    • "policies": [
      ]
    },
  • "runner": {
    • "@type": "AtomSecurityPoliciesType",
    • "policies": [ ]
    },
  • "worker": {
    • "@type": "AtomSecurityPoliciesType",
    • "policies": [ ]
    },
  • "browser": {
    • "@type": "AtomSecurityPoliciesType",
    • "policies": [ ]
    },
  • "atomId": "8f535694-c152-42f3-9923-2f805a17775a"
}

Retrieves an AtomSecurityPolicies object by identifier

The initial GET operation returns a security policy token for the specified Runtime cloud or Runtime cluster. Subsequent GET operations return status code 202 (while the request is in progress) or the custom contents of a security policy based on the token that was returned.

The GET operation returns only custom runtime permissions that you added to the security policy, not the entire policy file. If you did not update the security policy for a given Runtime cloud or Runtime cluster, the response to a GET operation is empty.

Authorizations:
basicAuth
path Parameters
id
required
string

The runtime (container) id for the applicable runtime (accepts only Runtime cloud cluster and regular runtime cluster types, no basic runtimes or cloud attachments).

Responses

Response Schema:
required
object (AsyncToken)
responseStatusCode
required
integer <int32>

Response samples

Content type
{
  • "AsyncOperationTokenResult": {
    • "responseStatusCode": "202",
    • "asyncToken": {
      }
    }
}

Retrieves AtomSecurityPolicies objects by token

Using the token from the initial GET response, send an HTTP GET where accountId is the account with which you are authenticating.

Custom Java runtime permissions listed in the <common> section apply to all High security policy files (procrunner-HIGH.policy, procbrowser-HIGH.policy, and procworker-HIGH.policy). Custom permissions listed in a specific section, such as <runner>, apply only to the associated security policy file.

Authorizations:
basicAuth
path Parameters
token
required
string

Takes in the token from a previous call to return a result.

Responses

Response Schema:
responseStatusCode
required
integer <int32>
numberOfResults
integer <int32>
Array of objects (AtomSecurityPolicies)

Response samples

Content type
{
  • "AtomSecurityPolicies": {
    • "atomId": "4ce4a1c2-5bd9-4bd9-9201-46198e2d88db",
    • "common": {
      },
    • "runner": null,
    • "worker": null,
    • "browser": {
      },
    • "numberOfResults": "1",
    • "responseStatusCode": "202",
    • "result": [
      ]
    }
}