Waiting for engine...
Skip to main content

Spaces Embed Service APIs - Partners

Toggle Pane
API docs by Redocly

License: Copyright © 2026 Boomi, LP.

Download OpenAPI Specification: Download

Run In Postman

For more information about Postman collections, forking, and making your first API call, refer to the Working with Boomi APIs on Postman page.

Partners

OEM partner onboarding and management. Every endpoint requires a Boomi-internal JWT bearer token with the BOOMI_INTERNAL authority.

Get a partner by uid

Direct lookup by uid; returns the details of the partner, including the partner name, account ID, child account details, and the partner's associated domains.

Authorizations:
BoomiJwtBearer
path Parameters
partnerId
required
string

The partner's unique identifier (uid), generated server-side and returned as the uid field in the list, create, and update partner responses; pass it here to identify which partner this request applies to.

Responses

Response Schema: application/json
uid
string

Unique partner identifier, generated server-side.

partnerName
string

Display name of the OEM partner.

accountId
string

The partner's Boomi Platform account ID.

domainName
string
Deprecated

Partner's domain, used to route embed requests.

iframeUrl
string

The OEM parent origin allowed to frame the embed.

authServerUrl
string
Deprecated

The Auth0 (or equivalent OIDC) issuer URL used to verify this partner's embed launch tokens.

apiToken
string
Deprecated

Boomi Platform API token for this partner. SENSITIVE: currently returned as-is (unmasked) by GET/POST/PUT/PATCH /v1/partners — this documents real, current behavior rather than concealing it. Deprecated: superseded by per-child childDetails[].childApiToken; kept as the fallback token for children that don't supply their own.

audience
string

Optional OIDC client id (token aud) used as an additional lookup key for the embed flow.

sessionTimeout
integer <int32>

Session timeout in seconds for this partner's embed sessions.

active
boolean

Whether this partner is active.

createdAt
string

ISO-8601 timestamp this partner record was created.

updatedAt
string

ISO-8601 timestamp this partner record was last updated.

createdBy
string

Identity that created this partner record.

updatedBy
string

Identity that last updated this partner record.

Array of objects (ChildDetails)

Child (sub-)account grants for this partner.

Array of objects (DomainAuthEntry)

Domain + issuer pairs registered for this partner; supersedes the deprecated domainName/authServerUrl for multi-domain partners.

Response samples

Content type
application/json
{
  • "uid": "8f14e45f-ceea-467e-b7a9-53f68b6bab63",
  • "partnerName": "Acme Corp",
  • "accountId": "acme-ABC123",
  • "iframeUrl": "https://acme.com",
  • "audience": "vQpfuHf8flLMggaCZ7uXzpZwdnDVi4Uh",
  • "sessionTimeout": 1800,
  • "active": true,
  • "createdAt": "2026-01-15T10:30:00Z",
  • "updatedAt": "2026-02-01T09:00:00Z",
  • "createdBy": "admin@boomi.com",
  • "updatedBy": "admin@boomi.com",
  • "childDetails": [
    • {
      }
    ],
  • "domains": []
}

Replace a partner's configuration

Fully replaces all fields for an existing partner, applying the same uniqueness and existence checks as the creation endpoint.

Known behavior: similar to partner creation, validation failures, ACCOUNT_NOT_FOUND, and duplicate-field conflicts currently return an HTTP 500 response (rather than 422 Unprocessable Entity or 409 Conflict).

Authorizations:
BoomiJwtBearer
path Parameters
partnerId
required
string

The partner's unique identifier (uid), generated server-side and returned as the uid field in the list, create, and update partner responses; pass it here to identify which partner this request applies to.

Request Body schema: application/json
required
accountId
required
string

The partner's Boomi Platform account ID. Must exist on the Boomi platform — see the ACCOUNT_NOT_FOUND error case.

authServerUrl
required
string^$|^https://.*
Deprecated

The Auth0 (or equivalent OIDC) issuer URL used to verify this partner's embed launch tokens. May be shared across multiple partners.

domainName
required
string^$|^[a-zA-Z0-9][a-zA-Z0-9\-\.]*\.com$
Deprecated

