Create Multi-Host Integration

POST 
https://sailpoint.api.identitynow.com/v2025/multihosts

This API is used to create Multi-Host Integration. Multi-host Integration holds similar types of sources.

A token with Org Admin or Multi-Host Admin authority is required to access this endpoint.

Request

application/json

Bodyrequired

The specifics of the Multi-Host Integration to create

namestringrequired
Multi-Host Integration's human-readable name.
Example: My Multi-Host Integration
descriptionstringrequired
Multi-Host Integration's human-readable description.
Example: This is the Multi-Host Integration.
owner objectrequired
Reference to identity object who owns the source.
typestring
Type of object being referenced.
Possible values: [IDENTITY]
Example: IDENTITY
idstring
Owner identity's ID.
Example: 2c91808568c529c60168cca6f90c1313
namestring
Owner identity's human-readable display name.
Example: MyName
cluster objectnullable
Reference to the source's associated cluster.
typestringrequired
Type of object being referenced.
Possible values: [CLUSTER]
Example: CLUSTER
idstringrequired
Cluster ID.
Example: 2c9180866166b5b0016167c32ef31a66
namestringrequired
Cluster's human-readable display name.
Example: Corporate Cluster
connectorstringrequired
Connector script name.
Example: multihost-microsoft-sql-server
connectorAttributes object
Multi-Host Integration specific configuration. User can add any number of additional attributes. e.g. maxSourcesPerAggGroup, maxAllowedSources etc.
property name*any
Multi-Host Integration specific configuration. User can add any number of additional attributes. e.g. maxSourcesPerAggGroup, maxAllowedSources etc.
Example: {"maxSourcesPerAggGroup":10,"maxAllowedSources":300}
managementWorkgroup objectnullable
Reference to management workgroup for the source.
typestring
Type of object being referenced.
Possible values: [GOVERNANCE_GROUP]
Example: GOVERNANCE_GROUP
idstring
Management workgroup ID.
Example: 2c91808568c529c60168cca6f90c2222
namestring
Management workgroup's human-readable display name.
Example: My Management Workgroup
createddate-time
Date-time when the source was created
Example: 2022-02-08T14:50:03.827Z
modifieddate-time
Date-time when the source was last modified.
Example: 2024-01-23T18:08:50.897Z

Responses

201

OK. Returned if the request was successfully accepted into the system.

application/json

Schema

Schema

