Create a new identity provider
Create a new identity provider. The identity provider can be either a local identity provider or an OIDC identity provider.
The identity provider to register
|
_id
string
requiredThe internal ID of the Identity Provider |
|||||||||||
|
name
string
requiredThe internal name of the local identity provider |
|||||||||||
|
type
string
requiredThe type of identity provider
Value
Local
|
|||||||||||
|
enabled
boolean
requiredWhether the local identity provider can be used to identify against Horizon |
|||||||||||
|
enabledOnUI
boolean
requiredWhether the local identity provider can be selected on login to the Horizon UI |
|||||||||||
|
displayName
array of objects | null (LocalizedString)
The display name of the local identity provider |
|||||||||||
|
Array [
] |
|||||||||||
|
description
array of objects | null (LocalizedString)
The description of the local identity provider |
|||||||||||
|
Array [
] |
|||||||||||
|
passwordPolicy
string | null
The password policy to enforce for user passwords on the local identity provider |
|||||||||||
|
emailTemplate
object | null (Email template)
The e-mail template to use for password recovery |
|||||||||||
|
|||||||||||
|
_id
string
requiredThe internal ID of the Identity Provider |
|||
|
name
string
requiredThe internal name of the identity provider |
|||
|
type
string
requiredThe type of Identity provider to register
Value
OpenId
|
|||
|
enabled
boolean
requiredWhether the identity provider can be used to identify against Horizon |
|||
|
enabledOnUI
boolean
requiredWhether the identity provider can be selected on login to the Horizon UI |
|||
|
providerMetadataUrl
string
requiredThe URL of the identity provider OpenID callback |
|||
|
clientCredentials
string
requiredName of the password credentials containing the client ID and secret to use to authenticate Horizon against the identity provider |
|||
|
scope
string
requiredThe scope where to retrieve the user data from |
|||
|
trustSystemCAs
boolean
requiredTrust AC coming from the system trust store or only trust AC imported in Horizon |
|||
|
identifierClaim
string
requiredThe OpenID information that will be used as the user's identifier in Horizon |
|||
|
emailClaim
string
requiredThe OpenID information that will be used as the user's email in Horizon |
|||
|
nameClaim
string
requiredThe OpenID information that will be used as the user's name in Horizon |
|||
|
displayName
array of objects | null (LocalizedString)
The display name of the identity provider |
|||
|
Array [
] |
|||
|
description
array of objects | null (LocalizedString)
The description of the identity provider |
|||
|
Array [
] |
|||
|
proxy
string | null
The name of the proxy to use to reach the identity provider |
|||
|
timeout
string | null
The timeout value to use when connecting to the identity provider (must be a valid finite duration) |
|||
-
201 Identity provider successfully registered
application/json_idstring requiredThe internal ID of the Identity Provider
namestring requiredThe internal name of the identity provider
typestring requiredThe type of Identity provider to register
ValueOpenIdenabledboolean requiredWhether the identity provider can be used to identify against Horizon
enabledOnUIboolean requiredWhether the identity provider can be selected on login to the Horizon UI
providerMetadataUrlstring requiredThe URL of the identity provider OpenID callback
clientCredentialsstring requiredName of the password credentials containing the client ID and secret to use to authenticate Horizon against the identity provider
scopestring requiredThe scope where to retrieve the user data from
trustSystemCAsboolean requiredTrust AC coming from the system trust store or only trust AC imported in Horizon
identifierClaimstring requiredThe OpenID information that will be used as the user's identifier in Horizon
emailClaimstring requiredThe OpenID information that will be used as the user's email in Horizon
nameClaimstring requiredThe OpenID information that will be used as the user's name in Horizon
displayNamearray of objects | null (LocalizedString)The display name of the identity provider
Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
descriptionarray of objects | null (LocalizedString)The description of the identity provider
Array [
langstring requiredThe ISO 3166-1 (2-letters) code of the language used for the value
valuestring requiredThe localized value
]
proxystring | nullThe name of the proxy to use to reach the identity provider
timeoutstring | nullThe timeout value to use when connecting to the identity provider (must be a valid finite duration)
-
400 Unable to register the identity provider
application/jsonerrorstring requiredThe error code of the problem
ValueSEC-IDPROV-002messagestring 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-IDPROV-004messagestring requiredA short, human-readable summary of the problem type
ValueIdentity Provider already existstitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValueIdentity Provider already existsdetailstring | nullA human-readable explanation specific to this occurrence of the problem. In compliance with RFC7807
-
401 Authentication error
application/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 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
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/jsonerrorstring 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
errorstring 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
-
500 Unexpected internal server error
application/jsonerrorstring requiredThe error code of the problem
ValueSEC-IDPROV-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