EssCreateExtUser

Creates a new externally authenticated user.

Syntax

ESS_FUNC_M EssCreateExtUser (hCtx, UserName, Password, SecurityProvider, ProviderConnectionParameters);

Parameter

Data Type

Description

hCtx

ESS_HCTX_T

API context handle.

UserName

ESS_STR_T

Name of user to create. See User Name Limits.

Password

ESS_STR_T

Security password for new user. See Password Limits.

Note:

The Password parameter has been made redundant by changes for Shared Services. You can use an empty string for this parameter.

SecurityProvider

ESS_PROTOCOL_T

The name of the external authentication mechanism.

ProviderConnectionParameters

ESS_CONNPARAM_T

Parameters used by the external authentication mechanism, if any.

Notes

The specified user must not already exist.
The user's access level and other parameters may be set with the EssSetUser() function.
Your program should ensure that the password has been entered correctly (e.g. by requiring the user to type it twice) before calling this function. Once entered, it is not possible to retrieve a password. However, a password can be changed using the EssSetPassword() function.

Return Value

None.

Access

This function requires the caller to have Create/Delete User privilege (ESS_PRIV_USERCREATE) for the logged in server.

Example

ESS_FUNC_M ESS_CreateUser (ESS_HCTX_T   hCtx) 
{ 
    ESS_FUNC_M     sts = ESS_STS_NOERR; 
    ESS_STR_T      UserName; 
    ESS_STR_T      Password; 
    ESS_PROTOCOL_T Protocol; 
    ESS_CONN_PARAM ConnParam; 
     
    UserName = "Jim Smith"; 
    Password = "Password"; 
    Protocol = CSS; 
    ConnParam = NULL; 
     
    sts = EssCreateExtUser (hCtx, UserName, Password, Protocol, ConnParam); 
     
    return (sts); 
}