idstringrequired
Multi-Host Integration ID.
Example: 2c91808568c529c60168cca6f90c1324
namestringrequired
Multi-Host Integration's human-readable name.
Example: My Multi-Host Integration
descriptionstringrequired
Multi-Host Integration's human-readable description.
Example: This is a Multi-Host Integration.
owner objectrequired
Reference to identity object who owns the source.
typestring
Type of object being referenced.
Possible values: [IDENTITY]
Example: IDENTITY
idstring
Owner identity's ID.
Example: 2c91808568c529c60168cca6f90c1313
namestring
Owner identity's human-readable display name.
Example: MyName
cluster objectnullable
Reference to the source's associated cluster.
typestringrequired
Type of object being referenced.
Possible values: [CLUSTER]
Example: CLUSTER
idstringrequired
Cluster ID.
Example: 2c9180866166b5b0016167c32ef31a66
namestringrequired
Cluster's human-readable display name.
Example: Corporate Cluster
accountCorrelationConfig objectnullable
Reference to account correlation config object.
typestring
Type of object being referenced.
Possible values: [ACCOUNT_CORRELATION_CONFIG]
Example: ACCOUNT_CORRELATION_CONFIG
idstring
Account correlation config ID.
Example: 2c9180855d191c59015d28583727245a
namestring
Account correlation config's human-readable display name.
Example: Directory [source-62867] Account Correlation
accountCorrelationRule objectnullable
Reference to a rule that can do COMPLEX correlation. Only use this rule when you can't use accountCorrelationConfig.
typestring
Type of object being referenced.
Possible values: [RULE]
Example: RULE
idstring
Rule ID.
Example: 2c918085708c274401708c2a8a760001
namestring
Rule's human-readable display name.
Example: Example Rule
managerCorrelationMapping objectnullable
Filter object used during manager correlation to match incoming manager values to an existing manager's account/identity.
accountAttributeNamestring
Name of the attribute to use for manager correlation. The value found on the account attribute will be used to lookup the manager's identity.
Example: manager
identityAttributeNamestring
Name of the identity attribute to search when trying to find a manager using the value from the accountAttribute.
Example: manager
managerCorrelationRule objectnullable
Reference to the ManagerCorrelationRule. Only use this rule when a simple filter isn't sufficient.
typestring
Type of object being referenced.
Possible values: [RULE]
Example: RULE
idstring
Rule ID.
Example: 2c918085708c274401708c2a8a760001
namestring
Rule's human-readable display name.
Example: Example Rule
beforeProvisioningRule objectnullable
Rule that runs on the CCG and allows for customization of provisioning plans before the API calls the connector.
typestring
Type of object being referenced.
Possible values: [RULE]
Example: RULE
idstring
Rule ID.
Example: 2c918085708c274401708c2a8a760001
namestring
Rule's human-readable display name.
Example: Example Rule
schemas object[]
List of references to schema objects.
Array [
typestring
Type of object being referenced.
Possible values: [CONNECTOR_SCHEMA]
Example: CONNECTOR_SCHEMA
idstring
Schema ID.
Example: 2c91808568c529c60168cca6f90c1777
namestring
Schema's human-readable display name.
Example: MySchema
]
passwordPolicies object[]nullable
List of references to the associated PasswordPolicy objects.
Array [
typestring
Type of object being referenced.
Possible values: [PASSWORD_POLICY]
Example: PASSWORD_POLICY
idstring
Policy ID.
Example: 2c91808568c529c60168cca6f90c1777
namestring
Policy's human-readable display name.
Example: My Password Policy
]
featuresstring[]
Optional features that can be supported by a source. Modifying the features array may cause source configuration errors that are unsupportable. It is recommended to not modify this array for SailPoint supported connectors.
• AUTHENTICATE: The source supports pass-through authentication.
• COMPOSITE: The source supports composite source creation.
• DIRECT_PERMISSIONS: The source supports returning DirectPermissions.
• DISCOVER_SCHEMA: The source supports discovering schemas for users and groups.
• ENABLE The source supports reading if an account is enabled or disabled.
• MANAGER_LOOKUP: The source supports looking up managers as they are encountered in a feed. This is the opposite of NO_RANDOM_ACCESS.
• NO_RANDOM_ACCESS: The source does not support random access and the getObject() methods should not be called and expected to perform.
• PROXY: The source can serve as a proxy for another source. When an source has a proxy, all connector calls made with that source are redirected through the connector for the proxy source.
• SEARCH
• TEMPLATE
• UNLOCK: The source supports reading if an account is locked or unlocked.
• UNSTRUCTURED_TARGETS: The source supports returning unstructured Targets.
• SHAREPOINT_TARGET: The source supports returning unstructured Target data for SharePoint. It will be typically used by AD, LDAP sources.
• PROVISIONING: The source can both read and write accounts. Having this feature implies that the provision() method is implemented. It also means that direct and target permissions can also be provisioned if they can be returned by aggregation.
• GROUP_PROVISIONING: The source can both read and write groups. Having this feature implies that the provision() method is implemented.
• SYNC_PROVISIONING: The source can provision accounts synchronously.
• PASSWORD: The source can provision password changes. Since sources can never read passwords, this is should only be used in conjunction with the PROVISIONING feature.
• CURRENT_PASSWORD: Some source types support verification of the current password
• ACCOUNT_ONLY_REQUEST: The source supports requesting accounts without entitlements.
• ADDITIONAL_ACCOUNT_REQUEST: The source supports requesting additional accounts.
• NO_AGGREGATION: A source that does not support aggregation.
• GROUPS_HAVE_MEMBERS: The source models group memberships with a member attribute on the group object rather than a groups attribute on the account object. This effects the implementation of delta account aggregation.
• NO_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for accounts. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for accounts.
• NO_GROUP_PERMISSIONS_PROVISIONING: Indicates that the connector cannot provision direct or target permissions for groups. When DIRECT_PERMISSIONS and PROVISIONING features are present, it is assumed that the connector can also provision direct permissions. This feature disables that assumption and causes permission request to be converted to work items for groups.
• NO_UNSTRUCTURED_TARGETS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.
• NO_DIRECT_PERMISSIONS_PROVISIONING: This string will be replaced by NO_GROUP_PERMISSIONS_PROVISIONING and NO_PERMISSIONS_PROVISIONING.
• USES_UUID: Connectivity 2.0 flag used to indicate that the connector supports a compound naming structure.
• PREFER_UUID: Used in ISC Provisioning AND Aggregation to decide if it should prefer account.uuid to account.nativeIdentity when data is read in through aggregation OR pushed out through provisioning.
• ARM_SECURITY_EXTRACT: Indicates the application supports Security extracts for ARM
• ARM_UTILIZATION_EXTRACT: Indicates the application supports Utilization extracts for ARM
• ARM_CHANGELOG_EXTRACT: Indicates the application supports Change-log extracts for ARM
Possible values: [AUTHENTICATE, COMPOSITE, DIRECT_PERMISSIONS, DISCOVER_SCHEMA, ENABLE, MANAGER_LOOKUP, NO_RANDOM_ACCESS, PROXY, SEARCH, TEMPLATE, UNLOCK, UNSTRUCTURED_TARGETS, SHAREPOINT_TARGET, PROVISIONING, GROUP_PROVISIONING, SYNC_PROVISIONING, PASSWORD, CURRENT_PASSWORD, ACCOUNT_ONLY_REQUEST, ADDITIONAL_ACCOUNT_REQUEST, NO_AGGREGATION, GROUPS_HAVE_MEMBERS, NO_PERMISSIONS_PROVISIONING, NO_GROUP_PERMISSIONS_PROVISIONING, NO_UNSTRUCTURED_TARGETS_PROVISIONING, NO_DIRECT_PERMISSIONS_PROVISIONING, PREFER_UUID, ARM_SECURITY_EXTRACT, ARM_UTILIZATION_EXTRACT, ARM_CHANGELOG_EXTRACT, USES_UUID, APPLICATION_DISCOVERY]
Example: ["PROVISIONING","NO_PERMISSIONS_PROVISIONING","GROUPS_HAVE_MEMBERS"]
typestring
Specifies the type of system being managed e.g. Workday, Multi-Host - Microsoft SQL Server, etc.. If you are creating a delimited file source, you must set the provisionasCsv query parameter to true.
Example: Multi-Host - Microsoft SQL Server
connectorstringrequired
Connector script name.
Example: multihost-microsoft-sql-server
connectorClassstring
Fully qualified name of the Java class that implements the connector interface.
Example: sailpoint.connector.OpenConnectorAdapter
connectorAttributes object
Connector specific configuration. This configuration will differ for Multi-Host Integration type.
maxAllowedSourcesint32
Maximum sources allowed count of a Multi-Host Integration
Example: 250
lastSourceUploadCountint32
Last upload sources count of a Multi-Host Integration
Example: 40
connectorFileUploadHistory object
connectorFileNameUploadedDatestring
File name of the connector JAR
Example: 2024-08-29T10:20:38.896479Z
multihost_statusstring
Multi-Host integration status.
Possible values: [ready, processing, fileUploadInProgress, sourceCreationInProgress, aggregationGroupingInProgress, aggregationScheduleInProgress, deleteInProgress, deleteFailed]
Example: ready
showAccountSchemaboolean
Show account schema
Default value: true
Example: true
showEntitlementSchemaboolean
Show entitlement schema
Default value: true
Example: true
multiHostAttributes object
Attributes of Multi-Host Integration
passwordstring
Password.
Example: Password
connector_filesstring
Connector file.
Example: mssql-jdbc-8.4.1.jre8.jar
authTypestring
Authentication type.
Example: SQLAuthentication
userstring
Username.
Example: My Username
property name*string
deleteThresholdint32
Number from 0 to 100 that specifies when to skip the delete phase.
Possible values: >= 0 and <= 100
Example: 10
authoritativeboolean
When this is true, it indicates that the source is referenced by an identity profile.
Default value: false
Example: false
managementWorkgroup objectnullable
Reference to management workgroup for the source.
typestring
Type of object being referenced.
Possible values: [GOVERNANCE_GROUP]
Example: GOVERNANCE_GROUP
idstring
Management workgroup ID.
Example: 2c91808568c529c60168cca6f90c2222
namestring
Management workgroup's human-readable display name.
Example: My Management Workgroup
healthyboolean
When this is true, it indicates that the source is healthy.
Default value: false
Example: true
statusstring
Status identifier that gives specific information about why a source is or isn't healthy.
Possible values: [SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT, SOURCE_STATE_ERROR_CLUSTER, SOURCE_STATE_ERROR_SOURCE, SOURCE_STATE_ERROR_VA, SOURCE_STATE_FAILURE_CLUSTER, SOURCE_STATE_FAILURE_SOURCE, SOURCE_STATE_HEALTHY, SOURCE_STATE_UNCHECKED_CLUSTER, SOURCE_STATE_UNCHECKED_CLUSTER_NO_SOURCES, SOURCE_STATE_UNCHECKED_SOURCE, SOURCE_STATE_UNCHECKED_SOURCE_NO_ACCOUNTS]
Example: SOURCE_STATE_HEALTHY
sincedate-time
Timestamp that shows when a source health check was last performed.
Example: 2021-09-28T15:48:29.380Z
connectorIdstring
Connector ID
Example: multihost-microsoft-sql-server
connectorNamestring
Name of the connector that was chosen during source creation.
Example: Multi-Host Microsoft SQL Server
connectionTypestring
Type of connection (direct or file).
Possible values: [direct, file]
Example: direct
connectorImplementationIdstring
Connector implementation ID.
Example: multihost-microsoft-sql-server
createddate-time
Date-time when the source was created
Example: 2022-02-08T14:50:03.827Z
modifieddate-time
Date-time when the source was last modified.
Example: 2024-01-23T18:08:50.897Z
credentialProviderEnabledboolean
If this is true, it enables a credential provider for the source. If credentialProvider is turned on, then the source can use credential provider(s) to fetch credentials.
Default value: false
Example: false
categorystringnullable
Source category (e.g. null, CredentialProvider).
Default value: null
Example: CredentialProvider
accountsFile objectnullable
Reference to accounts file for the source.
namestring
Name of the accounts file.
Example: My Accounts File
keystring
The accounts file key.
Example: 2c91808568c529c60168cca6f90c2222
uploadTimedate-time
Date-time when the file was uploaded
Example: 2022-02-08T14:50:03.827Z
expirydate-time
Date-time when the accounts file expired.
Example: 2022-02-08T14:50:03.827Z
expiredboolean
If this is true, it indicates that the accounts file has expired.
Default value: false
Example: false

