Retrieve a principal information
Retrieve the security information of an existing principal based on its identifier
|
identifier
string
requiredThe identifier of the principal to retrieve information of |
-
200 The principal information
application/json_idstring requiredThe MongoDB ObjectID of the principal
identifierstring requiredThe identifier of the principal
creationDateinteger requiredThe creation date of the principal (UNIX Timestamp in milliseconds)
lastModificationinteger requiredThe last modification date of the principal (UNIX Timestamp in milliseconds)
enabledboolean requiredIf the principal is allowed to login horizon
contactstring | nullThe contact e-mail of the principal
permissionsarray of objects | null (Permission)The permissions of the principal
Array [
valuestring requiredThe permission string, in the Horizon format :
: : : filterstring | nullThe filter to apply to the permission in the HPQL format
]
rolesarray of string | nullThe roles of the principal
teamsarray of string | nullThe teams of the principal
savedQueriesarray of objects | null (Principal queries)The saved HQL queries of the principal. This is used by UI only. These values should not be manually set but should be copied on update
Array [
typestring requiredThe type of the query
Enumheqlhcqlhrqlhpqlhdqlquerystring requiredThe saved HQL query
namestring requiredInternal name of the saved request
descriptionstring | nullThe saved request description
]
customDashboardsarray of objects | null (Dashboard)The custom dashboards of the principal. This is used by UI only. These values should not be manually set but should be copied on update
Array [
namestring requiredThe dashboard's name
chartsarray of objects (Chart) requiredThe dashboard's list of charts
Array [
titlestring requiredTitle of the chart
typestring requiredThe type of the chart
Enumtreemapbar-horizontallinepieheatmapbar-horizontal-stackedmetricradardonutbar-vertical-stackedtableareabar-verticalfieldsarray of string requiredThe field that will be used to group data
colorsarray of string requiredThe colors of the chart
logboolean requiredWhether the logarithm scale is enabled or not
descriptionstring | nullThe description of the chart
limitinteger | nullThe maximum number of results to display
havingobject | null (Having)A condition to apply to the results of the aggregate. Only the aggregates results with more than 5 items in them can be kept for example
operatorstring requiredA mongoDB operator for comparison
Enumgteltegteqneltvalueinteger requiredAn integer for the right hand side of the condition
sortOrderstring | nullHow to sort the results in the chart (if applicable)
EnumAscDescKeyAscKeyDesclocalQuerystring | nullThe HCQL/HRQL query to build the chart from
directionstring | nullEnumascdescistring | nullThe index of the chart on the dashboard
xinteger | nullThe horizontal position of the chart on the grid
yinteger | nullThe vertical position of the chart on the grid
winteger | nullThe width of the chart
hinteger | nullThe height of the chart
]
typestring requiredThe type of objects the dashboard displays
Enumcertificaterequestdescriptionstring | nullThe dashboard's description
]
preferencesobject | null (Principal Preferences)The UI preferences of the principal. This is used by UI only. These values should not be manually set but should be copied on update
darkModeboolean | nullDark Mode is enabled on UI for this user
expertModebooleanExpert mode is enabled on UI for this user
langstring | nullThe preferred language of the user
EnumenfrcertificateFieldsarray of string | nullThe user's preferred columns on certificate view
requestFieldsarray of string | nullThe user's preferred columns on request view
lastAuthenticationinteger | nullThe last authentication date of the principal (UNIX Timestamp in milliseconds)
-
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
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
-
404 Principal Info not found
application/jsonerrorstring requiredThe error code of the problem
ValueSEC-PI-003messagestring requiredA short, human-readable summary of the problem type
ValuePrincipal Info not foundtitlestring requiredA short, human-readable summary of the problem type. In compliance with RFC7807
ValuePrincipal Info not founddetailstring | 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-PI-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