Creates a new externally authenticated user.
Syntax
Declare Function EsbCreateExtUser Lib "esbapin" ( ByVal hCtx As Long, ByVal UserName As String, ByVal Password As String, ByVal Protocol As String, ByVal Connparam As String) As Long
| Parameter | Description |
|---|---|
hCtx | API context handle. |
UserName | Name of user to create. See User Name Limits. |
Password | Security password for new user. See Password Limits. |
SecurityProvider | The name of the external authentication mechanism. |
ProviderConnectionParameters | 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 EsbSetUser() function.
Your program should ensure that the password has been entered correctly before calling this function; for example, by requiring the user to type it twice. Once entered, it is not possible to retrieve a password. However, a password can be changed using the EsbSetPassword() function.
The Password parameter has been made redundant by changes for Shared Services. You can use an empty string for this parameter.
Return Value
None.
Access
This function requires the caller to have Create/Delete User privilege (ESS_PRIV_USERCREATE) for the logged in server.