EsbCreateExtUser
Description
EsbCreateExtUser() 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
Parameters
| hCtx |
Essbase API context handle. |
| UserName |
Name of user to create. User names can be 30 characters long. |
| Password |
Security password for new user. Passwords can be up to 100 characters long. |
| SecurityProvider |
The name of the external authentication mechanism. |
| ProviderConnectionParameters |
Parameters used by the external authentication mechanism, if any. |
Return Value
None.
Notes
- The specified user must not already exist.
- The user's access level and other parameters may be set with the EsbSetUser() function.
- You 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 EsbSetPassword() function.
Access
This function requires the caller to have Create/Delete User privilege
(ESS_PRIV_USERCREATE) for the logged in server.
Example
See Also