Register a new datasource
Register a new datasource
Datasource to register
|
type
string
requiredType of datasource
Value
dns
|
|||
|
name
string
requiredName of the datasource |
|||
|
lookup
string (TemplateString)
requiredHost to lookup |
|||
|
displayName
array of objects | null (LocalizedString)
The localized name of the datasource |
|||
|
Array [
] |
|||
|
description
string
Description of the datasource |
|||
|
host
string | null
Ip of the DNS server. If empty, Horizon Server DNS is used |
|||
|
port
integer | null
Port on which to join the DNS server |
|||
|
timeout
string | null
Timeout for the DNS request |
|||
|
recordTypes
array of string | null
Type of DNS records to fetch. All available record types are fetched if null |
|||
|
type
string
requiredType of datasource
Value
ldap
|
||||
|
name
string
requiredName of the datasource |
||||
|
credentials
string
requiredName of the password credentials to use for LDAP Authentication |
||||
|
hostname
string
requiredHostname of the LDAP server |
||||
|
timeout
string
requiredTimeout for the LDAP request |
||||
|
secure
boolean
requiredUse secure LDAP connection |
||||
|
baseDn
string (TemplateString)
requiredLDAP Base DN |
||||
|
filter
string (TemplateString)
requiredLDAP Filter |
||||
|
displayName
array of objects | null (LocalizedString)
The localized name of the datasource |
||||
|
Array [
] |
||||
|
description
string
Description of the datasource |
||||
|
port
integer | null
Port on which to join the LDAP server |
||||
|
proxy
string | null
Name of the proxy to use to reach the LDAP server |
||||
|
disableHostnameValidation
boolean | null
Disable hostname validation for the LDAP connection |
||||
|
attributes
array of objects | null (Datasource Output)
List of attributes to fetch for this datasource |
||||
|
Array [
] |
||||
|
type
string
requiredType of datasource
Value
rest
|
||||
|
name
string
requiredName of the datasource |
||||
|
method
string
requiredThe HTTP method to use for the request |
||||
|
url
string (TemplateString)
requiredThe URL to request |
||||
|
authenticationType
string
requiredThe authentication type to use while making the REST call. Is linked to credentials.
Enum
noauth
basic
x509
bearer
custom
|
||||
|
expectedHttpCodes
array of integer
requiredThe success HTTP codes for the request. If the return code is not in this list, the request will be considered failed. |
||||
|
timeout
string
requiredTimeout for the HTTP request. |
||||
|
displayName
array of objects | null (LocalizedString)
The localized name of the datasource |
||||
|
Array [
] |
||||
|
description
string
Description of the datasource |
||||
|
credentials
string
Name of the credentials to use for authentication |
||||
|
headers
array of object | null (header)
The headers of the request |
||||
|
Array [
] |
||||
|
payloadType
string | null
For UI purposes in order to format the body correctly |
||||
|
payload
string | null (TemplateString)
The body of the request |
||||
|
proxy
string | null
Name of a Proxy to use while making the request |
||||
|
attributes
array of objects | null (Datasource Output)
List of attributes to fetch for this datasource |
||||
|
Array [
] |
||||
-
200 Datasource successfully registered
application/json_idstring (Internal ID) requiredObject internal ID
typestring requiredType of datasource
Valuednsnamestring requiredName of the datasource
lookupstring (TemplateString) requiredHost to lookup
displayNamearray of objects | null (LocalizedString)The localized name of the datasource
Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
descriptionstringDescription of the datasource
hoststring | nullIp of the DNS server. If empty, Horizon Server DNS is used
portinteger | nullPort on which to join the DNS server
timeoutstring | nullTimeout for the DNS request
recordTypesarray of string | nullType of DNS records to fetch. All available record types are fetched if null
_idstring (Internal ID) requiredObject internal ID
typestring requiredType of datasource
Valueldapnamestring requiredName of the datasource
credentialsstring requiredName of the password credentials to use for LDAP Authentication
hostnamestring requiredHostname of the LDAP server
timeoutstring requiredTimeout for the LDAP request
secureboolean requiredUse secure LDAP connection
baseDnstring (TemplateString) requiredLDAP Base DN
filterstring (TemplateString) requiredLDAP Filter
displayNamearray of objects | null (LocalizedString)The localized name of the datasource
Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
descriptionstringDescription of the datasource
portinteger | nullPort on which to join the LDAP server
proxystring | nullName of the proxy to use to reach the LDAP server
disableHostnameValidationboolean | nullDisable hostname validation for the LDAP connection
attributesarray of objects | null (Datasource Output)List of attributes to fetch for this datasource
Array [
keystring requiredKey of the output
multiboolean | nullDetermine if this attribute is multivalued
selectedboolean | nullDetermine if the attribute is selected on future fetches
]
_idstring (Internal ID) requiredObject internal ID
typestring requiredType of datasource
Valuerestnamestring requiredName of the datasource
methodstring requiredThe HTTP method to use for the request
urlstring (TemplateString) requiredThe URL to request
authenticationTypestring requiredThe authentication type to use while making the REST call. Is linked to credentials.
Enumnoauthbasicx509bearercustomexpectedHttpCodesarray of integer requiredThe success HTTP codes for the request. If the return code is not in this list, the request will be considered failed.
timeoutstring requiredTimeout for the HTTP request.
displayNamearray of objects | null (LocalizedString)The localized name of the datasource
Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
descriptionstringDescription of the datasource
credentialsstringName of the credentials to use for authentication
headersarray of object | null (header)The headers of the request
Array [
namestringThe header name
valuestring (TemplateString)The header value
]
payloadTypestring | nullFor UI purposes in order to format the body correctly
payloadstring | null (TemplateString)The body of the request
proxystring | nullName of a Proxy to use while making the request
attributesarray of objects | null (Datasource Output)List of attributes to fetch for this datasource
Array [
keystring requiredKey of the output
multiboolean | nullDetermine if this attribute is multivalued
selectedboolean | nullDetermine if the attribute is selected on future fetches
]
-
400 Bad Request
application/problem+jsonerrorstring requiredThe error code of the problem
ValueDS-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid DataSourcetitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid DataSourcedetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueDS-004messagestring requiredA short, human-readable summary of the problem type
ValueDataSource already existstitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueDataSource already existsdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
401 Unauthorized request
application/problem+jsonerrorstring requiredThe error code of the problem
ValueSEC-AUTH-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected Errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected Errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid credentials or principal does not existtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid credentials or principal does not existdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-003messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is not trustedtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is not trusteddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-004messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is expireddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-005messagestring requiredA short, human-readable summary of the problem type
ValueCertificate is revokedtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueCertificate is revokeddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-006messagestring requiredA short, human-readable summary of the problem type
ValuePrincipal not authenticatedtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValuePrincipal not authenticateddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-007messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Identity Providertitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid Identity Providerdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-008messagestring requiredA short, human-readable summary of the problem type
ValueInvalid redirect pathtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid redirect pathdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-009messagestring requiredA short, human-readable summary of the problem type
ValuePrincipal not authenticated or authentication expiredtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValuePrincipal not authenticated or authentication expireddetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
403 Forbidden action
application/problem+jsonerrorstring requiredThe error code of the problem
ValueSEC-PERM-001messagestring requiredA short, human-readable summary of the problem type
ValueInsufficient privilegestitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInsufficient privilegesdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-002messagestring requiredA short, human-readable summary of the problem type
ValueInvalid Licensetitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueInvalid Licensedetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-004messagestring requiredA short, human-readable summary of the problem type
ValueExpired Licensetitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueExpired Licensedetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
500 Internal Server error
application/problem+jsonerrorstring requiredThe error code of the problem
ValueDS-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueSEC-AUTH-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected Errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected Errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
errorstring requiredThe error code of the problem
ValueLIC-001messagestring requiredA short, human-readable summary of the problem type
ValueUnexpected errortitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueUnexpected errordetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807