NAME

BuildForge::API::User


SYNOPSIS

        my $User = new BuildForge::API::User();
        $User->{'name'} = "The API User";
        $User->{'login'} = "apiuser";
        $User->{'password'} = "apiuser";
        $User->Create();


DESCRIPTION

    This is available to use after a BuildForge::API object has been
instantiated. It is used to create and delete users defined in the BuildForge
console.


METHODS

new({UserParamsHashRef})

Create an object to access existing user information, or to add a new user to the BuildForge console.

name
The long name for the user

login
The login name for the user

password
The password for the user

build_limit
Maximum number of builds aloowed to run per day

email_address
The email address for the user

time_zone
Time zone code (EDT,EST,CDT,... etc.)

date_format
Date display format (e.g., ``%d %b %y %H:%M'')

password_expires
User password will expire

priority_login
User can kick other users off system for license

allowed_access
Access group ids for the user (array reference)

Create()

Create a new BuildForge user. Requires the objects 'name', 'login', and 'password' to be set.

Sync()

Syncs the user object with the corresponding user data from the database. The user object must have any of 'name', 'login', 'user_id' or 'email_address' for this method to succeed.

Delete()

Deletes a user account, will not allow you to delete userid 1 (root). Requires 'name' or 'userid' variables to be set.


AUTHOR

BuildForge, Inc.