Partner's domain, used to route embed requests. No scheme; must end in .com.

iframeUrl
required
string^https?://[^\s]+

The OEM parent origin allowed to frame the embed (used for the per-tenant Content-Security-Policy frame-ancestors directive).

partnerName
required
string

Display name of the OEM partner.

apiToken
string^$|^[A-Za-z0-9\-_.]{8,512}$
Deprecated

Boomi Platform API token used server-side to mint platform JWTs for this partner. Optional when every childDetails entry supplies its own childApiToken; falls back to this value where a child token is absent. SENSITIVE: currently returned as-is (unmasked) in every GET/POST/PUT/PATCH /v1/partners response — treat responses containing it accordingly. Deprecated: superseded by childDetails[].childApiToken.

audience
string^$|^[A-Za-z0-9_-]{8,128}$

Optional OIDC client ID (token aud). When set, it is validated against the launch token's aud claim. Note: incoming requests are currently routed by issuer (authServerUrl), regardless of whether this field is provided.

Array of objects (ChildDetailsRequest)

Child (sub-)account grants for this partner. Each childAccountId must already be a shared account of accountId — see CHILD_ACCOUNT_ID_NOT_FOUND.

Array of objects (DomainAuthEntryRequest) [ 0 .. 20 ] items

Domain + issuer pairs to register for this partner; supersedes the deprecated domainName/authServerUrl for multi-domain partners.

Responses

Response Schema: application/json
uid
string

Unique partner identifier, generated server-side.

partnerName
string

Display name of the OEM partner.

accountId
string

The partner's Boomi Platform account ID.

domainName
string
Deprecated

Partner's domain, used to route embed requests.

iframeUrl
string

The OEM parent origin allowed to frame the embed.

authServerUrl
string
Deprecated

The Auth0 (or equivalent OIDC) issuer URL used to verify this partner's embed launch tokens.

apiToken
string
Deprecated

Boomi Platform API token for this partner. SENSITIVE: currently returned as-is (unmasked) by GET/POST/PUT/PATCH /v1/partners — this documents real, current behavior rather than concealing it. Deprecated: superseded by per-child childDetails[].childApiToken; kept as the fallback token for children that don't supply their own.

audience
string

Optional OIDC client id (token aud) used as an additional lookup key for the embed flow.

sessionTimeout
integer <int32>

Session timeout in seconds for this partner's embed sessions.

active
boolean

Whether this partner is active.

createdAt
string

ISO-8601 timestamp this partner record was created.

updatedAt
string

ISO-8601 timestamp this partner record was last updated.

createdBy
string

Identity that created this partner record.

updatedBy
string

Identity that last updated this partner record.

Array of objects (ChildDetails)

Child (sub-)account grants for this partner.

Array of objects (DomainAuthEntry)

Domain + issuer pairs registered for this partner; supersedes the deprecated domainName/authServerUrl for multi-domain partners.

Request samples

Content type
application/json
{
  • "partnerName": "Acme Corp",
  • "accountId": "acme-ABC123",
  • "iframeUrl": "https://acme.com",
  • "audience": "vQpfuHf8flLMggaCZ7uXzpZwdnDVi4Uh",
  • "childDetails": [
    • {
      }
    ],
  • "domains": []
}

Response samples

Content type
application/json
{
  • "uid": "8f14e45f-ceea-467e-b7a9-53f68b6bab63",
  • "partnerName": "Acme Corp",
  • "accountId": "acme-ABC123",
  • "iframeUrl": "https://acme.com",
  • "audience": "vQpfuHf8flLMggaCZ7uXzpZwdnDVi4Uh",
  • "sessionTimeout": 1800,
  • "active": true,
  • "createdAt": "2026-01-15T10:30:00Z",
  • "updatedAt": "2026-02-01T09:00:00Z",
  • "createdBy": "admin@boomi.com",
  • "updatedBy": "admin@boomi.com",
  • "childDetails": [
    • {
      }
    ],
  • "domains": []
}

Partially update a partner

Only fields present in the payload are validated and applied; omitted fields are left untouched.