Example (auto)

{
  "id": "2c91808568c529c60168cca6f90c1324",
  "name": "My Multi-Host Integration",
  "description": "This is a Multi-Host Integration.",
  "owner": {
    "type": "IDENTITY",
    "id": "2c91808568c529c60168cca6f90c1313",
    "name": "MyName"
  },
  "cluster": {
    "type": "CLUSTER",
    "id": "2c9180866166b5b0016167c32ef31a66",
    "name": "Corporate Cluster"
  },
  "accountCorrelationConfig": {
    "type": "ACCOUNT_CORRELATION_CONFIG",
    "id": "2c9180855d191c59015d28583727245a",
    "name": "Directory [source-62867] Account Correlation"
  },
  "accountCorrelationRule": {
    "type": "RULE",
    "id": "2c918085708c274401708c2a8a760001",
    "name": "Example Rule"
  },
  "managerCorrelationMapping": {
    "accountAttributeName": "manager",
    "identityAttributeName": "manager"
  },
  "managerCorrelationRule": {
    "type": "RULE",
    "id": "2c918085708c274401708c2a8a760001",
    "name": "Example Rule"
  },
  "beforeProvisioningRule": {
    "type": "RULE",
    "id": "2c918085708c274401708c2a8a760001",
    "name": "Example Rule"
  },
  "schemas": [
    {
      "type": "CONNECTOR_SCHEMA",
      "id": "2c9180835d191a86015d28455b4b232a",
      "name": "account"
    },
    {
      "type": "CONNECTOR_SCHEMA",
      "id": "2c9180835d191a86015d28455b4b232b",
      "name": "group"
    }
  ],
  "passwordPolicies": [
    {
      "type": "PASSWORD_POLICY",
      "id": "2c9180855d191c59015d291ceb053980",
      "name": "Corporate Password Policy"
    },
    {
      "type": "PASSWORD_POLICY",
      "id": "2c9180855d191c59015d291ceb057777",
      "name": "Vendor Password Policy"
    }
  ],
  "features": [
    "PROVISIONING",
    "NO_PERMISSIONS_PROVISIONING",
    "GROUPS_HAVE_MEMBERS"
  ],
  "type": "Multi-Host - Microsoft SQL Server",
  "connector": "multihost-microsoft-sql-server",
  "connectorClass": "sailpoint.connector.OpenConnectorAdapter",
  "connectorAttributes": {
    "multiHostAttributes": {
      "password": "Password",
      "user": "Username",
      "connector_files": "mssql-jdbc-8.4.1.jre8.jar",
      "authType": "SQLAuthentication"
    },
    "connectorFileUploadHistory": {
      "connectorFileNameUploadedDate": "2024-08-29T10:20:38.896479Z"
    },
    "maxAllowedSources": 30,
    "lastSourceUploadCount": 50,
    "showEntitlementSchema": true,
    "showAccountSchema": true,
    "multihost_status": "ready"
  },
  "deleteThreshold": 10,
  "authoritative": false,
  "managementWorkgroup": {
    "type": "GOVERNANCE_GROUP",
    "id": "2c91808568c529c60168cca6f90c2222",
    "name": "My Management Workgroup"
  },
  "healthy": true,
  "status": "SOURCE_STATE_HEALTHY",
  "since": "2021-09-28T15:48:29.380Z",
  "connectorId": "multihost-microsoft-sql-server",
  "connectorName": "Multi-Host Microsoft SQL Server",
  "connectionType": "direct",
  "connectorImplementationId": "multihost-microsoft-sql-server",
  "created": "2022-02-08T14:50:03.827Z",
  "modified": "2024-01-23T18:08:50.897Z",
  "credentialProviderEnabled": false,
  "category": "CredentialProvider",
  "accountsFile": {
    "name": "My Accounts File",
    "key": "2c91808568c529c60168cca6f90c2222",
    "uploadTime": "2022-02-08T14:50:03.827Z",
    "expiry": "2022-02-08T14:50:03.827Z",
    "expired": false
  }
}

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

