Get Multi-Host Integration By ID

GET 
/multihosts/:id

Get an existing Multi-Host Integration.

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

Request

Path Parameters

id stringrequired

ID of the Multi-Host Integration.

Responses

200

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

application/json

Schema

Schema

id stringrequired

Multi-Host Integration ID.

name stringrequired

Multi-Host Integration's human-readable name.

description stringrequired

Multi-Host Integration's human-readable description.

owner

object

required

Reference to identity object who owns the source.

type string

Possible values: [IDENTITY]

Type of object being referenced.

id string

Owner identity's ID.

name string

Owner identity's human-readable display name.

cluster

object

nullable

Reference to the source's associated cluster.

type stringrequired

Possible values: [CLUSTER]

Type of object being referenced.

id stringrequired

Cluster ID.

name stringrequired

Cluster's human-readable display name.

type string

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.

connector stringrequired

Connector script name.

lastSourceUploadSuccessCount int32

Last successfully uploaded source count of given Multi-Host Integration.

maxSourcesPerAggGroup int32

Maximum sources that can contain in a aggregation group of Multi-Host Integration.

connectorClass string

Fully qualified name of the Java class that implements the connector interface.

connectorAttributes

object

Connector specific configuration. This configuration will differ for Multi-Host Integration type.

maxAllowedSources int32

Maximum sources allowed count of a Multi-Host Integration

lastSourceUploadCount int32

Last upload sources count of a Multi-Host Integration

connectorFileUploadHistory

object

connectorFileNameUploadedDate string

File name of the connector JAR

multihost_status string

Possible values: [ready, processing, fileUploadInProgress, sourceCreationInProgress, aggregationGroupingInProgress, aggregationScheduleInProgress, deleteInProgress, deleteFailed]

Multi-Host integration status.

showAccountSchema boolean

Default value: true

Show account schema

showEntitlementSchema boolean

Default value: true

Show entitlement schema

multiHostAttributes

object

Attributes of Multi-Host Integration

password string

Password.

connector_files string

Connector file.

authType string

Authentication type.

user string

Username.

property name* string
deleteThreshold int32

Possible values: <= 100

Number from 0 to 100 that specifies when to skip the delete phase.

authoritative boolean

When this is true, it indicates that the source is referenced by an identity profile.

managementWorkgroup

object

nullable

Reference to management workgroup for the source.

type string

Possible values: [GOVERNANCE_GROUP]

Type of object being referenced.

id string

Management workgroup ID.

name string

Management workgroup's human-readable display name.

healthy boolean

When this is true, it indicates that the source is healthy.

status string

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]

Status identifier that gives specific information about why a source is or isn't healthy.

since date-time

Timestamp that shows when a source health check was last performed.

connectorId string

Connector ID

connectorName string

Name of the connector that was chosen during source creation.

connectionType string

Possible values: [direct, file]

Type of connection (direct or file).

connectorImplementationId string

Connector implementation ID.

created date-time

Date-time when the source was created

modified date-time

Date-time when the source was last modified.

credentialProviderEnabled boolean

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.

category stringnullable

Source category (e.g. null, CredentialProvider).

Example (from schema)

{
  "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"
  },
  "type": "Multi-Host - Microsoft SQL Server",
  "connector": "multihost-microsoft-sql-server",
  "lastSourceUploadSuccessCount": 50,
  "maxSourcesPerAggGroup": 10,
  "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.3801666300Z",
  "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"
}

400

Client Error - Returned if the request body is invalid.

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "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 (from schema)

{
  "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

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "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

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "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 (from schema)

{
  "message": " Rate Limit Exceeded "
}

500

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

application/json

Schema

Schema

detailCode string

Fine-grained error code providing more detail of the error.

trackingId string

Unique tracking id for the error.

messages

object[]

Generic localized reason for error

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

causes

object[]

Plain-text descriptive reasons to provide additional detail to the text provided in the messages field

Array [

locale stringnullable

The locale for the message text, a BCP 47 language tag.

localeOrigin LocaleOrigin (string)nullable

Possible values: [DEFAULT, REQUEST, null]

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.

text string

Actual text of the error message in the indicated locale.

]

Example (from schema)

{
  "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."
    }
  ]
}

Loading...