Authorizations:
BoomiJwtBearer
path Parameters
partnerId
required
string

The partner's unique identifier (uid), generated server-side and returned as the uid field in the list, create, and update partner responses; pass it here to identify which partner this request applies to.

Request Body schema: application/json
required
partnerName
string

Display name of the OEM partner. Omit/null to leave unchanged.

accountId
string

The partner's Boomi Platform account ID. Omit/null to leave unchanged.

domainName
string^[a-zA-Z0-9][a-zA-Z0-9\-\.]*\.com$
Deprecated

Partner's domain. Omit/null to leave unchanged; if provided, must be a valid hostname ending in .com.

iframeUrl
string^https?://[^\s]+

The OEM parent origin allowed to frame the embed. Omit/null to leave unchanged.

authServerUrl
string^https://.*
Deprecated

The Auth0 (or equivalent OIDC) issuer URL. Omit/null to leave unchanged.

apiToken
string^[A-Za-z0-9\-_.]{8,512}$
Deprecated

The Boomi Platform API token used server-side to mint platform JWTs for this partner. SECURITY NOTE: This token is returned unmasked in all GET, POST, PUT, and PATCH responses for /v1/partners. Handle and store response payloads containing this field with appropriate security controls. Omit/null to leave unchanged. Deprecated: superseded by childDetails[].childApiToken.

audience
string^$|^[A-Za-z0-9_-]{8,128}$

Optional OIDC client id (token aud). Omit/null to leave unchanged.

Array of objects (ChildDetailsRequest)

Child (sub-)account grants for this partner. Omit/null to leave unchanged.

Array of objects (DomainAuthEntryRequest)

Domain + issuer pairs for this partner; supersedes the deprecated domainName/authServerUrl for multi-domain partners. Omit/null to leave unchanged; when present, replaces the whole list.

Responses

Response Schema: application/json
uid
string

Unique partner identifier, generated server-side.

partnerName
string

Display name of the OEM partner.

accountId
string

The partner's Boomi Platform account ID.

domainName
string
Deprecated

Partner's domain, used to route embed requests.

iframeUrl
string

The OEM parent origin allowed to frame the embed.

authServerUrl
string
Deprecated

The Auth0 (or equivalent OIDC) issuer URL used to verify this partner's embed launch tokens.

apiToken
string
Deprecated

Boomi Platform API token for this partner. SENSITIVE: currently returned as-is (unmasked) by GET/POST/PUT/PATCH /v1/partners — this documents real, current behavior rather than concealing it. Deprecated: superseded by per-child childDetails[].childApiToken; kept as the fallback token for children that don't supply their own.

audience
string

Optional OIDC client id (token aud) used as an additional lookup key for the embed flow.

sessionTimeout
integer <int32>

Session timeout in seconds for this partner's embed sessions.

active
boolean

Whether this partner is active.

createdAt
string

ISO-8601 timestamp this partner record was created.

updatedAt
string

ISO-8601 timestamp this partner record was last updated.

createdBy
string

Identity that created this partner record.

updatedBy
string

Identity that last updated this partner record.

Array of objects (ChildDetails)

Child (sub-)account grants for this partner.

Array of objects (DomainAuthEntry)

Domain + issuer pairs registered for this partner; supersedes the deprecated domainName/authServerUrl for multi-domain partners.

Request samples

Content type
application/json

Update childDetails only

{
  • "childDetails": [
    • {
      }
    ]
}

Response samples

Content type
application/json
{
  • "uid": "8f14e45f-ceea-467e-b7a9-53f68b6bab63",
  • "partnerName": "Acme Corp",
  • "accountId": "acme-ABC123",
  • "iframeUrl": "https://acme.com",
  • "audience": "vQpfuHf8flLMggaCZ7uXzpZwdnDVi4Uh",
  • "sessionTimeout": 1800,
  • "active": true,
  • "createdAt": "2026-01-15T10:30:00Z",
  • "updatedAt": "2026-02-01T09:00:00Z",
  • "createdBy": "admin@boomi.com",
  • "updatedBy": "admin@boomi.com",
  • "childDetails": [
    • {
      }
    ],
  • "domains": []
}

