Boomi Platform API Reference (1.0.0) - AccountUserFederation

Toggle Pane

• AccountUserFederation
  • postCreates an AccountUserFederation object
  • postQueries for an AccountUserFederation object(s)
  • postRetrieves additional results for an AccountUserFederation query
  • postModifies or updates an AccountUserFederation object
  • delDeletes an AccountUserFederation object

API docs by Redocly

License: Boomi API License and Rate Limits

Download OpenAPI Specification: Download

AccountUserFederation

The Account User Federation object represents the linkage between an user enabled for single sign-on, an account used by that user, and the user's federation ID. The implementation of single sign-on with SAML uses unique federation IDs to identify users.

Required Privileges

Read and Write access

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

Creates an AccountUserFederation object

Enables single sign-on for a specific user under a specific account using a specific federation ID. The user is not visible in the Setup page unless you assign one or more roles to that user.

Authorizations:

basicAuth

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

accountId	string The account ID.
federationId	string The federation ID uniquely identifies the user.
id	string The object’s conceptual ID, which is synthesized from the federation, user, and account IDs.
userId	string The user ID.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

accountId	string The account ID.
federationId	string The federation ID uniquely identifies the user.
id	string The object’s conceptual ID, which is synthesized from the federation, user, and account IDs.
userId	string The user ID.

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/AccountUserFederation

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "federationId": "user123",
• "userId": "user123@company.biz",
• "accountId": "account-123456"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "AccountUserFederation",
• "id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts",
• "accountId": "account-123456",
• "userId": "user123@company.biz",
• "federationId": "user123"

}

Queries for an AccountUserFederation 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:

application/jsonapplication/xmlapplication/json

optional

Possible properties include: accountId, userId, federationId

required

object

required AccountUserFederationSimpleExpression (object) or AccountUserFederationGroupingExpression (object) (AccountUserFederationExpression) 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" "federationId" argument Array of strings

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

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 (AccountUserFederation)

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/AccountUserFederation/query

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

Example

SimpleExpressionGroupingExpressionSimpleExpression

{

• "QueryFilter": {

  • "expression": {

    • "argument": [

      • "user123"

      ],
    • "operator": "EQUALS",
    • "property": "federationId"

    }

  }

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "numberOfResults": 1,
• "@type": "QueryResult",
• "result": [

  • {

    • "@type": "AccountUserFederation",
    • "id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts",
    • "accountId": "account-123456",
    • "userId": "user123@company.biz",
    • "federationId": "user123"

    }

  ]

}

Retrieves additional results for an AccountUserFederation query

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

Authorizations:

basicAuth

Request Body schema: text/plain

required

string

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

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 (AccountUserFederation)

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/AccountUserFederation/queryMore

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "numberOfResults": 1,
• "@type": "QueryResult",
• "result": [

  • {

    • "@type": "AccountUserFederation",
    • "id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts",
    • "accountId": "account-123456",
    • "userId": "user123@company.biz",
    • "federationId": "user123"

    }

  ]

}

Modifies or updates an AccountUserFederation object

Updates the federation ID of a specific user in a specific account.

Authorizations:

basicAuth

path Parameters

id required

string

Request Body schema:

application/jsonapplication/xmlapplication/json

optional

accountId	string The account ID.
federationId	string The federation ID uniquely identifies the user.
id	string The object’s conceptual ID, which is synthesized from the federation, user, and account IDs.
userId	string The user ID.

Responses

Response Schema:

application/jsonapplication/xmlapplication/json

accountId	string The account ID.
federationId	string The federation ID uniquely identifies the user.
id	string The object’s conceptual ID, which is synthesized from the federation, user, and account IDs.
userId	string The user ID.

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/AccountUserFederation/{id}

Request samples

• Payload

Content type

application/jsonapplication/xmlapplication/json

{

• "accountId": "account-123456",
• "userId": "user123@company.biz",
• "federationId": "user456"

}

Response samples

• 200
• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "@type": "AccountUserFederation",
• "id": "Ab0Cd1Ef1Gh3Ij4Kl5Mn6Op7Qr8St9Uv0Wx9Yz8Zy7Xw6Vu5Ts",
• "accountId": "account-123456",
• "userId": "user123@company.biz",
• "federationId": "user456"

}

Deletes an AccountUserFederation object

Disables single sign-on for the user specified by the conceptual Account User Federation object ID.

Authorizations:

basicAuth

path Parameters

id required

string

Responses

Boomi Platform API Endpoint URL. {accountId} is the Account ID of the authenticated Boomi platform account making this request.

https://api.boomi.com/api/rest/v1/{accountId}/AccountUserFederation/{id}

Response samples

• 403
• 410
• 503

Content type

application/jsonapplication/xmlapplication/json

{

• "message": "Access denied due to insufficient permissions."

}