![]() | SUMMARY | DETAIL |
Macros to create and manipulate user accounts in the system.
Macro Summary | |
external | %lsaf_createuser(lsaf_userid=, lsaf_displayname=, lsaf_email=, lsaf_accounttype=, lsaf_password=, lsaf_firstname=, lsaf_lastname=, lsaf_department=, lsaf_phone=);
Creates a user account.
|
external | %lsaf_deleteuser(lsaf_userid=);
Deletes a user account.
|
external | %lsaf_encryptpassword(lsaf_password=);
Encrypts the password for a user account.
|
external | %lsaf_getallusers(sas_dsname=work.lsafGetAllUsers);
Gets the metadata for all of the user accounts that are defined. The metadata is stored in a ...
|
external | %lsaf_getuserauthproviders(sas_dsname=work.lsafGetUserAuthProviders);
Gets all of the user authentication providers available to the system. The providers are stored ...
|
external | %lsaf_getuserlicensetypes(sas_dsname=work.lsafGetUserLicenseTypes);
Gets all of the user license types that are defined. The types are stored in a SAS data set.
|
external | %lsaf_getuserproperties(lsaf_userid=, sas_dsname=work.lsafGetUserProperties);
Gets all of the properties for the specified user. The properties are stored in a SAS data set.
|
external | %lsaf_isuserlocked(lsaf_userid=);
Indicates whether a user account is locked.
|
external | %lsaf_lockuser(lsaf_userid=);
Locks a user account.
|
external | %lsaf_resetpassword(lsaf_userid=, lsaf_newpassword=);
Resets the password for a user account.
|
external | %lsaf_setuserdefaultauthenticator(lsaf_userid=, lsaf_password=);
Sets the default authenticator for a user account.
|
external | %lsaf_setuserextauthenticator(lsaf_userid=, lsaf_authenticatorid=, lsaf_authenticatorname=);
Sets the external authenticator for the user account. To change a user account back to a ...
|
external | %lsaf_unlockuser(lsaf_userid=);
Unlocks a user account.
|
external | %lsaf_updateuserinfo(lsaf_userid=, lsaf_displayname=_lsaf_updateuser_donotupdate_, lsaf_email=_lsaf_updateuser_donotupdate_, lsaf_accounttype=_lsaf_updateuser_donotupdate_, lsaf_firstname=_lsaf_updateuser_donotupdate_, lsaf_lastname=_lsaf_updateuser_donotupdate_, lsaf_department=_lsaf_updateuser_donotupdate_, lsaf_phone=_lsaf_updateuser_donotupdate_);
Updates the general user account information.
Deprecated. Replaced by lsaf_updateuserproperties in this release, and will be deprecated in future release. *; |
external | %lsaf_updateuserproperties(lsaf_userid=, sas_dsname=);
Updates the editable properties of a user account using a SAS data set as input.
|
external | %lsaf_userexists(lsaf_userid=);
Indicates whether a user account exists.
|
Macro Detail |
%lsaf_createuser(lsaf_userid=, lsaf_displayname=, lsaf_email=, lsaf_accounttype=, lsaf_password=, lsaf_firstname=, lsaf_lastname=, lsaf_department=, lsaf_phone=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_userid
-
- Required - The user identifier of the account.lsaf_displayname
-
- Required - The display name of the account.lsaf_email
-
- Required - The email address of the account.lsaf_accounttype
-
- Required - The account type. Valid values:lsaf_password
-
- Required - The password for the account.lsaf_firstname
-
- Optional - The first name of the user for the account.lsaf_lastname
-
- Optional - The last name of the user for the account.lsaf_department
-
- Optional - The business unit for the account.lsaf_phone
-
- Optional - The phone number of the user for the account.
%lsaf_deleteuser(lsaf_userid=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_userid
-
- Required - The user identifier of the account.
%lsaf_encryptpassword(lsaf_password=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_password
-
- Required - The password.
%lsaf_getallusers(sas_dsname=work.lsafGetAllUsers);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.sas_dsname
-
- Optional - The name of the output SAS data set to contain the metadata
%lsaf_getuserauthproviders(sas_dsname=work.lsafGetUserAuthProviders);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.sas_dsname
-
- Optional - The name of the output SAS data set to contain the authentication
%lsaf_getuserlicensetypes(sas_dsname=work.lsafGetUserLicenseTypes);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.sas_dsname
-
- Optional - The name of the output SAS data set to contain the user license
%lsaf_getuserproperties(lsaf_userid=, sas_dsname=work.lsafGetUserProperties);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_userid
-
- Required - The identifier of the user.sas_dsname
-
- Optional - The name of the output SAS data set to contain the properties
%lsaf_isuserlocked(lsaf_userid=);
[ Exposure:
external
]
_lsafIsUserLocked_
-
Indicates whether the user account is locked._lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_userid
-
- Required - The unique identifier of the user account.
%lsaf_lockuser(lsaf_userid=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_userid
-
- Required - The user identifier of the user account.
%lsaf_resetpassword(lsaf_userid=, lsaf_newpassword=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_userid
-
- Required - The user identifier of the account.lsaf_newpassword
-
- Required - The new, temporary password.
%lsaf_setuserdefaultauthenticator(lsaf_userid=, lsaf_password=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_userid
-
- Required - The unique identifier of the user account.lsaf_password
-
- Required - The unique password for the user account that overwrites the
%lsaf_setuserextauthenticator(lsaf_userid=, lsaf_authenticatorid=, lsaf_authenticatorname=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_userid
-
- Required - The unique identifier of the user account.lsaf_authenticatorid
-
- Required - The unique identifier of the external authenticator.lsaf_authenticatorname
-
- Optional - The user name known to the external authenticator.
%lsaf_unlockuser(lsaf_userid=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_userid
-
- Required - The user identifier of the user account.
%lsaf_updateuserinfo(lsaf_userid=, lsaf_displayname=_lsaf_updateuser_donotupdate_, lsaf_email=_lsaf_updateuser_donotupdate_, lsaf_accounttype=_lsaf_updateuser_donotupdate_, lsaf_firstname=_lsaf_updateuser_donotupdate_, lsaf_lastname=_lsaf_updateuser_donotupdate_, lsaf_department=_lsaf_updateuser_donotupdate_, lsaf_phone=_lsaf_updateuser_donotupdate_);
[ Exposure:
external
]
Deprecated. Replaced by lsaf_updateuserproperties in this release, and will be deprecated in future release. *;
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_userid
-
- Required - The user identifier of the account.lsaf_displayname
-
- Optional - The user display name.lsaf_email
-
- Optional - The user email address.lsaf_accounttype
-
- Optional - The user account type. Valid values:lsaf_firstname
-
- Optional - The first name of the user.lsaf_lastname
-
- Optional - The last name of the user.lsaf_department
-
- Optional - The business unit of the user.lsaf_phone
-
- Optional - The phone number of the user.
%lsaf_updateuserproperties(lsaf_userid=, sas_dsname=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code.lsaf_userid
-
- Required - The unique identifier of the user account.sas_dsname
-
- Required - The name of the SAS data set that contains the property
%lsaf_userexists(lsaf_userid=);
[ Exposure:
external
]
_lsafMsg_
-
The return message._lsafRC_
-
The return code._lsafUserExists_
-
Indicates whether the user account exists.lsaf_userid
-
- Required - The identifier of the user account.