Backfill domains[] from legacy domainName/authServerUrl (data migration)

One-off, manually-triggered migration utility for partners created before the domains[] array existed. Looks up the partner by accountId and, if it still has a legacy domainName+authServerUrl pair not yet reflected in domains[], appends one {domainName, authServerUrl} entry built from that pair. Idempotent: a partner with no legacy pair, or whose domains[] already contains it, is returned unchanged. No other field is touched.

Authorizations:
BoomiJwtBearer
query Parameters
accountId
required
string

The partner's Boomi Platform account ID.

Responses

Response Schema: application/json
uid
string

Unique partner identifier, generated server-side.

partnerName
string

Display name of the OEM partner.

accountId
string

The partner's Boomi Platform account ID.

domainName
string
Deprecated

Partner's domain, used to route embed requests.

iframeUrl
string

The OEM parent origin allowed to frame the embed.

authServerUrl
string
Deprecated

The Auth0 (or equivalent OIDC) issuer URL used to verify this partner's embed launch tokens.

apiToken
string
Deprecated

Boomi Platform API token for this partner. SENSITIVE: currently returned as-is (unmasked) by GET/POST/PUT/PATCH /v1/partners — this documents real, current behavior rather than concealing it. Deprecated: superseded by per-child childDetails[].childApiToken; kept as the fallback token for children that don't supply their own.

audience
string

Optional OIDC client id (token aud) used as an additional lookup key for the embed flow.

sessionTimeout
integer <int32>

Session timeout in seconds for this partner's embed sessions.

active
boolean

Whether this partner is active.

createdAt
string

ISO-8601 timestamp this partner record was created.

updatedAt
string

ISO-8601 timestamp this partner record was last updated.

createdBy
string

Identity that created this partner record.

updatedBy
string

Identity that last updated this partner record.

Array of objects (ChildDetails)

Child (sub-)account grants for this partner.

Array of objects (DomainAuthEntry)

Domain + issuer pairs registered for this partner; supersedes the deprecated domainName/authServerUrl for multi-domain partners.

Response samples

Content type
application/json
{
  • "uid": "8f14e45f-ceea-467e-b7a9-53f68b6bab63",
  • "partnerName": "Acme Corp",
  • "accountId": "acme-ABC123",
  • "iframeUrl": "https://acme.com",
  • "audience": "vQpfuHf8flLMggaCZ7uXzpZwdnDVi4Uh",
  • "sessionTimeout": 1800,
  • "active": true,
  • "createdAt": "2026-01-15T10:30:00Z",
  • "updatedAt": "2026-02-01T09:00:00Z",
  • "createdBy": "admin@boomi.com",
  • "updatedBy": "admin@boomi.com",
  • "childDetails": [
    • {
      }
    ],
  • "domains": []
}

Search/list partners

Returns a paged, optionally filtered/sorted list of partners.

Authorizations:
BoomiJwtBearer
query Parameters
name
string
Example: name=Acme

Case-insensitive partial match on partnerName.

status
any
Enum: "ACTIVE" "INACTIVE"
Example: status=ACTIVE

Filter by active status (repeatable).

dateAdded
string
Enum: "LAST_30_DAYS" "LAST_90_DAYS" "LAST_365_DAYS"
Example: dateAdded=LAST_30_DAYS

Relative date-range filter on createdAt.

dateModified
string
Enum: "LAST_30_DAYS" "LAST_90_DAYS" "LAST_365_DAYS"
Example: dateModified=LAST_90_DAYS

Relative date-range filter on updatedAt.

sort
any
Enum: "partnerName" "status" "createdAt" "updatedAt"
Example: sort=createdAt,desc

Sort column, optionally suffixed with ",desc" for descending order (default ascending, e.g. "createdAt,desc"); unknown columns return 400 INVALID_PARAM.

page
integer <int32>
Default: 0

Zero-based page number.

size
integer <int32>
Default: 10
Example: size=10

Page size.

Responses

Response Schema: application/json
content
Array of any

The items on this page.

