SetCQAuthentication

Description

Sets a user account AuthenticationMode to CQ_AUTHENTICATION, which uses traditional DevOps Plan enabled user authentication.

Setting the AuthenticationMode for a user to CQ_AUTHENTICATION sets the DevOps Plan user account password to the new_password argument which is then stored as the DevOps Plan password in the DevOps Plan application, as is done for all traditional DevOps Plan authenticated users.

Note: The caller of this method must have Administrator privileges (that is, a UserPrivilegeMaskType value, USER_ADMIN) to set this value. DevOps Plan prevents SuperUsers from setting their own AuthenticationMode.

Syntax

Perl


$user->SetCQAuthentication(new_password);

Identifier: Description
user: A User object.
new_password: A String specifying the user password. This value resets the DevOps Plan user password to this new value.
Return value: None on success, else an exception.

Example

Perl

# Set user's authentication to CQ authenticated
sub set_cq_auth
{
	my ($user, $newpwd) = @_;
	eval{$user->SetCQAuthentication($newpwd);};
	if ($@)
	{
		print "Couldnt run user->SetCQAuthentication.  Error: $@\n";
		die;
	}
}