From a33dd98fb48c2deef23c3ab4323d27d05918e234 Mon Sep 17 00:00:00 2001 From: Peter deNoyelles Date: Mon, 3 Feb 2025 12:03:31 -0700 Subject: [PATCH 1/2] [ILX-50576] Add GET documentation to the User Management API section. --- source/includes/_object-data-api.md | 1 + source/includes/_user-mgmt-api.md | 6 +++--- source/includes/user-mgmt/get-api.md | 13 ++++++++++--- source/includes/user-mgmt/post-patch-api.md | 11 +++++++---- source/stylesheets/screen.css.scss | 2 +- 5 files changed, 22 insertions(+), 11 deletions(-) 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 8ca79fd2e4e..ddd32b52ceb 100644 --- a/source/includes/_user-mgmt-api.md +++ b/source/includes/_user-mgmt-api.md @@ -1,3 +1,3 @@ -# USER MANAGEMENT API - -The V6 User Management API gives you the ability to simultaneously manage Employee and User acccess in V6. +# User Management API + +The V6 User Management API gives you the ability to simultaneously manage Employee and User acccess in V6. 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 f91c1a05a6c..b47350f904f 100644 --- a/source/includes/user-mgmt/post-patch-api.md +++ b/source/includes/user-mgmt/post-patch-api.md @@ -67,16 +67,18 @@ All flags default to false unless otherwise noted. 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, you will receive and error and all associated users to that Employee with be locked
    • @@ -114,6 +116,7 @@ Payload fields that are associated with the employee record to be created or upd
  • 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; From 95bf526f4413f594f5e4d3336b7f27c9d79a3bdc Mon Sep 17 00:00:00 2001 From: Peter deNoyelles Date: Tue, 4 Feb 2025 11:10:58 -0700 Subject: [PATCH 2/2] CR fixes --- source/includes/user-mgmt/post-patch-api.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/source/includes/user-mgmt/post-patch-api.md b/source/includes/user-mgmt/post-patch-api.md index 98a49e2fec1..197ca364f68 100644 --- a/source/includes/user-mgmt/post-patch-api.md +++ b/source/includes/user-mgmt/post-patch-api.md @@ -153,7 +153,7 @@ Some settings flags may be ignored if the flag is not relevant to the request ty
  • Existing users only.
  • Revokes access for the specified user.
    • -
  • Revokes API access for the specified user (if applicable)
    • +
  • Revokes API access for the specified user (if applicable).
    • @@ -161,8 +161,8 @@ Some settings flags may be ignored if the flag is not relevant to the request ty
  • 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, you will receive and error and all associated users to that Employee with be locked
    • +
  • 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.
    • @@ -202,7 +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
    • +
  • Only existing employees can be archived. You cannot create a new "Inactive" employee.