Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - AccountUserRole

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

AccountUserRole

The Account User Role object represents the linkage between an user, the user's account, and a defined role for the account.

Required Privileges

Read and Write access

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

Creates an AccountUserRole object

Adds a user to an account. If you provide a user ID (email address) that does not exist, the system creates the user and adds them to the account.

When creating a new user, the API request does not require the firstName and lastName fields. If you do not provide those fields, it assigns the default firstName or lastName values automatically. If you include the firstName and lastName fields in a CREATE request for a user name that exists, the request ignores those fields.

Authorizations:
basicAuth
Request Body schema:
optional
accountId
string

The account ID.

firstName
string

The first name of a user in the account.

id
string
lastName
string

The last name of a user in the account.

notifyUser
boolean

If true

roleId
string

The ID of the role.

userId
string

The user ID.

Responses

Response Schema:
accountId
string

The account ID.

firstName
string

The first name of a user in the account.

id
string
lastName
string

The last name of a user in the account.

notifyUser
boolean

If true

roleId
string

The ID of the role.

userId
string

The user ID.

Request samples

Content type
{
  • "accountId": "account-123456",
  • "userId": "user123@company.biz",
  • "roleId": "01234567-89ab-cdef-0123-456789abcdef",
  • "firstName": "John",
  • "lastName": "Doe",
  • "notifyUser": true
}

Response samples

Content type
{
  • "@type": "AccountUserRole",
  • "id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg",
  • "accountId": "account-123456",
  • "userId": "user123@company.biz",
  • "roleId": "01234567-89ab-cdef-0123-456789abcdef",
  • "firstName": "John",
  • "lastName": "Doe",
  • "notifyUser": true
}

Queries for an AccountUserRole 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: accountId, userId, roleId

required
object
required
AccountUserRoleSimpleExpression (object) or AccountUserRoleGroupingExpression (object) (AccountUserRoleExpression)
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: "accountId" "userId" "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 (AccountUserRole)

Request samples

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

Response samples

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

Retrieves additional results for an AccountUserRole 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 (AccountUserRole)

Response samples

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

Deletes an AccountUserRole object

Removes the specified user by a specified conceptual Account User Role object ID from an account.

Authorizations:
basicAuth
path Parameters
id
required
string

Responses

Response samples

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