Creating Property Definitions

This documentation focuses on defining Properties using the Northpass API, but you may also define Properties in the Northpass application as well.

Property Names

All Properties must have a name. The name must be unique, cannot contain whitespaces, and cannot be a reserved property.

Example Property Names

Property Name

Is Valid?

my_property_name

Yes

MyPropertyName

Yes

my-property-name

Yes

My Property Name

No

Reserved Properties
Northpass provides a set of default Properties that are reserved and always available to you. You will not be able to define a Property using any of the names below. They are:

Namespace

Property Name

School

id

School

name

Course

id

Course

name

Person

id

Person

first_name

Person

last_name

Person

email

Person

sso_uid

Person

phone_number

Person

preferred_locale

Data Types

Properties support various data types. Take note as some data types are only supported by Conditional Properties.

Data Type

Description

Supported By

string

A text based value with a limit up to 255 characters. This will escape HTML.

Any Property Type

boolean

Only supports true and false.

Any Property Type

integer

A positive or negative whole number.

Any Property Type

float

A positive or negative number that supports decimals.

Any Property Type

html

Native HTML that can be used in course activities and templates to personalize experiences.

Conditional Properties Only


What’s Next

Now that you know how to create Property definitions, keep learning about how to set Property values.

Did this page help you?