Difference between revisions of "User Management"

From Updox API
Jump to: navigation, search
(Created page with "Within each Account there must be at least one User to auth with. A User represents a single group of Messages, Preferences, and Settings. Different systems also refer to user...")
 
(→‎User Management)
 
(2 intermediate revisions by one user not shown)
Line 3: Line 3:
  
 
= User Management =
 
= User Management =
−
 
+
The Updox API provides three methods to create a user: [[#UserCreate|UserCreate]], [[#UserUpdate|UserUpdate]], and [[#UserSave|UserSave]].  
−
The Updox API provides three methods to create a user: [[#UserCreate]], [[#UserUpdate]], and [[#UserSave]].  
+
  
 
Creating or updating a User requires [[account-level credentials]].
 
Creating or updating a User requires [[account-level credentials]].
 +
  
 
== UserCreate ==
 
== UserCreate ==
 +
UserCreate is an explicit call to create a new User. It accepts multiple fields of both information about the User as well as settings, though only the <code>firstName</code> and <code>lastName</code> fields are required. Providing Account information will help to reference the User for support issues, while providing settings may be required for use in a particular integration. 
  
−
{{UserCreateLink}} is an explicit call to create a new User. It accepts multiple fields of both information about the User as well as settings, though only the <code>firstName</code> and <code>lastName</code> fields are required. Providing Account information will help to reference the User for support issues, while providing settings may be required for use in a particular integration. 
+
{{API Method Links|UserCreate}}
−
 
+
−
 
+
  
  
 
=== User Information Fields ===
 
=== User Information Fields ===
 
==== <code>userId</code> ====
 
==== <code>userId</code> ====
−
Note that when creating a User, the <code>userId</code> passed into the Application Authentication Header with the request will become the new userId used to reference and auth with the newly created User. If that <code>userId</code> is already in use, then the request will fail.
+
Note that when creating a User, the <code>userId</code> passed into the Application Authentication header with the request will become the new userId used to reference and auth with the newly created User. If that <code>userId</code> is already in use, then the request will fail.
 
==== <code>firstName</code> ====
 
==== <code>firstName</code> ====
 
==== <code>middleName</code> ====
 
==== <code>middleName</code> ====
Line 32: Line 31:
 
    
 
    
 
==== <code>directAddress</code> ====
 
==== <code>directAddress</code> ====
−
 
 
The directAddress setting for Users sets the direct address for that User. This is the address that will be used for direct messages sent from the User. Direct messages sent from and to the User are viewable only by that User, or by others who have visibility to that User's workspace.
 
The directAddress setting for Users sets the direct address for that User. This is the address that will be used for direct messages sent from the User. Direct messages sent from and to the User are viewable only by that User, or by others who have visibility to that User's workspace.
  
 
==== <code>loginId</code> and <code>loginPassword</code> ====
 
==== <code>loginId</code> and <code>loginPassword</code> ====
−
 
 
The loginId and loginPassword settings for Users sets the login ID (or username) and login password to be used both for the Individual Authorization for that user, and for logging into the full Updox application.
 
The loginId and loginPassword settings for Users sets the login ID (or username) and login password to be used both for the Individual Authorization for that user, and for logging into the full Updox application.
  
 
==== <code>timeZone</code> ====
 
==== <code>timeZone</code> ====
−
 
 
The timeZone setting for Users sets the timeZone for the User which effects the representation of date-times for items. The default value is Zulu time, and the valid values are:   
 
The timeZone setting for Users sets the timeZone for the User which effects the representation of date-times for items. The default value is Zulu time, and the valid values are:   
 
    
 
    
−
: America/Anchorage
+
{{Valid Time Zones}}
−
: America/Chicago
+
−
: America/Denver
+
−
: America/New_York
+
−
: America/Los_Angeles
+
−
: America/Phoenix
+
−
: America/Puerto_Rico
+
−
: Pacific/Honolulu
+
−
: Zulu
+
  
 
== UserUpdate ==
 
== UserUpdate ==
−
 
+
UserUpdate is an explicit call to update the information or settings of a User. It provides the same fields as [[#UserCreate|UserCreate]], and '''''every field will be updated with the new values'''''. That is, if a User has a value saved for <code>middleName</code>, then not passing in a value for <code>middleName</code> to UsereUpdate will clear that value.   
−
{{UserUpdateLink}} is an explicit call to update the information or settings of a User. It provides the same fields as {{UserCreateLink}}, and '''''every field will be updated with the new values'''''. That is, if a User has a value saved for <code>middleName</code>, then not passing in a value for <code>middleName</code> to {{UserUpdateLink}} will clear that value.   
+
 
    
 
    
 
Note that when updating a User, the <code>userId</code> passed into the Application Authentication header will reference the User to be updated. If a User does not exist for that <code>userId</code>, the request will fail.
 
Note that when updating a User, the <code>userId</code> passed into the Application Authentication header will reference the User to be updated. If a User does not exist for that <code>userId</code>, the request will fail.
  
−
== UserSave ==
+
{{API Method Links|UserUpdate}}
  
−
{{UserSaveLink}} is a non-explicit call to *either* create *or* update a User. If a User does not exist for the <code>userId</code> passed into the Application Authentication header, then a new User will be created. Otherwise, the matching User will be updated.   
+
 
 +
== UserSave ==
 +
UserSave is a non-explicit call to *either* create *or* update a User. If a User does not exist for the <code>userId</code> passed into the Application Authentication header, then a new User will be created. Otherwise, the matching User will be updated.   
 
    
 
    
−
In the respective cases, {{UserSaveLink}} performs as {{UserCreateLink}} and {{UserUpdateLink}}.
+
In the respective cases, UserSave performs as [[#UserCreate|UserCreate]] and [[#UserUpdate|UserUpdate]].
 +
 
 +
{{API Method Links|UserSave}}

Latest revision as of 15:25, 21 November 2013

Within each Account there must be at least one User to auth with. A User represents a single group of Messages, Preferences, and Settings. Different systems also refer to users in various, sometime overlapping, ways; for example: providers, doctors, nurses, admins, office, etc.


Contents

User Management

The Updox API provides three methods to create a user: UserCreate, UserUpdate, and UserSave.

Creating or updating a User requires account-level credentials.


UserCreate

UserCreate is an explicit call to create a new User. It accepts multiple fields of both information about the User as well as settings, though only the firstName and lastName fields are required. Providing Account information will help to reference the User for support issues, while providing settings may be required for use in a particular integration.


User Information Fields

userId

Note that when creating a User, the userId passed into the Application Authentication header with the request will become the new userId used to reference and auth with the newly created User. If that userId is already in use, then the request will fail.

firstName

middleName

lastName

address1

address2

city

state

postal

User Settings Fields

active

The active setting for Users sets the active status. An inactive User will be denied authorization, and for security any attempt to auth will be met with the same unauthorized message as invalid credentials. The exceptions to this are the methods UserUpdate and UserSave which allow re-activation of a User. Thus, care must be taken when setting the active flag.

directAddress

The directAddress setting for Users sets the direct address for that User. This is the address that will be used for direct messages sent from the User. Direct messages sent from and to the User are viewable only by that User, or by others who have visibility to that User's workspace.

loginId and loginPassword

The loginId and loginPassword settings for Users sets the login ID (or username) and login password to be used both for the Individual Authorization for that user, and for logging into the full Updox application.

timeZone

The timeZone setting for Users sets the timeZone for the User which effects the representation of date-times for items. The default value is Zulu time, and the valid values are:

America/Anchorage
America/Chicago
America/Denver
America/New_York
America/Los_Angeles
America/Phoenix
America/Puerto_Rico
Pacific/Honolulu
Zulu

UserUpdate

UserUpdate is an explicit call to update the information or settings of a User. It provides the same fields as UserCreate, and every field will be updated with the new values. That is, if a User has a value saved for middleName, then not passing in a value for middleName to UsereUpdate will clear that value.

Note that when updating a User, the userId passed into the Application Authentication header will reference the User to be updated. If a User does not exist for that userId, the request will fail.


UserSave

UserSave is a non-explicit call to *either* create *or* update a User. If a User does not exist for the userId passed into the Application Authentication header, then a new User will be created. Otherwise, the matching User will be updated.

In the respective cases, UserSave performs as UserCreate and UserUpdate.

Retrieved from "http://updoxqa.com/wiki/index.php?title=User_Management&oldid=402"