VUser:...ingAPI(3pm)

πŸ“¦
version 1.0.1 Β· 2 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble

✨ NAME ✨

VUser::Google::ProvisioningAPI β€” bestie, it's a Perl module that implements the Google Apps for Your Domain Provisioning API. πŸ’–

(also hi, this is from the VUser:...ingAPI(3pm) manual page, Perl section, come sit with me 🫢)


🌸 SYNOPSIS 🌸

use VUser::Google::ProvisioningAPI;
my $google = new VUser::Google::ProvisioningAPI($domain,$admin,$password, $api_version);

$google->CreateAccount($userName, $firstName, $lastName, $password);
$google->RetrieveAccount($userName);

look at her go. iconic. πŸ’…


πŸŽ€ REQUIREMENTS πŸŽ€

okay so before you can even use VUser::Google::ProvisioningAPI, you need these modules installed, no skipping:

  • LWP::UserAgent
  • HTTP::Request
  • Encode
  • XML::Simple

that's the whole guest list. ✨


πŸ¦‹ DESCRIPTION πŸ¦‹

ngl, listen. VUser::Google::ProvisioningAPI::* is depricated (yes, spelled exactly like that in the source, we're keeping it πŸ’€) in favor of VUser::Google::ApiProtocol and VUser::Google::Provisioning. so like… noted. but she's still here and she still works.

VUser::Google::ProvisioningAPI gives you a simple interface to the Google Apps for Your Domain Provisioning API. she uses the LWP::UserAgent module for the HTTP transport, and the HTTP::Request module for the HTTP request and response. that's the whole plumbing situation. 🚰


πŸ‘‘ CONSTRUCTOR πŸ‘‘

new ( $domain, $admin, $adminpassword [,$api_version] )

this is the constructor for a brand new VUser::Google::ProvisioningAPI object. here's the vibe check on each arg:

  • $domain β€” the domain name registered with Google Apps For Your Domain 🌐
  • $admin β€” an account in the above domain that has the right to manage that domain πŸ‘‘
  • $adminpassword β€” the password for that account πŸ”
  • $api_version β€” the version of the Google Provisioning API you wish to use. at this time, only '1.0' and '2.0' are supported. periodt.
⚠️ important bestie: the constructor will NOT attempt to perform the 'ClientLogin' call to the Google Provisioning API. like, it just won't. authentication happens automatically when the first API call is performed. the token will be remembered for the duration of the object, and will be automatically refreshed as needed. so she's lowkey self-sufficient, we love that. 🫢

if you really wanna verify that you can get a valid token before performing any operations, follow the constructor with a call to IsAuthenticated() like this:

print "Authentication OK\n" unless not $google->IsAuthenticated();

the double negative is giving unhinged but she's valid. 😭✨


πŸ’… METHODS πŸ’…

the methods provided by the object will vary based on the version of the API. so please see the perldocs for the specific version you are using. for example, perldoc VUser::Google::ProvisioningAPI::1.0. iykyk. πŸ“š


🌈 EXPORT 🌈

None by default. nothing. zero. empty. she gives you nothing unless you ask. πŸ’€


⭐ SEE ALSO ⭐

for support, see the Google Group at http://groups.google.com/group/apps-for-your-domain-apis

  • VUser::Google::ProvisioningAPI::1.0
  • VUser::Google::ProvisioningAPI::2.0

πŸ› BUGS πŸ›

please report bugs or feature requests at http://code.google.com/p/vuser/issues/list. tell them i sent you (i did not send you). πŸ™ˆ


🧚 AUTHORS 🧚

  • Johan Reinalda, johan at reinalda dot net
  • Randy Smith, perlstalker at vuser dot net

legends, honestly. πŸ‘‘


Copyright (C) 2006 by Johan Reinalda, johan at reinalda dot net

Copyright (C) 2007 Randy Smith, perlstalker and vuser dot org

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.

If you make useful modification, kindly consider emailing then to me for inclusion in a future version of this module.


and that's the whole page bestie πŸ’–βœ¨πŸŽ€πŸ¦‹πŸŒΈπŸ’…πŸ«Ά

this was perl v5.32.0, dated 2021-01-09, straight out of the VUser:...ingAPI(3pm) manual β€” no cap. go forth and provision. πŸ‘‘πŸŒˆβ­

πŸ“¦ where this page comes from