GetData: User types
This page documents the data types available in GetData for users, user groups, roles, privileges, and passkeys.
\{internal.passkey.%%}
- \{internal.passkey.%%}
-
This will return attributes and types from a passkey in the system. An identifier of the privilege is required for loading these data.
- \{internal.passkey.id}
-
Returns the unique id of the passkey.
- \{internal.passkey.organizationid}
-
Returns the organization id of the passkey, if available.
- \{internal.passkey.typeid}
-
Returns the id of the passkey type.
- \{internal.passkey.type}
-
Returns the type name of passkey. Available types are: Fido2.
- \{internal.passkey.origintypeid}
-
Returns the id of the external origin service of the system if available.
- \{internal.passkey.originreferenceid}
-
Returns the id of the external origin object of the system if available.
- \{internal.passkey.name}
-
Returns the name of the passkey, delivered from the external system.
- \{internal.passkey.model}
-
Returns the model of the passkey, delivered from the external system.
- \{internal.passkey.relyingpartyid}
-
Returns the relying party id, delivered from the external system.
- \{internal.passkey.relyingpartyname}
-
Returns the relying party name, delivered from the external system.
- \{internal.passkey.statusid}
-
Returns the id of the status of the passkey.
- \{internal.passkey.status}
-
Returns the name type of the status of the passkey. Available types are: Active and Revoked.
- \{internal.passkey.createddatetime}
-
Returns the date time when the passkey was created in the system.
- \{internal.passkey.additionalinfo}
-
Returns the additional information of the passkey as XML-encoded string.
\{internal.privilege.%%}
- \{internal.privilege.%%}
-
This will return attributes and types from a privilege in the system. An identifier of the privilege is required for loading these data.
- \{internal.privilege.id}
-
Returns the unique id of the privilege.
\{internal.role.%%}
- \{internal.role.%%}
-
This will return attributes and types from a role in the system. An identifier of the role is required for loading these data.
- \{internal.role.id}
-
Returns the unique id of the role.
- \{internal.role.name}
-
Returns the name of the role.
\{internal.user.%%}
- \{internal.user.%%}
-
This will return attributes and types from a user in the system. An identifier of the user is required for loading these data.
- \{internal.user.id}
-
Returns the unique id of the user.
- \{internal.user.organizationid}
-
Returns the organization id of the user.
- \{internal.user.referenceid}
-
Returns the id of the main user if user is an alias user.
- \{internal.user.typeid}
-
Returns the type id of the user. Available types are: Person=10, Service=20.
- \{internal.user.type}
-
Returns the type name of the user. Available types are: Person and Service.
- \{internal.user.name}
-
Returns the name of the user.
- \{internal.user.givenname}
-
Returns the given name of the user if user is defined as a person.
- \{internal.user.firstname}
-
Returns the first name of the user if user is defined as a person.
- \{internal.user.middlename}
-
Returns the middle name of the user if user is defined as a person. (usually the subordinated surname).
- \{internal.user.surname}
-
Returns the surname of the user if user is defined as a person.
- \{internal.user.serialnumber}
-
Returns a serial number of a user if available.
- \{internal.user.title}
-
Returns the title of a user if available.
- \{internal.user.employmenttype}
-
Returns the id of type of employment.
- \{internal.user.employmentstartdate}
-
Returns date and time of predefined start of the user if available.
- \{internal.user.employmentenddate}
-
Returns date and time of predefined end of the user if available.
- \{internal.user.email}
-
Returns the e-mail address of the user if available.
- \{internal.user.mobile}
-
Returns the mobile number of the user if available.
- \{internal.user.imageid}
-
Returns the id of the image if available. This id should be used when load the image.
- \{internal.user.signatureimageid}
-
Returns the id of the signature image if available. This id should be used when load the signature image.
- \{internal.user.flags}
-
Returns flags of the user as hexadecimal encoded string. 0x0 means nothing. 0x1 means that the user has personal secrecy information and cannot be loaded without specific privileges.
- \{internal.user.nameflags}
-
Returns flags of the user name as hexadecimal encoded string. 0x0 menans nothing. 0x1 means that the name specifications of the user are read-only and cannot be changed.
- \{internal.user.objectsid}
-
Returns the SID (Security Identifier) of the user if available. This is usually used for Microsoft Active Directory environments.
- \{internal.user.officeid}
-
Returns the id of the office of the user if available.
- \{internal.user.origintypeid}
-
Returns the id of the external origin service of the system if available.
- \{internal.user.originreferenceid}
-
Returns the id of the external origin object of the system if available.
- \{internal.user.originsyncdatetime}
-
Returns date and time when the the user latest was synchronized against external origin service if available.
- \{internal.user.image}
-
Returns the image of the user if available as base64-encoded string. The id must be the image-id.
- \{internal.user.signatureimage}
-
Returns the signature image of the user if available as base64encoded string. The id must the the signatureimage-id.
- \{internal.user.group}
-
Returns the id(s) of related group(s) of the user.
- \{internal.user.groupname}
-
Returns the name(s) of related group(s) of the user.
- \{internal.user.identitytypeoid}
-
Returns the OID of the identity type of a user that has an national origin service (e.g. Navet/SPAR). The types are:
-
1.2.752.129.2.1.3.1 (social security number); or
-
1.2.752.129.2.1.3.3 (coordination number).
-
- \{internal.user.hasrestriction}
-
Returns true/false if the user is a member of a restricted user group. If the user is a member of a restricted user group, some subordinated operations cannot be done without specific privileges.
- \{internal.user.hasnationalresidential}
-
Returns true/false if the user has a national residential against its origin service (e.g. Navet/SPAR).
- \{internal.user.hasactivetoken}
-
Returns true/false if the user has an active token.
- \{internal.user.hasactivesmartcardtoken}
-
Returns true/false if the user has an active token specified as a smart card.
- \{internal.user.hasactivekeytoken}
-
Returns true/false if the user has an active token specified as a key token.
- \{internal.user.hasactivevirtualtoken}
-
Returns true/false if the user has an active token specified as a virtual token.
- \{internal.user.hasactivemobiletoken}
-
Returns true/false if the user has an active token specified as a mobile token.
- \{internal.user.hasactivefiletoken}
-
Returns true/false if the user has an active token specified as a file token.
- \{internal.user.hasactivenontoken}
-
Returns true/false if the user has an active token specified as a non token.
- \{internal.user.hashistoricaltoken}
-
Returns true/false if the user has historical token(s).
- \{internal.user.hasadditionalidentity}
-
Returns true/false if the user has an additional identity.
- \{internal.user.extrainfo}
-
Returns extra customized information of the user if available.
- \{internal.user.additionalinfo}
-
Returns additional information of the user if available.
- \{internal.user.additionalidentity%%}
-
Except the static types above, it’s possible to load data from the additional identity database table of the user. Example:
\{internal.user.additionalidentityobjectsid(identifier=1)}
(this will load the value of the objectsid-property from the additional identity database table of the user). - \{internal.user.hasprivilege%%}
-
Except the static types above, it’s possible to load a condition (true/false) of specific privilege of the user. Example:
\{internal.user.hasprivilege24(identifier=1)}
(this will return true/false if the user has privilege id 24 (AuditLogView)).
\{internal.usergroup.%%}
- \{internal.usergroup.%%}
-
This will return attributes and types from a user group in the system. An identifier of the user group is required for loading these data.
- \{internal.usergroup.id}
-
Returns the unique id of the user group.
- \{internal.usergroup.name}
-
Returns the name of the user group.