401

Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.

application/json

Schema

Schema

error
A message describing the error
Example: JWT validation failed: JWT is expired

Example (auto)

{
  "error": "JWT validation failed: JWT is expired"
}

403

Forbidden - Returned if the user you are running as, doesn't have access to this end-point.

application/json

Schema

Schema

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

403

An example of a 403 response object

{
  "detailCode": "403 Forbidden",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server understood the request but refuses to authorize it."
    }
  ]
}

404

Not Found - returned if the request URL refers to a resource or object that does not exist

application/json

Schema

Schema

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

404

An example of a 404 response object

{
  "detailCode": "404 Not found",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The server did not find a current representation for the target resource."
    }
  ]
}

429

Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.

application/json

Schema

Schema

message
A message describing the error
Example: Rate Limit Exceeded

Example (auto)

{
  "message": " Rate Limit Exceeded "
}

500

Internal Server Error - Returned if there is an unexpected error.

application/json

Schema

Schema

detailCodestring
Fine-grained error code providing more detail of the error.
Example: 400.1 Bad Request Content
trackingIdstring
Unique tracking id for the error.
Example: e7eab60924f64aa284175b9fa3309599
messages object[]
Generic localized reason for error
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]
causes object[]
Plain-text descriptive reasons to provide additional detail to the text provided in the messages field
Array [
localestringnullable
The locale for the message text, a BCP 47 language tag.
Example: en-US
localeOriginstringnullable
An indicator of how the locale was selected. DEFAULT means the locale is the system default. REQUEST means the locale was selected from the request context (i.e., best match based on the Accept-Language header). Additional values may be added in the future without notice.
Possible values: [DEFAULT, REQUEST, null]
Example: DEFAULT
textstring
Actual text of the error message in the indicated locale.
Example: The request was syntactically correct but its content is semantically invalid.
]

