Create a new principal

Create a new principal in Horizon

Body required

application/json

The principal's information to register

_id

string required

The MongoDB ObjectID of the principal

identifier

string required

The identifier of the principal

creationDate

integer required

The creation date of the principal (UNIX Timestamp in milliseconds)

lastModification

integer required

The last modification date of the principal (UNIX Timestamp in milliseconds)

enabled

boolean required

If the principal is allowed to login horizon

contact

string | null

The contact e-mail of the principal

permissions

array of objects | null (Permission)

The permissions of the principal

Array [

value

string required

The permission string, in the Horizon format : :::

filter

string | null

The filter to apply to the permission in the HPQL format

]

roles

array of string | null

The roles of the principal

teams

array of string | null

The teams of the principal

savedQueries

array 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 [

type

string required

The type of the query

Enum heql hcql hrql hpql hdql

query

string required

The saved HQL query

name

string required

Internal name of the saved request

description

string | null

The saved request description

]

customDashboards

array 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 [

name

string required

The dashboard's name

charts

array of objects (Chart) required

The dashboard's list of charts

Array [

title

string required

Title of the chart

type

string required

The type of the chart

Enum treemap bar-horizontal line pie heatmap bar-horizontal-stacked metric radar donut bar-vertical-stacked table area bar-vertical

fields

array of string required

The field that will be used to group data

colors

array of string required

The colors of the chart

log

boolean required

Whether the logarithm scale is enabled or not

description

string | null

The description of the chart

limit

integer | null

The maximum number of results to display

having

object | 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

operator

string required

A mongoDB operator for comparison

Enum gte lte gt eq ne lt

value

integer required

An integer for the right hand side of the condition

sortOrder

string | null

How to sort the results in the chart (if applicable)

Enum Asc Desc KeyAsc KeyDesc

localQuery

string | null

The HCQL/HRQL query to build the chart from

direction

string | null

Enum asc desc

string | null

The index of the chart on the dashboard

integer | null

The horizontal position of the chart on the grid

integer | null

The vertical position of the chart on the grid

integer | null

The width of the chart

integer | null

The height of the chart

]

type

string required

The type of objects the dashboard displays

Enum certificate request

description

string | null

The dashboard's description

]

preferences

object | 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

darkMode

boolean | null

Dark Mode is enabled on UI for this user

expertMode

boolean

Expert mode is enabled on UI for this user

lang

string | null

The preferred language of the user

Enum en fr

certificateFields

array of string | null

The user's preferred columns on certificate view

requestFields

array of string | null

The user's preferred columns on request view

lastAuthentication

integer | null

The last authentication date of the principal (UNIX Timestamp in milliseconds)

Responses

200 Principal information successfully registered

_id

string required

The MongoDB ObjectID of the principal

identifier

string required

The identifier of the principal

creationDate

integer required

The creation date of the principal (UNIX Timestamp in milliseconds)

lastModification

integer required

The last modification date of the principal (UNIX Timestamp in milliseconds)

enabled

boolean required

If the principal is allowed to login horizon

contact

string | null

The contact e-mail of the principal

permissions

array of objects | null (Permission)

The permissions of the principal

Array [

value

string required

The permission string, in the Horizon format : :::

filter

string | null

The filter to apply to the permission in the HPQL format

]

roles

array of string | null

The roles of the principal

teams

array of string | null

The teams of the principal

savedQueries

array 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 [

type

string required

The type of the query

Enum heql hcql hrql hpql hdql

query

string required

The saved HQL query

name

string required

Internal name of the saved request

description

string | null

The saved request description

]

customDashboards

array 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 [

name

string required

The dashboard's name

charts

array of objects (Chart) required

The dashboard's list of charts

Array [

title

string required

Title of the chart

type

string required

The type of the chart

Enum treemap bar-horizontal line pie heatmap bar-horizontal-stacked metric radar donut bar-vertical-stacked table area bar-vertical

fields

array of string required

The field that will be used to group data

colors

array of string required

The colors of the chart

log

boolean required

Whether the logarithm scale is enabled or not

description

string | null

The description of the chart

limit

integer | null

The maximum number of results to display

having

object | 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

operator

string required

A mongoDB operator for comparison

Enum gte lte gt eq ne lt

value

integer required

An integer for the right hand side of the condition

sortOrder

string | null

How to sort the results in the chart (if applicable)

Enum Asc Desc KeyAsc KeyDesc

localQuery

string | null

The HCQL/HRQL query to build the chart from

direction

string | null

Enum asc desc

string | null

The index of the chart on the dashboard

integer | null

The horizontal position of the chart on the grid

integer | null

The vertical position of the chart on the grid

integer | null

The width of the chart

integer | null

The height of the chart

]

type

string required

The type of objects the dashboard displays

Enum certificate request

description

string | null

The dashboard's description

]

preferences

object | 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

darkMode

boolean | null

Dark Mode is enabled on UI for this user

expertMode

boolean

Expert mode is enabled on UI for this user

lang

string | null

The preferred language of the user

Enum en fr

certificateFields

array of string | null

The user's preferred columns on certificate view

requestFields

array of string | null

The user's preferred columns on request view

lastAuthentication

integer | null

The last authentication date of the principal (UNIX Timestamp in milliseconds)

400 Unable to register the principal

401 Authentication error

403 Forbidden action

500 Unexpected internal server error

post

/api/v1/security/principalinfos

{

"identifier": "administrator" ,

"contact": "[email protected]" ,

"permissions":

[ ... ] ,

"roles":

[ ... ] ,

"teams":

[ ... ] ,

"savedQueries":

[ ... ] ,

"customDashboards":

[ ... ] ,

"preferences":

{ ... } ,

"enabled": true

}