AX2479

Axiom.Principals

The Axiom.Principals system table contains information about the defined users in your system.

Available columns

The following columns can be queried:

Column Description

PrincipalID

The database ID of the user.

LoginName

The login name (user name) of the user.

FirstName

The first name of the user.

LastName

The last name of the user.

EmailAddress

The email address of the user.

Domain

The domain of the user. Only applies to users that are imported from Active Directory. Returns blank for manually created users.

Password

Passwords are not returned by the query, but this field can be used to save back a new password when using Save Type 4 against Axiom.Principals. If Password is included in the query, it will return blank for all users.

AuthenticationType

The authentication type of the user: Windows User, LDAP Prompt, Axiom Prompt, OpenID, and SAML. Some older user records may return an authentication type of Unspecified; this type only exists to support backward-compatibility and should not be assigned to any users going forward.

IsSyncEnabled

Whether Active Directory synchronization is enabled for the user (True/False). All users default to True, regardless of whether Active Directory synchronization is currently being used. The setting has no effect if Active Directory synchronization is not enabled for the system.
UserLicenseType

The license type of the user: Standard, Viewer, or AxiomStaff.

IsEnabled

Whether the user is enabled (True/False).

IsAdmin

Whether the user is an administrator of the current system (True/False).

RoleIDList

A comma-separated list of role IDs that the user is assigned to.

RoleNameList

A comma-separated list of role names that the user is assigned to.

Subsystems

A comma-separated list of subsystems that the user is assigned to.

TableTypeIgnoreRoles_TableTypeName

Whether Ignore Roles is enabled for the specified table type. Returns NotConfigured if the user has no configured access to the table type; otherwise it returns True or False.

TableTypeReadFilter_TableTypeName

The user's configured read filter for the specified table type. This is not the effective filter; this represents only what has been configured on the user record itself. This will return one of the following:

  • NotConfigured: The user has no configured access to the table type.

  • FullAccess: The user has been granted full read access to the table type.

  • A filter criteria statement: The user has a configured read filter for the table type.

  • Blank: The user has no read access to the table type. This is different than NotConfigured; in this case the user's read filter has been explicitly set to blank to indicate no read access.

TableTypeWriteFilter_TableTypeName

The user's configured write filter for the specified table type. This is not the effective filter; this represents only what has been configured on the user record itself. This will return one of the following:

  • NotConfigured: The user has no configured access to the table type.

  • UseRead: The user's write access is the same level as their read access. This is the default setting when any access is configured to the table type. Any setting other than UseRead indicates that the user's write access has been separately configured from the read access.

  • FullAccess: The user has been granted full write access to the table type.

  • A filter criteria statement: The user has a configured write filter for the table type.

  • Blank: The user has no write access to the table type. This is different than NotConfigured; in this case the user's write filter has been explicitly set to blank to indicate no write access.

TableIgnoreRoles_TableName

Whether Ignore Roles is enabled for the specified table. Returns NotConfigured if the user has no configured access to the table; otherwise it returns True or False.

TableReadFilter_TableName

The user's configured read filter for the specified table. This is not the effective filter; this represents only what has been configured on the user record itself. This will return one of the following:

  • NotConfigured: The user has no configured access to the table.

  • FullAccess: The user has been granted full read access to the table.

  • A filter criteria statement: The user has a configured read filter for the table.

  • Blank: The user has no read access to the table. This is different than NotConfigured; in this case the user's read filter has been explicitly set to blank to indicate no read access.
TableWriteFilter_TableName

The user's defined write filter for the specified table. This is not the effective filter; this represents only what has been configured on the user record itself. This will return one of the following:

  • NotConfigured: The user has no configured access to the table.

  • UseRead: The user's write access is the same level as their read access. This is the default setting when any access is configured to the table. Any setting other than UseRead indicates that the user's write access has been separately configured from the read access.

  • FullAccess: The user has been granted full write access to the table.

  • A filter criteria statement: The user has a configured write filter for the table.

  • Blank: The user has no write access to the table. This is different than NotConfigured; in this case the user's write filter has been explicitly set to blank to indicate no write access.

Table Type and Table permission columns

Each table type and table defined in the system result in three permission columns for the read filter, the write filter, and the ignore roles setting. If any of these settings become configured for a user for a particular table or table type, then all three settings are considered configured.

For example, if you have a table type named GL and no settings have been configured for a user for that table type, then the columns will return data as follows:

Column   Value
TableTypeIgnoreRoles_GL   NotConfigured
TableTypeReadFilter_GL   NotConfigured
TableTypeWriteFilter_GL   NotConfigured

However, if you configure only the read access for that user and save it, then the other two settings will become configured to the default values. In this example, the user was granted Full Access to the GL table type. Now the columns will return data as follows:

Column   Value
TableTypeIgnoreRoles_GL   FALSE
TableTypeReadFilter_GL   FullAccess
TableTypeWriteFilter_GL   UseRead

Where False is the default setting for Ignore Roles, and "use read access" is the default setting for write access.

If later the user's configured read access is removed, and the other two settings remain at the default values, then all three values will be returned to NotConfigured.

Save Type 4 support

Axiom.Principals can be modified using Save Type 4. See Managing users in Axiom Security using Save Type 4.

See also