page
integer <int32>

Zero-based page number requested.

size
integer <int32>

Requested page size.

totalElements
integer <int64>

Total number of items across all pages.

totalPages
integer <int32>

Total number of pages.

Response samples

Content type
application/json
{
  • "content": [ ],
  • "page": 0,
  • "size": 10,
  • "totalElements": 42,
  • "totalPages": 5
}

Onboard a new OEM partner

Creates a new partner. accountId is validated against the Boomi Platform (ACCOUNT_NOT_FOUND if it doesn't exist); partnerName/accountId must each be unique across active partners. domainName/authServerUrl (and domains[] entries) are not required to be unique — the same domain or issuer may be shared across multiple partners.

Known behavior: validation failures, ACCOUNT_NOT_FOUND, and duplicate-field conflicts are all collected together and currently returned as HTTP 500 (not 422/409), with one entry per problem in errors[] — this documents the service's real, current behavior.

Authorizations:
BoomiJwtBearer
Request Body schema: application/json
required
accountId
required
string

The partner's Boomi Platform account ID. Must exist on the Boomi platform — see the ACCOUNT_NOT_FOUND error case.

authServerUrl
required
string^$|^https://.*
Deprecated

The Auth0 (or equivalent OIDC) issuer URL used to verify this partner's embed launch tokens. May be shared across multiple partners.

domainName
required
string^$|^[a-zA-Z0-9][a-zA-Z0-9\-\.]*\.com$
Deprecated

Partner's domain, used to route embed requests. No scheme; must end in .com.

iframeUrl
required
string^https?://[^\s]+

The OEM parent origin allowed to frame the embed (used for the per-tenant Content-Security-Policy frame-ancestors directive).

partnerName
required
string

Display name of the OEM partner.

apiToken
string^$|^[A-Za-z0-9\-_.]{8,512}$
Deprecated

Boomi Platform API token used server-side to mint platform JWTs for this partner. Optional when every childDetails entry supplies its own childApiToken; falls back to this value where a child token is absent. SENSITIVE: currently returned as-is (unmasked) in every GET/POST/PUT/PATCH /v1/partners response — treat responses containing it accordingly. Deprecated: superseded by childDetails[].childApiToken.

audience
string^$|^[A-Za-z0-9_-]{8,128}$

Optional OIDC client ID (token aud). When set, it is validated against the launch token's aud claim. Note: incoming requests are currently routed by issuer (authServerUrl), regardless of whether this field is provided.

Array of objects (ChildDetailsRequest)

Child (sub-)account grants for this partner. Each childAccountId must already be a shared account of accountId — see CHILD_ACCOUNT_ID_NOT_FOUND.

Array of objects (DomainAuthEntryRequest) [ 0 .. 20 ] items

Domain + issuer pairs to register for this partner; supersedes the deprecated domainName/authServerUrl for multi-domain partners.

Responses

Request samples

Content type
application/json
{
  • "partnerName": "Acme Corp",
  • "accountId": "acme-ABC123",
  • "iframeUrl": "https://acme.com",
  • "audience": "vQpfuHf8flLMggaCZ7uXzpZwdnDVi4Uh",
  • "childDetails": [
    • {
      }
    ],
  • "domains": []
}

Response samples

Content type
application/json
{
  • "uid": "8f14e45f-ceea-467e-b7a9-53f68b6bab63",
  • "partnerName": "Acme Corp",
  • "accountId": "acme-ABC123",
  • "iframeUrl": "https://acme.com",
  • "audience": "vQpfuHf8flLMggaCZ7uXzpZwdnDVi4Uh",
  • "sessionTimeout": 1800,
  • "active": true,
  • "createdAt": "2026-01-15T10:30:00Z",
  • "updatedAt": "2026-02-01T09:00:00Z",
  • "createdBy": "admin@boomi.com",
  • "updatedBy": "admin@boomi.com",
  • "childDetails": [
    • {
      }
    ],
  • "domains": []
}

Activate/deactivate a partner

Toggles a partner's active flag by uid. Despite the Java boolean type, the wire format for active is a JSON integer 0/1, not true/false — see the 422 response below.

Authorizations:
BoomiJwtBearer
Request Body schema: application/json
required
active
required
integer <int32> [ 0 .. 1 ]

The desired active status. Note: despite the internal Java boolean type, the wire format requires a JSON integer (0 for inactive, 1 for active). Standard JSON boolean values (true/false) will be rejected with an HTTP 400 error by a custom deserializer.

uid
required
string

Partner uid to update.

Responses

Response Schema: application/json
uid
string

Unique partner identifier, generated server-side.

partnerName
string

Display name of the OEM partner.

accountId
string

The partner's Boomi Platform account ID.

domainName
string
Deprecated

Partner's domain, used to route embed requests.

iframeUrl
string

The OEM parent origin allowed to frame the embed.

authServerUrl
string
Deprecated

The Auth0 (or equivalent OIDC) issuer URL used to verify this partner's embed launch tokens.

apiToken
string
Deprecated

Boomi Platform API token for this partner. SENSITIVE: currently returned as-is (unmasked) by GET/POST/PUT/PATCH /v1/partners — this documents real, current behavior rather than concealing it. Deprecated: superseded by per-child childDetails[].childApiToken; kept as the fallback token for children that don't supply their own.

audience
string

Optional OIDC client id (token aud) used as an additional lookup key for the embed flow.

sessionTimeout
integer <int32>

Session timeout in seconds for this partner's embed sessions.

active
boolean

Whether this partner is active.

createdAt
string

ISO-8601 timestamp this partner record was created.

updatedAt
string

ISO-8601 timestamp this partner record was last updated.

createdBy
string

Identity that created this partner record.

updatedBy
string

Identity that last updated this partner record.

Array of objects (ChildDetails)

Child (sub-)account grants for this partner.

Array of objects (DomainAuthEntry)

Domain + issuer pairs registered for this partner; supersedes the deprecated domainName/authServerUrl for multi-domain partners.

Request samples

Content type
application/json
{
  • "uid": "8f14e45f-ceea-467e-b7a9-53f68b6bab63",
  • "active": 1
}

Response samples

Content type
application/json
{
  • "uid": "8f14e45f-ceea-467e-b7a9-53f68b6bab63",
  • "partnerName": "Acme Corp",
  • "accountId": "acme-ABC123",
  • "iframeUrl": "https://acme.com",
  • "audience": "vQpfuHf8flLMggaCZ7uXzpZwdnDVi4Uh",
  • "sessionTimeout": 1800,
  • "active": true,
  • "createdAt": "2026-01-15T10:30:00Z",
  • "updatedAt": "2026-02-01T09:00:00Z",
  • "createdBy": "admin@boomi.com",
  • "updatedBy": "admin@boomi.com",
  • "childDetails": [
    • {
      }
    ],
  • "domains": []
}

Clear a stale default Space GUID

Called by catalog-service when a Space is deleted, so any child account's defaultSpaceGuid pointing at that space is removed.

Authorizations:
BoomiJwtBearer
Request Body schema: application/json
required
accountId
required
string

The parent (OEM) account whose childDetails entries should be checked.

spaceGuid
required
string

The deleted Space's GUID; cleared from any childDetails.defaultSpaceGuid entry that currently points at it.

Responses

Response Schema: application/json
uid
string

Unique partner identifier, generated server-side.

partnerName
string

Display name of the OEM partner.

accountId
string

The partner's Boomi Platform account ID.

domainName
string
Deprecated

Partner's domain, used to route embed requests.

iframeUrl
string

The OEM parent origin allowed to frame the embed.

authServerUrl
string
Deprecated

The Auth0 (or equivalent OIDC) issuer URL used to verify this partner's embed launch tokens.

apiToken
string
Deprecated

Boomi Platform API token for this partner. SENSITIVE: currently returned as-is (unmasked) by GET/POST/PUT/PATCH /v1/partners — this documents real, current behavior rather than concealing it. Deprecated: superseded by per-child childDetails[].childApiToken; kept as the fallback token for children that don't supply their own.

audience
string

Optional OIDC client id (token aud) used as an additional lookup key for the embed flow.

sessionTimeout
integer <int32>

Session timeout in seconds for this partner's embed sessions.

active
boolean

Whether this partner is active.

createdAt
string

ISO-8601 timestamp this partner record was created.

updatedAt
string

ISO-8601 timestamp this partner record was last updated.

createdBy
string

Identity that created this partner record.

updatedBy
string

Identity that last updated this partner record.

Array of objects (ChildDetails)

Child (sub-)account grants for this partner.

Array of objects (DomainAuthEntry)

Domain + issuer pairs registered for this partner; supersedes the deprecated domainName/authServerUrl for multi-domain partners.

Request samples

Content type
application/json
{
  • "accountId": "acme-ABC123",
  • "spaceGuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6"
}

Response samples

Content type
application/json
{
  • "uid": "8f14e45f-ceea-467e-b7a9-53f68b6bab63",
  • "partnerName": "Acme Corp",
  • "accountId": "acme-ABC123",
  • "iframeUrl": "https://acme.com",
  • "audience": "vQpfuHf8flLMggaCZ7uXzpZwdnDVi4Uh",
  • "sessionTimeout": 1800,
  • "active": true,
  • "createdAt": "2026-01-15T10:30:00Z",
  • "updatedAt": "2026-02-01T09:00:00Z",
  • "createdBy": "admin@boomi.com",
  • "updatedBy": "admin@boomi.com",
  • "childDetails": [
    • {
      }
    ],
  • "domains": []
}

Look up the caller's own partner record

Resolves the partner record for the caller's own account (accountId taken from the caller's JWT). Used by the publisher UI's Embeddable settings screen to show whether the logged-in account is already onboarded, and its full config if so.

