Account Management APIs
As a companion to our shell-based account management system, we've exposed our account management suite via a series of APIs. Typical uses of the APIs might be for bulk account creation, password synchronization, or to generate automated reports of account use.
The APIs are accessible via SOAP over HTTPS, for which client frameworks are available in just about every modern development language. We can provide example client code for Perl and PHP (since that's what we use).
Contact us for further information on using our API suite.
create_account
parameters:
dept_userid, dept_passwd, dept_domain, userid, password, last_name, first_name, middle_initial, fullname_address, mail_quota
example:
create_account("dept_userid", "dept_passwd", "mydomain.ucsb.edu", "johnsmith", "johnpwd", "Smith", "John", "", "john.smith@mydomain.ucsb.edu", "100")
return value:
returns error string on failure or 0 on success
usage notes:
- set the fullname_address to "NONE" to disable this feature
- the middle_initial can be blank with ""
- set the password to "----" if you'd like to auto-generate a random password
- the middle_initial can be blank with ""
- set the password to "----" if you'd like to auto-generate a random password
delete_account
parameters:
dept_userid, dept_passwd, userid, delayed_delete
example:
delete_account("dept_userid", "dept_passwd", "johnsmith", "1")
return value:
returns error string on failure or 0 on success
usage notes:
- if delayed_delete is set to "1", account will be deleted in 30 days
change_password
parameters:
dept_userid, dept_passwd, userid, password
example:
change_password("dept_userid", "dept_passwd", "johnsmith", "newpwd")
return value:
returns error string on failure or 0 on success
usage notes:
get_account
parameters:
dept_userid, dept_passwd, userid
example:
get_account("dept_userid", "dept_passwd", "johnsmith")
return value:
returns array containing account data: userid, full_name, fullname_address, fwd_address, fwd_local_copy, enable_autoreply, enable_passwd_reset, mail_usage, mail_quota, quota_percent, termination_date
usage notes:
- mail usage and quota values are in MB
- termination date is set only when an account has delayed_delete set
get_all_accounts
parameters:
dept_userid, dept_passwd, domain
example:
get_account("dept_userid", "dept_passwd", "mydomain.ucsb.edu")
return value:
returns two-dimensional array containing account data from all accounts, where each element is the format specified in the get_account api
usage notes:
set_quota
parameters:
dept_userid, dept_passwd, userid, new_quota
example:
set_quota("dept_userid", "dept_passwd", "johnsmith", "200")
return value:
returns error string on failure or 0 on success
usage notes:
- quota values are in MB
change_fullname
parameters:
dept_userid, dept_passwd, userid, last_name, first_name, middle_initial
example:
change_fullname("dept_userid", "dept_passwd", "johnsmith", "Smith", "Jonathan", "P")
return value:
returns error string on failure or 0 on success
usage notes:
- updates firstname.lastname@domain address if it's been previously set
set_fullname_address
parameters:
dept_userid, dept_passwd, userid
example:
set_fullname_address("dept_userid", "dept_passwd", "johnsmith")
return value:
returns error string on failure or 0 on success
usage notes:
- enables firstname.lastname@domain address if it's available
unset_fullname_address
parameters:
dept_userid, dept_passwd, userid
example:
unset_fullname_address("dept_userid", "dept_passwd", "johnsmith")
return value:
returns error string on failure or 0 on success
usage notes:
- disables firstname.lastname@domain addressing for this account
get_alias
parameters:
dept_userid, dept_passwd, domain, alias_address
example:
get_alias("dept_userid", "dept_passwd", "mydomain.ucsb.edu", "myalias")
return value:
returns target address of the specified mail alias
usage notes:
get_all_aliases
parameters:
dept_userid, dept_passwd, domain
example:
get_all_aliases("dept_userid", "dept_passwd", "mydomain.ucsb.edu")
return value:
returns a two-dimensional array containing each mail alias and target address
usage notes:
create_alias
parameters:
dept_userid, dept_passwd, domain, mail_alias, target_address
example:
get_all_aliases("dept_userid", "dept_passwd", "mydomain.ucsb.edu", "myalias", "real_address@mydomain.ucsb.edu")
return value:
returns error string on failure or 0 on success
usage notes:
delete_alias
parameters:
dept_userid, dept_passwd, domain, mail_alias
example:
delete_alias("dept_userid", "dept_passwd", "mydomain.ucsb.edu", "myalias")
return value:
returns error string on failure or 0 on success
usage notes:
get_domain_info
parameters:
dept_userid, dept_passwd, domain
example:
get_domain_info("dept_userid", "dept_passwd", "mydomain.ucsb.edu")
return value:
returns array containing account data: domain, number_of_accounts, number_of_aliases, total_mail_usage, total_mail_quota_allocated, group_mail_quota
usage notes:
- mail usage and quota values are in MB
