diff --git a/source/includes/_object-data-api.md b/source/includes/_object-data-api.md index a054ff60625..96f23cbc419 100644 --- a/source/includes/_object-data-api.md +++ b/source/includes/_object-data-api.md @@ -59,6 +59,7 @@ Sometimes you might need to access data from system objects that contain data su System Object | Description | System Name --------- | ----------- | --------- Employees | Intelex Employees | SysEmployeeEntity +Users | Intelex Users | SysUserEntity Locations | Intelex locations | SysLocationEntity Groups | Intelex Employee groups | SysGroupEntity EDIS Staging Table | Staging table used to process EDIS | EmployeeStagingEntity diff --git a/source/includes/_user-mgmt-api.md b/source/includes/_user-mgmt-api.md index 13a99aa1c45..f084a08012c 100644 --- a/source/includes/_user-mgmt-api.md +++ b/source/includes/_user-mgmt-api.md @@ -1,5 +1,5 @@ -# USER MANAGEMENT API - -The User Management API provides the ability to externally manage employee and user acccess in Intelex. - -Functionality for this endpoint includes employee and user [creation](#add-data) and [modification](#modify-data) with the ability to archive employees and revoke user access. Requests may also optionally [assign and revoke group membership](#group-membership) to the employee. +# User Management API + +The User Management API provides the ability to externally manage employee and user acccess in Intelex. + +Functionality for this endpoint includes employee and user [creation](#add-data) and [modification](#modify-data) with the ability to archive employees and revoke user access. Requests may also optionally [assign and revoke group membership](#group-membership) to the employee. diff --git a/source/includes/user-mgmt/get-api.md b/source/includes/user-mgmt/get-api.md index 35d424acfd9..a852301d8d6 100644 --- a/source/includes/user-mgmt/get-api.md +++ b/source/includes/user-mgmt/get-api.md @@ -1,3 +1,10 @@ -## Retrieve Data - -This section outlines the blah blah blah +## Retrieve Data + +To retrieve data relevant to Employees and Users that are being managed through the User Management API, please refer to the [Object Data API](#object-data-api) section. + +The applicable User Management [System Objects](#system-objects) that can be accessed will be `SysEmployeeEntity` and `SysUserEntity`. + +Please note: There are some SysUserEntity fields that can be set/updated but are marked as sensitive so they will not be returned when retrieving SysUserEntities. **This is not an exhaustive list and columns marked as sensitive could change in the future**: + +* `SecondaryPassword` +* `DateSecondaryPasswordModified` \ No newline at end of file diff --git a/source/includes/user-mgmt/post-patch-api.md b/source/includes/user-mgmt/post-patch-api.md index d8a45ddacfd..197ca364f68 100644 --- a/source/includes/user-mgmt/post-patch-api.md +++ b/source/includes/user-mgmt/post-patch-api.md @@ -151,16 +151,18 @@ Some settings flags may be ignored if the flag is not relevant to the request ty RevokeUserAccess -
  • Existing users only. Only respected if user access is requested.
  • +
  • Existing users only.
  • Revokes access for the specified user.
  • -
  • +
  • Revokes API access for the specified user (if applicable).
  • ArchiveIfTasksAssigned -
  • Existing users only. Only respected if user access is requested.
  • -
  • +
  • Existing users only.
  • +
  • Only respected if Flag = I in Employee Fields.
  • +
  • Allows Employees who have tasks assigned to them to be archived.
  • +
  • If ArchiveIfTasksAssigned is not set and the specified employee has tasks assigned, the request will fail with an error and the associated user will be locked.
  • @@ -200,6 +202,7 @@ Properties denoted with a \* are required and must be included in t
  • I = Inactive (archived) employee
  • Archiving an an employee will also remove the associated user's access, if available.
  • +
  • Only existing employees can be archived. You cannot create a new "Inactive" employee.
  • diff --git a/source/stylesheets/screen.css.scss b/source/stylesheets/screen.css.scss index 362974cb4df..a6d8c2aba73 100644 --- a/source/stylesheets/screen.css.scss +++ b/source/stylesheets/screen.css.scss @@ -41,7 +41,7 @@ html, body { // Section headers - .tocify-item[data-unique="api-reference"], .tocify-item[data-unique="object-data-api"], .tocify-item[data-unique="task-api"], .tocify-item[data-unique="developer-support"], .tocify-item[data-unique="interface-api"], .tocify-item[data-unique="package-api"] { + .tocify-item[data-unique="api-reference"], .tocify-item[data-unique="object-data-api"], .tocify-item[data-unique="task-api"], .tocify-item[data-unique="developer-support"], .tocify-item[data-unique="interface-api"], .tocify-item[data-unique="package-api"], .tocify-item[data-unique="user-management-api"] { text-transform: uppercase; margin-top: 1em; margin-bottom: 0.5em;