Authorizations:
BoomiJwtBearer

Responses

Response Schema: application/json
object (Partner)

The caller's partner record, or null when the caller's account is not yet onboarded as a partner.

uid
string

Unique partner identifier, generated server-side.

partnerName
string

Display name of the OEM partner.

accountId
string

The partner's Boomi Platform account ID.

domainName
string
Deprecated

Partner's domain, used to route embed requests.

iframeUrl
string

The OEM parent origin allowed to frame the embed.

authServerUrl
string
Deprecated

The Auth0 (or equivalent OIDC) issuer URL used to verify this partner's embed launch tokens.

apiToken
string
Deprecated

Boomi Platform API token for this partner. SENSITIVE: currently returned as-is (unmasked) by GET/POST/PUT/PATCH /v1/partners — this documents real, current behavior rather than concealing it. Deprecated: superseded by per-child childDetails[].childApiToken; kept as the fallback token for children that don't supply their own.

audience
string

Optional OIDC client id (token aud) used as an additional lookup key for the embed flow.

sessionTimeout
integer <int32>

Session timeout in seconds for this partner's embed sessions.

active
boolean

Whether this partner is active.

createdAt
string

ISO-8601 timestamp this partner record was created.

updatedAt
string

ISO-8601 timestamp this partner record was last updated.

createdBy
string

Identity that created this partner record.

updatedBy
string

Identity that last updated this partner record.

Array of objects (ChildDetails)

Child (sub-)account grants for this partner.

Array of objects (DomainAuthEntry)

Domain + issuer pairs registered for this partner; supersedes the deprecated domainName/authServerUrl for multi-domain partners.

Response samples

Content type
application/json
{
  • "partner": {
    • "uid": "8f14e45f-ceea-467e-b7a9-53f68b6bab63",
    • "partnerName": "Acme Corp",
    • "accountId": "acme-ABC123",
    • "active": true
    }
}

Resolve the embed redirect URL for a child user

Returns the Catalog consumer URL the caller should redirect to for this accountId/childEmailId. Response is a plain string, not JSON.

Authorizations:
BoomiJwtBearer
query Parameters
accountId
required
string

The partner's Boomi Platform account ID.

childEmailId
required
string

The child user's email address.

Responses

Response Schema: text/plain
any

Response samples

Content type
text/plain
https://scratch.space-service.cj-sandbox.boomi.com?guid