Example (auto)

{
  "detailCode": "400.1 Bad Request Content",
  "trackingId": "e7eab60924f64aa284175b9fa3309599",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ],
  "causes": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "The request was syntactically correct but its content is semantically invalid."
    }
  ]
}

500

An example of a 500 response object

{
  "detailCode": "500.0 Internal Fault",
  "trackingId": "b21b1f7ce4da4d639f2c62a57171b427",
  "messages": [
    {
      "locale": "en-US",
      "localeOrigin": "DEFAULT",
      "text": "An internal fault occurred."
    }
  ]
}

Authorization: oauth2

type: Personal Access Token
scopes: idn:multihosts:create, idn:sources:create

• go
• powershell
  SailPoint SDK
• python
  SailPoint SDK
• csharp
• curl
• dart
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• r
• ruby
• rust
• shell
• swift

• NATIVE

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://sailpoint.api.identitynow.com/v2025/multihosts"
  method := "POST"

  payload := strings.NewReader(`{
  "name": "My Multi-Host Integration",
  "description": "This is the Multi-Host Integration.",
  "owner": {
    "type": "IDENTITY",
    "id": "2c91808568c529c60168cca6f90c1313",
    "name": "MyName"
  },
  "cluster": {
    "type": "CLUSTER",
    "id": "2c9180866166b5b0016167c32ef31a66",
    "name": "Corporate Cluster"
  },
  "connector": "multihost-microsoft-sql-server",
  "connectorAttributes": {
    "maxSourcesPerAggGroup": 10,
    "maxAllowedSources": 300
  },
  "managementWorkgroup": {
    "type": "GOVERNANCE_GROUP",
    "id": "2c91808568c529c60168cca6f90c2222",
    "name": "My Management Workgroup"
  },
  "created": "2022-02-08T14:50:03.827Z",
  "modified": "2024-01-23T18:08:50.897Z"
}`)

  client := &http.Client {
  }
  req, err := http.NewRequest(method, url, payload)

  if err != nil {
    fmt.Println(err)
    return
  }
  req.Header.Add("Content-Type", "application/json")
  req.Header.Add("Accept", "application/json")
  req.Header.Add("Authorization", "Bearer <TOKEN>")

  res, err := client.Do(req)
  if err != nil {
    fmt.Println(err)
    return
  }
  defer res.Body.Close()

  body, err := io.ReadAll(res.Body)
  if err != nil {
    fmt.Println(err)
    return
  }
  fmt.Println(string(body))
}

Request Collapse all

Base URL

https://sailpoint.api.identitynow.com/v2025

Auth

Bearer Token

Body required

{
  "name": "My Multi-Host Integration",
  "description": "This is the Multi-Host Integration.",
  "owner": {
    "type": "IDENTITY",
    "id": "2c91808568c529c60168cca6f90c1313",
    "name": "MyName"
  },
  "cluster": {
    "type": "CLUSTER",
    "id": "2c9180866166b5b0016167c32ef31a66",
    "name": "Corporate Cluster"
  },
  "connector": "multihost-microsoft-sql-server",
  "connectorAttributes": {
    "maxSourcesPerAggGroup": 10,
    "maxAllowedSources": 300
  },
  "managementWorkgroup": {
    "type": "GOVERNANCE_GROUP",
    "id": "2c91808568c529c60168cca6f90c2222",
    "name": "My Management Workgroup"
  },
  "created": "2022-02-08T14:50:03.827Z",
  "modified": "2024-01-23T18:08:50.897Z"
}

ResponseClear

Click the Send API Request button above and see the response here!