Skip to main content
Kinetic Community

Identity Model

The identity object represents the user that is currently using the application. It provides some properties and methods to retrieve information about that user.

Properties

anonymous

Indicates whether the identity is the internal anonymous user, meaning the current user is not logged into the application. Returns true if the anonymous, otherwise false.

${identity.anonymous}

attributes

A list of all attributes applied to the identity.

${identity.attributes}

authenticated

Returns true if the user is logged into the application, otherwise false.

${identity.authenticated}

displayName

The value of the identity to use for display, usually the full name, or at least the first and last names of a person.

${identity.displayName}

email

The email address for the user.

${identity.email}

enabled

Returns true if the user account is enabled, otherwise false.

${identity.enabled}

groups

A list of groups the user belongs to. The source of the group list depends on the type of identity store used for authentication. For instance, the LDAP authenticator would return a list of LDAP groups the user belongs to.

${identity.groups}

sessionToken

An type-1 UUID attached to the user when a session is established. This is used for anonymous submissions.

${identity.sessionToken}

space

The Space the identity belongs to.

${identity.space}

spaceAdmin

Returns true if the user is a Space administrator, otherwise false. A Space administrator can make changes to a Space, and all other objects in the Space.

${identity.spaceAdmin}

systemAdmin

Returns true if the user is the System administrator, otherwise false. A System administrator has the ability to add / remove / modify spaces, and users of spaces.

${identity.systemAdmin}

username

The value used to login to the Space. The username must be a unique value within the Space.

${identity.username}

Methods

getAttribute(name)

Returns the attribute identified by the name parameter if it exists.

${identity.getAttribute(name)}

getAttributeValue(name)

Returns the value of the attribute identified by the name parameter if it exists and if the attribute only supports a single value. This is a shortcut for ${identity.getAttribute(name).value} if you don’t need the entire Attribute object, or you have not tested if the attribute exists.

${identity.getAttributeValue(name)}

getAttributeValues(name)

Returns a list of values of the attribute identified by the name parameter if it exists and if the attribute support multiple values. This is a shortcut for ${identity.getAttribute(name).values} if you don’t need the entire Attribute object, or you have not tested if the attribute exists.

${identity.getAttributeValues(name)}

hasAttribute(name)

Tests if the attribute identified by the name parameter exists. Returns true if the attribute does exist, otherwise false.

${identity.hasAttribute(name)}

hasAttributeValue(name, value)

Tests if the attribute identified by the name parameter has the value identified by the value parameter. Returns true if the attribute does have the value, otherwise false.

${identity.hasAttributeValue(name, value)}

Related