.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.40)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "VUser::Google::ProvisioningAPI 3pm"
.TH VUser::Google::ProvisioningAPI 3pm "2021-01-09" "perl v5.32.0" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME"
VUser::Google::ProvisioningAPI \- Perl module that implements the Google Apps for Your Domain Provisioning API
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use VUser::Google::ProvisioningAPI;
\&  my $google = new VUser::Google::ProvisioningAPI($domain,$admin,$password, $api_version);
\&
\&  $google\->CreateAccount($userName, $firstName, $lastName, $password);
\&  $google\->RetrieveAccount($userName);
.Ve
.SH "REQUIREMENTS"
.IX Header "REQUIREMENTS"
VUser::Google::ProvisioningAPI requires the following modules to be installed:
.IP "\(bu" 4
\&\f(CW\*(C`LWP::UserAgent\*(C'\fR
.IP "\(bu" 4
\&\f(CW\*(C`HTTP::Request\*(C'\fR
.IP "\(bu" 4
\&\f(CW\*(C`Encode\*(C'\fR
.IP "\(bu" 4
\&\f(CW\*(C`XML::Simple\*(C'\fR
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
\&\fBVUser::Google::ProvisioningAPI::* is depricated in favor of VUser::Google::ApiProtocol and VUser::Google::Provisioning.\fR
.PP
VUser::Google::ProvisioningAPI provides a simple interface to the Google Apps for Your Domain Provisioning \s-1API.\s0
It uses the \f(CW\*(C`LWP::UserAgent\*(C'\fR module for the \s-1HTTP\s0 transport, and the \f(CW\*(C`HTTP::Request\*(C'\fR module for the \s-1HTTP\s0 request and response.
.SH "CONSTRUCTOR"
.IX Header "CONSTRUCTOR"
new ( \f(CW$domain\fR, \f(CW$admin\fR, \f(CW$adminpassword\fR [,$api_version] )
.PP
This is the constructor for a new VUser::Google::ProvisioningAPI object.
\&\f(CW$domain\fR is the domain name registered with Google Apps For Your Domain,
\&\f(CW$admin\fR is an account in the above domain that has the right to manage that domain,
\&\f(CW$adminpassword\fR is the password for that account and \f(CW$api_version\fR is the
version of the Google Provisioning \s-1API\s0 you wish to use. At this time, only
\&'1.0' and '2.0' are supported.
.PP
Note that the constructor will \s-1NOT\s0 attempt to perform the 'ClientLogin' call to the Google Provisioning \s-1API.\s0
Authentication happens automatically when the first \s-1API\s0 call is performed. The token will be remembered for the duration of the object, and will be automatically refreshed as needed.
If you want to verify that you can get a valid token before performing any operations, follow the constructor with a call to \fBIsAuthenticated()\fR as such:
.PP
.Vb 1
\&        print "Authentication OK\en" unless not $google\->IsAuthenticated();
.Ve
.SH "METHODS"
.IX Header "METHODS"
The methods provided by the object will vary based on the version of the \s-1API.\s0
Please see the perldocs for specific version you are using. For example,
\&\f(CW\*(C`perldoc VUser::Google::ProvisioningAPI::1.0\*(C'\fR.
.SH "EXPORT"
.IX Header "EXPORT"
None by default.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
For support, see the Google Group at
http://groups.google.com/group/apps\-for\-your\-domain\-apis
.PP
VUser::Google::ProvisioningAPI::1.0
.PP
VUser::Google::ProvisioningAPI::2.0
.SH "BUGS"
.IX Header "BUGS"
Please report bugs or feature requests at
http://code.google.com/p/vuser/issues/list.
.SH "AUTHORS"
.IX Header "AUTHORS"
Johan Reinalda, johan at reinalda dot net
.PP
Randy Smith, perlstalker at vuser dot net
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (C) 2006 by Johan Reinalda, johan at reinalda dot net
.PP
Copyright (C) 2007 Randy Smith, perlstalker and vuser dot org
.PP
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.8.5 or,
at your option, any later version of Perl 5 you may have available.
.PP
If you make useful modification, kindly consider emailing then to me for inclusion in a future version of this module.