Skip to main content

Configuration

Manage tenant-level configuration settings for your API Control Plane instance.

General configuration​

Get general configuration​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/config/general" \
  -H "Authorization: Bearer <your-token>"

Update general configuration​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/config/general" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    ...
  }'

SAML configuration​

Configure SAML-based single sign-on.

Get SAML configuration​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/config/saml" \
  -H "Authorization: Bearer <your-token>"

Update SAML configuration​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/config/saml" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    ...
  }'

Get SAML service provider settings​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/config/saml/serviceProvider" \
  -H "Authorization: Bearer <your-token>"

OIDC configuration​

Configure OpenID Connect-based single sign-on.

Get OIDC configuration​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/config/oidc" \
  -H "Authorization: Bearer <your-token>"

Update OIDC configuration​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/config/oidc" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    ...
  }'

LDAP configuration​

Configure LDAP directory integration.

Get LDAP configuration​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/config/ldap" \
  -H "Authorization: Bearer <your-token>"

Update LDAP configuration​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/config/ldap" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    ...
  }'

Approval request configuration​

Configure how subscription approvals work.

Get approval configuration​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/config/approvalRequests" \
  -H "Authorization: Bearer <your-token>"

Update approval configuration​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/config/approvalRequests" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    ...
  }'

Enterprise settings​

Get enterprise settings​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/config/enterprise" \
  -H "Authorization: Bearer <your-token>"

AI terms configuration​

Get AI terms configuration​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/config/aiTerms" \
  -H "Authorization: Bearer <your-token>"

Update AI terms configuration​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/config/aiTerms" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    ...
  }'

Discovery configuration​

Get discovery configuration​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/config/discovery" \
  -H "Authorization: Bearer <your-token>"

Update discovery configuration​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/config/discovery" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    ...
  }'

Git credentials​

Manage credentials for Git repository integrations.

List Git credentials​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/gitCredentials?page=1&size=10" \
  -H "Authorization: Bearer <your-token>"

Create a Git credential​

curl -X POST "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/gitCredentials" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "github-token",
    "displayName": "GitHub Token"
  }'

Get a Git credential​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/gitCredentials/<credential-id>" \
  -H "Authorization: Bearer <your-token>"

Update a Git credential​

curl -X PUT "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/gitCredentials/<credential-id>" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "github-token",
    "displayName": "GitHub Token (Updated)"
  }'

Delete a Git credential​

curl -X DELETE "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/gitCredentials/<credential-id>" \
  -H "Authorization: Bearer <your-token>"

Billing information​

Get billing info​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/config/billing" \
  -H "Authorization: Bearer <your-token>"

Current tenant​

Get current tenant info​

curl -X GET "https://<your-subdomain>.backend.<region>.controlplane.boomi.com/currentTenant" \
  -H "Authorization: Bearer <your-token>"