Waiting for engine...
Skip to main content

Boomi Platform API Reference (1.0.0) - AccountGroupUserRole

Toggle Pane
API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

AccountGroupUserRole

The Account Group User Role object represents the linkage between an user, an account group, and a defined role for the primary account.

Note: To facilitate these operations on this object in an integration process, use the Platform Partner API connector instead of the Platform API connector.

Required Privileges

Read and Write access

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

Creates an AccountGroupUserRole object

Adds a user to an account group.

Authorizations:
basicAuth
Request Body schema:
optional
accountGroupId
string

The ID of the account group.

firstName
string

The first name of the user.

id
string

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

lastName
string

The last name of the user.

notifyUser
boolean

If true, which is the default, users receive an email notification when adding them to the account group.

roleId
string

The ID of the role.

userId
string

The user ID.

Responses

Response Schema:
accountGroupId
string

The ID of the account group.

firstName
string

The first name of the user.

id
string

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

lastName
string

The last name of the user.

notifyUser
boolean

If true, which is the default, users receive an email notification when adding them to the account group.

roleId
string

The ID of the role.

userId
string

The user ID.

Request samples

Content type
{
  • "userId": "user123@company.biz",
  • "accountGroupId": "fedcba98-7654-3210-fedc-ba9876543c210",
  • "roleId": "01234567-89ab-cdef-0123-456789abcdef",
  • "firstName": "John",
  • "lastName": "Doe",
  • "notifyUser": true
}

Response samples

Content type
{
  • "@type": "AccountGroupUserRole",
  • "id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts4Rq3Po2Nm1Lk0Ji1Hg",
  • "accountGroupId": "fedcba98-7654-3210-fedc-ba9876543c210",
  • "userId": "user123@company.biz",
  • "roleId": "01234567-89ab-cdef-0123-456789abcdef",
  • "firstName": "John",
  • "lastName": "Doe",
  • "notifyUser": true
}

Queries for an AccountGroupUserRole 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: accountGroupId, userId, roleId

required
object
required
AccountGroupUserRoleSimpleExpression (object) or AccountGroupUserRoleGroupingExpression (object) (AccountGroupUserRoleExpression)
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: "accountGroupId" "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 (AccountGroupUserRole)

Request samples

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

Response samples

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

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

Response samples

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

Deletes an AccountGroupUserRole object

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

Authorizations:
basicAuth
path Parameters
id
required
string

Responses

Response samples

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