Boomi Data Integration API Reference (1.0.0) - Accounts

Toggle Pane

• Accounts
  • putAdd Or Update Scim Provisioning
  • delDelete Scim Provisioning
  • getGet Scim Provisioning Status

API docs by Redocly

Download OpenAPI Specification: Download

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

Find out more about Data Integration

Accounts

Listing accounts

Add Or Update Scim Provisioning

Authorization scope: account:write

Add or update SCIM provisioning. This endpoint returns the connection string used to communicate with your SCIM app and the authentication token

Authorizations:

HTTPBearer

path Parameters

account_id required

string (Account Id)

Responses

Response Schema: application/json

account_id required	string (Account Id) The account id
scim_service_url required	string (Scim Service Url) The connection string (URL) used to communicate with your SCIM app
token required	string (Token) The SCIM authentication token. Keep the token somewhere safe. The token will be shown only once.

US

https://api.rivery.io/v1/accounts/{account_id}/scim_provisioning

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/scim_provisioning

Response samples

• 200
• 422

Content type

application/json

{

• "account_id": "65c2465a76ba59de1a868a4e",
• "scim_service_url": "https://rivery-scim.rivery.io",
• "token": "1234"

}

Delete Scim Provisioning

Authorization scope: account:write

Deletes the scim provisioning. This endpoint won't delete any existing resource that were already sync by the SCIM.

Authorizations:

HTTPBearer

path Parameters

account_id required

string (Account Id)

Responses

US

https://api.rivery.io/v1/accounts/{account_id}/scim_provisioning

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/scim_provisioning

Response samples

• 422

Content type

application/json

{

• "detail": [

  • {

    • "loc": [

      • "string"

      ],
    • "msg": "string",
    • "type": "string"

    }

  ]

}

Get Scim Provisioning Status

Authorization scope: account:write

Get SCIM provisioning status

Authorizations:

HTTPBearer

path Parameters

account_id required

string (Account Id)

Responses

Response Schema: application/json

account_id required	string (Account Id) The account id
is_enabled required	boolean (Is Enabled) A flag that indicates whether SCIM provisioning is enabled
scim_service_url required	string (Scim Service Url) The connection string (URL) used to communicate with your SCIM app

US

https://api.rivery.io/v1/accounts/{account_id}/scim_provisioning

EU

https://api.eu-west-1.rivery.io/v1/accounts/{account_id}/scim_provisioning

Response samples

• 200
• 422

Content type

application/json

{

• "account_id": "65c2465a76ba59de1a868a4e",
• "is_enabled": true,
• "scim_service_url": "https://rivery-scim.rivery.io"

}