Programming Guides › Programming Guide for Perl › CLI Agent API Methods › Agent Administration Methods › CreateUser Method—Creates a User Object

CreateUser Method—Creates a User Object

The CreateUser method creates a user object containing the information passed to the method in the parameters. Perl uses this object to perform user operations, such as login.

Note: This method does not create a new user in the user directory.

Syntax

The CreateUser method has the following format:

Netegrity::AgentAPI‑>CreateUser(Username, Password[, cert][, certLength])

Parameters

The CreateUser method accepts the following parameters:

Username (string)

Specifies the user's ID.

Password (string)

Specifies the user's password.

cert (string)

(Optional) Specifies an X.509 certificate for user authentication.

certLength (int)

(Optional) Specifies the length of the certificate.

Return Value

The CreateUser method returns one of the following values:

• AgentUser (object)
• undef

  Specifies that the method failed.