Authorization (ISecurity Interface)

SetInternalPassword

Creates an InternalLogin object for the specified user.

Category: Internal authentication methods

Interface version: ISecurity 1.1

SetInternalPassword(personName,passwordValue);

Parameters

Parameter	Type	Direction	Description
personName	string	in	Specifies the Name= value of the Person object for which the InternalLogin object will be created. Person objects that are used for internal accounts have a one-word name, and are identified by this name.
passwordValue	string	in	A password that meets the site's password authentication policies.

Details

You must have user administration capabilities on the SAS Metadata Server to create an InternalLogin object. For information about user administration capabilities, see "Users, Groups, and Roles: Main Administrative Roles" in the SAS Intelligence Platform: Security Administration Guide.

Internal logins are not intended for regular users. They are intended for metadata administrators and some service identities. For more information, see "SAS Internal Authentication" in the SAS Intelligence Platform: Security Administration Guide.

The SetInternalPassword method creates an InternalLogin object and associates it with the specified Person object. Together, the two objects define an internal account. The new InternalLogin object is created with the site's internal authentication policies. To determine what the active policy settings are, use the GetInternalLoginSitePolicies method. Or, use the GetInternalLoginUserInfo method to list the new object's properties.

New InternalLogin objects are created with a 30-day password expiration period. To deactivate the password expiration period or customize its length, or to customize other internal authentication settings, use the SetInternalLoginUserOptions method. If the ExpirePasswordonReset option is set in the site's omaconfig.xml file, the user will have to reset the initial password before the internal account can be used.

Exceptions Thrown

The SetInternalPassword method does not return any exceptions.

Examples

The following is a Java example of a SetInternalPassword method call:

// Defines parameters personName and passwordValue assuming
// a Person object with Name='testId' already exists 
String personName = "testId";
String passwordValue = "pw1234";

iSecurity.SetInternalPassword(personName,passwordValue);

Related Methods

Top of Page