Deprecated: Security keys and related APIs [AX 2012]

Updated: October 24, 2013

Applies To: Microsoft Dynamics AX 2012 R3, Microsoft Dynamics AX 2012 R2, Microsoft Dynamics AX 2012 Feature Pack, Microsoft Dynamics AX 2012

Security keys are the permissions that control access to functionality in the application. Security keys are set for individual user groups and users. Permissions determine who can access menus, forms, reports, and tables. Developers can call the security key–related APIs to determine whether users have access to a particular security key and the level of access that those users have.



Reason for deprecation

The security model has been changed in Microsoft Dynamics AX 2012. The new security model uses the concepts of roles, duties, and privileges. Developers can create privileges and add various securable objects to them. This change enables Microsoft Dynamics AX to move to a standard role-based security model, and provides greater flexibility and manageability.

Replaced by another feature

Yes. The feature was removed, and a replacement feature is available. Security keys have been replaced by role-based security. Role-based security lets a developer or administrator create privileges, duties, and roles, and assign permissions to various resources, based on the security requirements. The framework also automatically identifies the resources that are accessed by some base objects, such as forms, web controls, service operations, and reports. The developer does not have to use security keys to group these related objects. Therefore, the administrator can easily grant access without having to determine which security keys were set by the developer. All the APIs that were based on security keys were removed together with the security keys. These APIs were replaced with APIs that identify access based on objects.

For a high-level overview of the role-based security changes, see the product-wide feature topic What's new: Role-based security. For more detailed information, see the Role-Based Security System and Security architecture of the Microsoft Dynamics AX application topics.

Modules affected


Changes to installation

This change does not affect application installation.

Changes to upgrade

Any code that calls APIs to check for access to security keys or to check for the existence of security keys must be upgraded to use the new APIs. To upgrade the configuration keys for objects that use security key–to–configuration key mapping for licensing, run the scripts that are provided.

Announcements: To see known issues and recent fixes, use Issue search in Microsoft Dynamics Lifecycle Services (LCS).