Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - EnvironmentRole

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

EnvironmentRole

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.

Required Privileges

Write access

  • API — Use the Boomi Platform API to access account data.
  • ENV_MANAGEMENT — Management of all environments and associated access.

Read access

  • API — Use the Boomi Platform API to access account data.
  • ATOM_MANAGEMENT — Configure and administer integration runtimes.
  • ATOM_MANAGEMENT_READ_ONLY — Read only access to runtime configuration and administration.

Creates an EnvironmentRole object

Associates a role with an environment. You must have the Runtime Management privilege to perform the CREATE operation.

Authorizations:
basicAuth
Request Body schema:
optional
environmentId
string

The environment ID.

id
string

The object’s conceptual ID, which is synthesized from the role and environment IDs.

roleId
string

The ID of the role.

Responses

Response Schema:
environmentId
string

The environment ID.

id
string

The object’s conceptual ID, which is synthesized from the role and environment IDs.

roleId
string

The ID of the role.

Request samples

Content type
{
  • "environmentId": "myEnvironment",
  • "roleId": "userRole"
}

Response samples

Content type
{
  • "@type": "Environment",
  • "id": "456789ab-cdef-0123-4567-89abcdef0123",
  • "name": "My Production Environment",
  • "classification": "PROD"
}

Retrieves an instance of an EnvironmentRole object

Returns a single Environment Role object based on the supplied environment role ID.

Authorizations:
basicAuth
path Parameters
id
required
string

The Environment Role object you are attempting to get.

Responses

Response Schema:
environmentId
string

The environment ID.

id
string

The object’s conceptual ID, which is synthesized from the role and environment IDs.

roleId
string

The ID of the role.

Response samples

Content type
{
  • "@type": "EnvironmentRole",
  • "environmentId": "myEnvironment",
  • "roleId": "userRole"
}

Deletes an EnvironmentRole object

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.

Authorizations:
basicAuth
path Parameters
id
required
string

The Environment Role object you are attempting to delete.

Responses

Response samples

Content type
{
  • "message": "Access denied due to insufficient permissions."
}

Retrieves multiple EnvironmentRole objects by identifier

To learn more about bulk, refer to the topic Bulk GET operations.

Authorizations:
basicAuth
Request Body schema:
optional
Array of objects (BulkId)
type
string
Enum: "GET" "DELETE" "UPDATE" "CREATE"

Responses

Response Schema:
Array of objects
Array
required
object (EnvironmentRole)
index
integer <int32>
id
string
statusCode
integer <int32>
errorMessage
string

Request samples

Content type
{
  • "request": [
    • {
      }
    ],
  • "type": "GET"
}

Response samples

Content type
{
  • "response": [
    • {
      }
    ]
}

Queries for an EnvironmentRole object(s)

For general information about the structure of QUERY filters, their sample payloads, and how to handle the paged results, refer to Query filters and Query paging.

Authorizations:
basicAuth
Request Body schema:
optional

Possible properties include: environmentId, roleId

required
object
required
EnvironmentRoleSimpleExpression (object) or EnvironmentRoleGroupingExpression (object) (EnvironmentRoleExpression)
One of
operator
required
string
Enum: "EQUALS" "LIKE" "NOT_EQUALS" "IS_NULL" "IS_NOT_NULL" "BETWEEN" "GREATER_THAN" "GREATER_THAN_OR_EQUAL" "LESS_THAN" "LESS_THAN_OR_EQUAL" "CONTAINS" "NOT_CONTAINS"
property
required
string
Enum: "environmentId" "roleId"
argument
Array of strings

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (EnvironmentRole)

Request samples

Content type
Example
{
  • "QueryFilter": {
    • "expression": {
      }
    }
}

Response samples

Content type
{
  • "@type": "QueryResult",
  • "result": [
    • {
      }
    ],
  • "numberOfResults": 1
}

Retrieves additional results for an EnvironmentRole query

To learn about using queryMore, refer to the topic Query paging.

Authorizations:
basicAuth
Request Body schema: text/plain
required
string

Responses

Response Schema:
numberOfResults
integer <int32>
queryToken
string

By default, the queryToken parameter is not available in the query response. It appears only when the query response contains more than 100 results. The maximum number of results returned per query is 100. To retrieve the next set of results, use the queryToken in the queryMore request.

Array of objects (EnvironmentRole)

Response samples

Content type
{
  • "@type": "QueryResult",
  • "result": [
    • {
      }
    ],
  • "numberOfResults": 1
}