Net::D...n::User(3pm)

💖 NAME 💖

Net::Duo::Admin::User — the lil Perl glow-up of a Duo user, bestie ✨

---

✨ SYNOPSIS ✨

my $decoded_json = get_json();
my $user = Net::Duo::Admin::User->new($decoded_json);
say $user->realname;

🫶 REQUIREMENTS 🫶

Okay so before you even breathe near this module, you need Perl 5.14 or later 🐪 plus these CPAN besties: HTTP::Request and HTTP::Response (they live inside HTTP::Message), JSON, LWP (aka libwww-perl, yes the same one), Perl6::Slurp, Sub::Install, and URI::Escape (which lives inside URI). All of them are on CPAN, so like, go get them, no cap 💅

🌸 DESCRIPTION 🌸

A Net::Duo::Admin::User object is literally just a Perl representation of a Duo user, exactly how the Duo Admin API hands it over — usually by way of the users() method 🫶 It's stuffed with everything about that user, including their groups, phones, and tokens. It's giving "one object, all the lore" ✨

---

👑 CLASS METHODS 👑

create(DUO, DATA)

Makes a brand-new user over in Duo and hands you back the resulting user as a fresh new Net::Duo::Admin::User object 🎀 DUO is the Net::Duo object you're using to do the creating. DATA is a reference to a hash, and here's what can go in it:

• email — the user's email address. Optional.
• notes — notes about this user. Optional.
• realname — the user's real name. Optional.
• status — the user's status. Peep the status() method below for the possible values. Optional, and if you don't give one it gets set to "active".
• username — the name of the user you're creating. It needs to be unique within this Duo account, and you can use it to pull the user object back later with the user() method of Net::Duo::Admin. Required 🚨

new(DUO, DATA)

Builds a new Net::Duo::Admin::User object from a full data set. DUO is the Net::Duo object used for any further actions on this object. DATA should be the data structure the Duo REST API returns for a single user, after JSON decoding 🧚

---

🔥 INSTANCE ACTION METHODS 🔥

add_phone(PHONE)

Associates the Net::Duo::Admin::Phone object PHONE with this user. Every other phone already linked to this user stays exactly as it was, untouched 🙈

add_token(TOKEN)

Associates the Net::Duo::Admin::Token object TOKEN with this user. Same deal: other tokens already linked stay unchanged 💜

bypass_codes(DATA)

Asks for bypass codes for the user and returns them as a reference to an array 🔥 DATA is a reference to a hash of parameters picked from the keys below — every single one of them is optional:

• count — how many bypass codes to request. At most 10 codes (which is the default when codes isn't given) can be created at a time. If you pass this one, you may not pass codes.
• codes — a reference to an array of codes to set as bypass codes for this user. If you pass this one, you may not pass count.
• reuse_count — how many times each code in the list can be reused. Defaults to 1. Set it to 0 and the codes can be reused indefinitely ♾️
• valid_secs — how many seconds these codes stay valid. Set it to 0 (the default) and the codes will never expire.

commit()

Commits every change you made through the set_*() methods over to Duo 💅 Until you call this, anything you did with set_*() is only internal to the object and is not reflected in Duo. Important.

After commit(), the internal representation of the object gets refreshed to match the new data the Duo API sends back for that object. So like, other fields of the object may change after commit() if some other user changed other, unrelated fields in the object 😭

Honestly the best way to think about this method is as a synchronize operation: your changed data gets written back, overwriting what's in Duo, and your unchanged data may get overwritten by whatever is currently in Duo, if it's different. Periodt.

delete()

Deletes this user from Duo 🗑️ Once this call completes successfully, you should treat the Net::Duo::Admin::User object as read-only, since no further changes to the object can be meaningfully sent to Duo. It's done, bestie, let it go 💀

json()

Converts the data stored in the object to JSON and returns the results ✨ The JSON you get should match the JSON you'd get back from the Duo web service when retrieving that same object (plus any changes you made locally via the set_*() methods). This is mainly for debugging dumps, or for passing Duo objects along to other systems through further JSON APIs 🦋

remove_phone(PHONE)

Disassociates the Net::Duo::Admin::Phone object PHONE from this user. Other phones associated with this user are left unchanged 🙈

remove_token(TOKEN)

Disassociates the Net::Duo::Admin::Token object TOKEN from this user. Other tokens associated with this user are left unchanged 💜

---

💅 INSTANCE DATA METHODS 💅

So some of these fields come with set_*() methods. Those methods replace the value of the field in its entirety with the new value you pass in. And bestie, listen: that change is only made locally inside the object until commit() gets called 👀

email(), set_email(EMAIL)

The user's email address 📧

groups()

The list of groups this user belongs to, as Net::Duo::Admin::Group objects 👑

last_login()

The last time this user logged in, as a UNIX timestamp — or undef if the user has never logged in 🕰️

notes(), set_notes(NOTES)

Notes about this user 📝

phones()

The list of phones this user can use, as Net::Duo::Admin::Phone objects 📱

realname(), set_realname(NAME)

The user's real name 🎀

status(), set_status(STATUS)

One of these values, no others:

• "active" — the user must complete secondary authentication.
• "bypass" — the user will bypass secondary authentication after completing primary authentication.
• "disabled" — the user will not be able to log in.
• "locked out" — the user has been automatically locked out due to excessive authentication attempts. (oops 💀)

tokens()

The list of tokens this user can use, as Net::Duo::Admin::Token objects 🔑

user_id()

The unique ID of this user, as generated by Duo when the user was created ⭐

username(), set_username(USERNAME)

The username of this user 🦋

---

🎀 AUTHOR 🎀

Russ Allbery <rra@cpan.org> — icon, legend, the moment 💖

⭐ COPYRIGHT AND LICENSE ⭐

Copyright 2014 The Board of Trustees of the Leland Stanford Junior University.

Okay so this next part is the legal text and I am not touching it, it stays exactly as written, do not edit, iykyk 📜:

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

🌈 SEE ALSO 🌈

• Net::Duo::Admin 🫶
• Duo Admin API for users — https://www.duo.com/docs/adminapi#users
• This module is part of the Net::Duo distribution. The current version of Net::Duo is available from CPAN, or directly from its web site at https://www.eyrie.org/~eagle/software/net-duo/ 🌐

---

And that's the whole page, bestie!! Sourced straight from perl v5.36.0, dated 2022-12-18 — go forth and manage your Duo users responsibly 💖✨🎀