OCIO » Phonebook API Docs

Phonebook API Docs

Last modified by Mike Phillips on 2014/07/01 10:26

Contents

Method: ValidateEmailAddress

Checks to see that the exact (case-insensitive) e-mail address exists within the directory's scope. 

 

Parameters:

  • EmailAddress (string) - The e-mail address to be found. This method does NOT search against userPrincipalName (user ID) - use FindUserByID instead.

Returns:

  • (boolean) - True if the e-mail belongs to a current State employee within the directory, False otherwise.

     

Method:FindUserByID

Checks to see that the exact (case-insensitive) user ID exists within the directory's scope. 

 

Parameters:

  • auth (AuthData) - Optional authentication credentials. If the token field is set, the user ID and password fields are ignored. This credential is checked against Enterprise A&A. 
  • UserID (string) - The unique identifier for the specified user. This is the userPrincipalName Active Directory attribute. 
  • options (SearchOptions) - A set of parameters that governs the scope of the search and the depth of information returned. Options include:
    • IncludeExternalAccounts: If TRUE, the search will look in employee AND non-employee ENTAA accounts. Otherwise, only internal records are searched. Only observed for authenticated requests. 
    • IncludeGroupMemberships: If TRUE, the search will return the names of all Active Directory groups that the user is a member of. Only observed for authenticated requests. 
    • UseExactMatch: If TRUE, the search will look only for the entire and exact string(s) specified in any criteria fields. 
    • MaxEntriesToReturn: The most results that the request should return. The service will stop looking for matches after finding this many records. The records are returned by the repository in a non-deterministic list.

Returns:

  • (PhoneBookEntry) - A completed PhoneBookEntry for the account that was found, subject to the search options that were provided. Otherwise, a Null object if no match is found.

     

Method: FindEntries

Searches for directory entries that match the specified criteria values. 

 

Parameters:

  • auth (AuthData) - Optional authentication credentials. If the token field is set, the user ID and password fields are ignored. This credential is checked against Enterprise A&A. 
  • criteria (PhoneBookEntry) - A sample PhoneBookEntry object with fields set to indicate the search criteria to be used. All non-empty fields are added to the search filter. 
  • options (SearchOptions) - A set of parameters that governs the scope of the search and the depth of information returned. See FindUserByID, above, for more information.

Returns:

  • (PhoneBookEntryPhonebookAPIDocs) - A completed PhoneBookEntry for each account that matches all of the provided criteria, subject to the search options that were provided.

     

Type: AuthData

Contains service-specific authentication credentials.  These values are checked against ITE Enterprise A&A. 

 

Properties:

  • UserID (string) - The unique identifier for the credential. 
  • Password (string) - The shared secret that is used to validate the caller. 
  • Token (string) - Represents an existing session with Enterprise A&A.  This value can be validated instead of a user ID and password.

     

Type: PhoneBookEntry

Represents the account data being provided by the service. 

 

Properties:

  • firstName (string) - First name of the account. 
  • middleInitial (string) - Middle initial of the account. 
  • lastName (string) - Last name of the account. 
  • lANID (string) - Unique identifier for the account. This field is mapped to the userPrincipalName field in Active Directory. 
  • employeeID (string) - Payroll identifier for the user, if a State employee. 
  • emailAddress (string) - E-Mail address for the account. 
  • jobClass (string) - Job class, if a State employee. 
  • building (string) - Building name, if location is known. 
  • orgName (string) - Agency name, if the organization is known. 
  • phone (string) - Phone number, if known. 
  • employmentStatus (string) - Employment status (full-time, part-time, etc.), if the user is a State employee. 
  • supervisorName (string) - Supervisor's name (directory-style), if the organization is known. 
  • supervisorPhone (string) - Supervisor's phone number, if known. 
  • supervisorEmail (string) - Supervisor's e-mail address, if known. 
  • address (Address) - User's work location, including street address, city, zip code and county, if the work location is known. 
  • groups (string[]) - Array of Active Directory group names to which the user belongs.

Note:  The service can only find and return Universal Security Groups. Domain-local or even so-called Global Security Groups cannot be included. Be aware of this when defining groups for use through this service (fo, e.g., authorization)

Tags:
Created by Mike Phillips on 2011/06/07 15:01

This wiki is licensed under a Creative Commons 2.0 license
XWiki Enterprise 3.0.36132 - Documentation