Namespace: OpenEdge.Security.Provider
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 GetAttribute (character, character) /* Retrieves a value for the a requested attribute, per user @param character A unique userid @param character The name of the attribute for which to return a value return character An attribute value for the given user. May be empty or unknown. */
Inherited from OpenEdge.Security.Provider.IAuthProvider
CHARACTER GetAttributeNames (character) /* Returns an array of attributes for a given user @param character A unique userid @return character[] An array of attribute names. */
Inherited from OpenEdge.Security.Provider.IAuthProvider
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 */
LOGICAL SetAttribute (character, character, character) /* Sets an attribute's value for a user. May optionally create an attribute value. @param character A unique userid @param character The name of the attribute to remove @param character The value to apply @return logical TRUE if the attribute value was successfully set; FALSE otherwise */
Inherited from OpenEdge.Security.Provider.IAuthProvider
LOGICAL ValidatePassword (character, character) /* Simple, clear-text password validation for a user @param character A unique userid @param character The user's (cleartext) password to verify @return logical TRUE if the provide credentials match the realm's values */
Inherited from OpenEdge.Security.Provider.IAuthProvider
LOGICAL ValidatePassword (character, character, character, character) /* Digest-encoded password validation for a user @param character A unique userid @param character The hashed digest of the password to verify @param character The nonce value used to create the digest hash @param character The timestamp value used to create the digest hash @return logical TRUE if the provide credentials match the realm's values */
Inherited from OpenEdge.Security.Provider.IAuthProvider
CHARACTER ValidateUser (character) /* Validates that the username is in the realm, and returns a unique identifier for the user (which may be the username@domain). @param character The client-supplied username @return character A unique identifier for the user */
Inherited from OpenEdge.Security.Provider.IAuthProvider


Method Detail
Top

PUBLIC CHARACTER GetAttribute (character, character)

Inherited from OpenEdge.Security.Provider.IAuthProvider
/* Retrieves a value for the a requested attribute, per user
return character An attribute value for the given user. May be empty or unknown.
Parameters:
pcUserId CHARACTER
pcAttributeName CHARACTER
Returns CHARACTER
Top

PUBLIC CHARACTER GetAttributeNames (character)

Inherited from OpenEdge.Security.Provider.IAuthProvider
/* Returns an array of attributes for a given user
Parameters:
pcUserId CHARACTER
Returns CHARACTER
character[] An array of attribute names.
Top

PUBLIC CHARACTER GetUserNames ()

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

PUBLIC 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

PUBLIC 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
Top

PUBLIC LOGICAL SetAttribute (character, character, character)

Inherited from OpenEdge.Security.Provider.IAuthProvider
/* Sets an attribute's value for a user. May optionally create an attribute value.
Parameters:
pcUserId CHARACTER
pcAttributeName CHARACTER
pcAttributeValue CHARACTER
Returns LOGICAL
logical TRUE if the attribute value was successfully set; FALSE otherwise
Top

PUBLIC LOGICAL ValidatePassword (character, character)

Inherited from OpenEdge.Security.Provider.IAuthProvider
/* Simple, clear-text password validation for a user
Parameters:
pcUserId CHARACTER
pcPassword CHARACTER
Returns LOGICAL
logical TRUE if the provide credentials match the realm's values
Top

PUBLIC LOGICAL ValidatePassword (character, character, character, character)

Inherited from OpenEdge.Security.Provider.IAuthProvider
/* Digest-encoded password validation for a user
Parameters:
pcUserId CHARACTER
pcDigest CHARACTER
pcNonce CHARACTER
pcTimestamp CHARACTER
Returns LOGICAL
logical TRUE if the provide credentials match the realm's values
Top

PUBLIC CHARACTER ValidateUser (character)

Inherited from OpenEdge.Security.Provider.IAuthProvider
/* Validates that the username is in the realm, and returns a unique identifier for
the user (which may be the username@domain).
Parameters:
pcUserName CHARACTER
Returns CHARACTER
character A unique identifier for the user


Copyright © 2020 Progress Software Corporation. All rights Reserved.

Progress® OpenEdge® Release 12.2.0