Namespace: OpenEdge.Security.Provider
Type: Interface IAuthProviderAdmin
Parent Classes:
Inherits: OpenEdge.Security.Provider.IAuthProvider

Copyright (c) 2016 by Progress Software Corporation. All rights reserved.
File:IAuthProviderAdmin
Purpose:Defines an interface for interacting with an OE Authentication
Provider from an STS.
Author(s):pjudge
Created:Thu Feb 11 09:53:15 EST 2016
Notes:* Based on the Progress.Security.Realm.IHybridRealm interface
Purpose: ATTRIBUTE OPERATIONS



Method Summary
  Options Name Purpose
  CHARACTER GetUserNames () /* Returns an array of all user names in this realm @return character[] An array of user names. */
  CHARACTER GetUserNamesByQuery (character) /* Returns a filtered array of user names in this realm @param character A query filter string to select the user names to return. The format depends on the realm implementation @return character[] An array of user names. */
  LOGICAL RemoveAttribute (character, character) /* Removes an attribute value for a user. @param character A unique userid @param character The name of the attribute to remove @return logical TRUE if the attribute value was successfully removed; FALSE otherwise */

Method Detail
Top

CHARACTER GetUserNames ()

/* Returns an array of all user names in this realm
Returns CHARACTER
  character[] An array of user names.
Top

CHARACTER GetUserNamesByQuery (character)

/* Returns a filtered array of user names in this realm
the realm implementation
Parameters:
pcQueryString CHARACTER
 
Returns CHARACTER
  character[] An array of user names.
Top

LOGICAL RemoveAttribute (character, character)

/* Removes an attribute value for a user.
Parameters:
pcUserId CHARACTER
 
pcAttributeName CHARACTER
 
Returns LOGICAL
  logical TRUE if the attribute value was successfully removed; FALSE otherwise