Create a new integration

Creates a new integration and returns it.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required
length between 2 and 50

Display name for the integration

allowedDurations
array of objects | null, unique

Allowed durations (in seconds) for access requests to resources in this integration. If omitted or set to null, company defaults are used. Empty array is not allowed. Values must be from the predefined enum.

boolean

Allow actors to self-map accounts.

boolean

You must provide either requestable & requestableByDefault OR allowRequests & allowRequestsByDefault.

boolean

You must provide either requestable & requestableByDefault OR allowRequests & allowRequestsByDefault.

boolean

You must provide either requestable & requestableByDefault OR allowRequests & allowRequestsByDefault.

boolean

You must provide either requestable & requestableByDefault OR allowRequests & allowRequestsByDefault.

boolean
required

Auto-assign recommended maintainers.

boolean
required

Auto-assign recommended owners.

boolean
required

Notify on external permission changes.

workflow
object
required

Workflow to associate with this integration (object with 'id' UUID). To get available workflow IDs, use GET /public/v1/workflows.

owner
object
required

Owner of the integration (user entity object). To get user entities, use GET /public/v1/users. Provide an object with 'id' (UUID) or 'email' (string) to identify the user.

maintainers
array of objects
required

Maintainers of the integration. Each maintainer can be either a user or a group. For users, use GET /public/v1/users to get user IDs. For groups, use GET /public/v1/directoryGroups to get group IDs. Provide objects with 'type' ('user' or 'group') and 'id' (UUID).

maintainers*
prerequisitePermissions
array of arrays of objects
required

Prerequisite permissions grouped by any-of/all-of sets. Outer array represents OR logic (any set can match), inner arrays represent AND logic (all permissions in a set must match). To get role permission IDs, use GET /public/v1/roles?resourceId=.

prerequisitePermissions*
application
object
required

Application to integrate (object with 'name'). For connector-backed integrations, use an application name from GET /public/v1/applications (e.g., 'Google Groups', 'Okta', 'AWS'). For adapterless integrations, use special values: 'Virtual Application' for virtual integrations or 'Manual' for manual integrations. Virtual integrations are for modeling external systems without a connector. Manual integrations are for purely manual access management.

agentToken
object
required

On-premises agent token to route this integration through (object with 'name'). Only required for integrations that need to connect through an on-premises agent.

boolean
required

Allow changing account permissions via the integration.

boolean
required

Allow creating accounts via the integration.

boolean
required

Marks the integration as read-only.

connectionJson
object | null

Connector configuration JSON containing credentials and settings specific to the application type. Required for connector-backed integrations (e.g., API keys, OAuth tokens, service account credentials). Set to null for adapterless integrations ('Virtual Application' or 'Manual'). The structure varies by application - refer to the specific connector documentation for required fields.

Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

©2003-2026 BeyondTrust Corporation. All Rights Reserved. Other trademarks identified on this page are owned by their respective owners. BeyondTrust is not a chartered bank or trust company, or depository institution. It is not authorized to accept deposits or trust accounts and is not licensed or regulated by any state or federal banking authority.