Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - Role

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

Role

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.

Note: Any role (including custom roles) created in an internal account is considered a default Boomi role and cannot be deleted, resulting in the following error message:

{
  "@type": "Error",
  "message": "Cannot modify default Boomi roles"
}

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.

Required Privileges

Read and Write access

  • API — Use the Boomi Platform API to access account data.
  • ACCOUNT_ADMIN — Account configuration and administration.

Creates a Role object

Creates a Role object based on the supplied values.

Authorizations:
basicAuth
Request Body schema:
optional
Description
string

Description of the role

object (Privileges)

One or more privileges assigned to the role.

accountId
string

The account ID under which the role exists.

id
string

The ID of the role.

name
string

The name of the role.

parentId
string

The ID of the role from which this role inherits privileges.

Responses

Response Schema:
Description
string

Description of the role

object (Privileges)

One or more privileges assigned to the role.

accountId
string

The account ID under which the role exists.

id
string

The ID of the role.

name
string

The name of the role.

parentId
string

The ID of the role from which this role inherits privileges.

Request samples

Content type
{
  • "Description": "This is a custom role added",
  • "Privileges": {
    • "Privilege": [
      ]
    },
  • "accountId": "accountId-12345",
  • "name": "myRole",
  • "parentId": "ca7f37b3-f976-4d06-b885-81520b467a69"
}

Response samples

Content type
{
  • "@type": "Role",
  • "Description": "Live and direct via API!",
  • "Privileges": {
    • "@type": "Privileges",
    • "Privilege": [
      ]
    },
  • "id": "f3fb5e19-fc47-442e-a978-c47db961ecfb",
  • "accountId": "account-12345",
  • "name": "JsonRole",
  • "parentId": "ca7f37b3-f976-4d06-b885-81520b467a69"
}

Retrieves an instance of a Role object

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

Authorizations:
basicAuth
path Parameters
id
required
string

Responses

Response Schema:
Description
string

Description of the role

object (Privileges)

One or more privileges assigned to the role.

accountId
string

The account ID under which the role exists.

id
string

The ID of the role.

name
string

The name of the role.

parentId
string

The ID of the role from which this role inherits privileges.

Response samples

Content type
{
  • "@type": "Role",
  • "Description": "Updated Role",
  • "Privileges": {
    • "@type": "Privileges",
    • "Privilege": [
      ]
    },
  • "id": "f3fb5e19-fc47-442e-a978-c47db961ecfb",
  • "accountId": "account-12345",
  • "name": "Soap Role",
  • "parentId": "ca7f37b3-f976-4d06-b885-81520b467a69"
}

Modifies or updates a Role object

Updates a role as identified by its role ID.

Authorizations:
basicAuth
path Parameters
id
required
string
Request Body schema:
optional
Description
string

Description of the role

object (Privileges)

One or more privileges assigned to the role.

accountId
string

The account ID under which the role exists.

id
string

The ID of the role.

name
string

The name of the role.

parentId
string

The ID of the role from which this role inherits privileges.

Responses

Response Schema:
Description
string

Description of the role

object (Privileges)

One or more privileges assigned to the role.

accountId
string

The account ID under which the role exists.

id
string

The ID of the role.

name
string

The name of the role.

parentId
string

The ID of the role from which this role inherits privileges.

Request samples

Content type
{
  • "Description": "Updated custom role",
  • "Privileges": {
    • "Privilege": [
      ]
    },
  • "accountId": "accountId-12345",
  • "name": "newRoleName",
  • "id": "f3fb5e19-fc47-442e-a978-c47db961ecfb",
  • "parentId": "ca7f37b3-f976-4d06-b885-81520b467a69f"
}

Response samples

Content type
{
  • "@type": "Role",
  • "Description": "my updated role",
  • "Privileges": {
    • "@type": "Privileges",
    • "Privilege": [
      ]
    },
  • "id": "f3fb5e19-fc47-442e-a978-c47db961ecfb",
  • "accountId": "account-12345",
  • "name": "JsonRole",
  • "parentId": "ca7f37b3-f976-4d06-b885-81520b467a69f"
}

Deletes a Role object

Deletes a Role object based on the supplied role ID.

Authorizations:
basicAuth
path Parameters
id
required
string

Responses

Response samples

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

Retrieves multiple Role 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 (Role)
index
integer <int32>
id
string
statusCode
integer <int32>
errorMessage
string

Request samples

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

Response samples

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

Queries for a Role 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: name, parentId

required
object
required
RoleSimpleExpression (object) or RoleGroupingExpression (object) (RoleExpression)
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: "name" "parentId"
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 (Role)

Request samples

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

Response samples

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

Retrieves additional results for a Role 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 (Role)

Response samples

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