This resource allows you to create, retrieve, and delete Function Access Profiles and information associated with Function Access Profiles.
Function Access Profiles contain permissions to points in the hierarchy of functions, known as access control points (ACPs). The access control points can correspond to general functions, such as Timecard and Schedule, or to individual options, such as birth dates or wage rates.
- Function Access Hierarchy -- Suite functions and components are listed on the Function Access Profile pages and can be expanded to display the full hierarchy. Each function, or access control point, has only one parent point. For example, the Timekeeping Employee category is a parent to function areas such as Timestamp for Employee and functions in the timecard such as cancel meal deductions and comments. If you assign Allowed access rights to a parent function, access rights are allowed throughout the functional hierarchy.
- Actions -- Access control points have an associated permission action. Actions are operations that employees can perform on the function. Access profiles can have Add, Edit, Delete, and View actions associated with an access control point.
- Access Scope -- Access scopes define whether a user is allowed to perform an action. Access scopes include All, All but self, None, Allowed, and Disallowed. Various appears at the parent level when you do no set all child functions to Allow or Disallow.
Operations
Create Function Access Profile
POST /v1/commons/function_access_profiles
Delete Function Access Profile by ID
DELETE /v1/commons/function_access_profiles/{fapId}
Retrieve All Function Access Profiles or by Name
GET /v1/commons/function_access_profiles
Retrieve Function Access Profile by ID
GET /v1/commons/function_access_profiles/{id}
Update Function Access Profile by ID
PUT /v1/commons/function_access_profiles/{id}