Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions source/includes/_object-data-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions source/includes/_user-mgmt-api.md
Original file line number Diff line number Diff line change
@@ -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.
13 changes: 10 additions & 3 deletions source/includes/user-mgmt/get-api.md
Original file line number Diff line number Diff line change
@@ -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`
11 changes: 7 additions & 4 deletions source/includes/user-mgmt/post-patch-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -151,16 +151,18 @@ Some settings flags may be ignored if the flag is not relevant to the request ty
<tr>
<td>RevokeUserAccess</td>
<td>
<li>Existing users only. Only respected if user access is requested. </li>
<li>Existing users only.</li>
<li>Revokes access for the specified user.</li>
<li></li>
<li>Revokes API access for the specified user (if applicable).</li>
</td>
</tr>
<tr>
<td>ArchiveIfTasksAssigned</td>
<td>
<li>Existing users only. Only respected if user access is requested.</li>
<li></li>
<li>Existing users only.</li>
<li>Only respected if <code>Flag</code> = <code>I</code> in <a href="#employee-fields">Employee Fields</a>.</li>
<li>Allows Employees who have tasks assigned to them to be archived.</li>
<li>If <code>ArchiveIfTasksAssigned</code> is not set and the specified employee has tasks assigned, the request will fail with an error and the associated user will be locked.</li>
</td>
</tr>
<tr>
Expand Down Expand Up @@ -200,6 +202,7 @@ Properties denoted with a <code>\*</code> are required and must be included in t
<li><code>I</code> = Inactive (archived) employee</li>
</ul>
<li>Archiving an an employee will also remove the associated user's access, if available.</li>
<li>Only existing employees can be archived. You cannot create a new "Inactive" employee.</li>
</td>
</tr>
<tr>
Expand Down
2 changes: 1 addition & 1 deletion source/stylesheets/screen.css.scss
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
Loading