.\" 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 .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. . \" fudge factors for nroff and troff .if n \{\ . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] \fP .\} .if t \{\ . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff .if n \{\ . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} .if t \{\ . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V' .ds 8 \h'\*(#H'\(*b\h'-\*(#H' .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#] .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H' .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u' .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#] .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#] .ds ae a\h'-(\w'a'u*4/10)'e .ds Ae A\h'-(\w'A'u*4/10)'E . \" corrections for vroff .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u' .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u' . \" for low resolution devices (crt and lpr) .if \n(.H>23 .if \n(.V>19 \ \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} .rm #[ #] #H #V #F C .\" ======================================================================== .\" .IX Title "Net::Duo::Admin::Token 3pm" .TH Net::Duo::Admin::Token 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" Net::Duo::Admin::Token \- Representation of a Duo token .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 3 \& my $decoded_json = get_json(); \& my $token = Net::Duo::Admin::Token\->new($decoded_json); \& say $token\->serial; .Ve .SH "REQUIREMENTS" .IX Header "REQUIREMENTS" Perl 5.14 or later and the modules HTTP::Request and HTTP::Response (part of HTTP::Message), \s-1JSON, LWP\s0 (also known as libwww-perl), Perl6::Slurp, Sub::Install, and URI::Escape (part of \s-1URI\s0), all of which are available from \s-1CPAN.\s0 .SH "DESCRIPTION" .IX Header "DESCRIPTION" A Net::Duo::Admin::Token object is a Perl representation of a Duo token as returned by the Duo Admin \s-1API,\s0 usually via the \fBtokens()\fR method or nested in a user returned by the \fBusers()\fR method. It contains various information about a token. .SH "CLASS METHODS" .IX Header "CLASS METHODS" .IP "create(\s-1DUO, DATA\s0)" 4 .IX Item "create(DUO, DATA)" Creates a new token in Duo and returns the resulting token as a new Net::Duo::Admin::Token object. \s-1DUO\s0 is the Net::Duo object that should be used to perform the creation. \s-1DATA\s0 is a reference to a hash with the following keys: .RS 4 .IP "aes_key" 4 .IX Item "aes_key" The YubiKey \s-1AES\s0 key. This parameter is required for YubiKey hardware tokens. .IP "counter" 4 .IX Item "counter" Initial value for the \s-1HOTP\s0 counter. The default is \f(CW0\fR. This parameter is only valid for \s-1HOTP\-6\s0 and \s-1HOTP\-8\s0 hardware tokens. .IP "private_id" 4 .IX Item "private_id" The YubiKey private \s-1ID.\s0 This parameter is required for YubiKey hardware tokens. .IP "secret" 4 .IX Item "secret" The \s-1HOTP\s0 secret. This parameter is required for \s-1HOTP\-6\s0 and \s-1HOTP\-8\s0 hardware tokens. .IP "serial" 4 .IX Item "serial" The serial number of the token. Required. .IP "type" 4 .IX Item "type" The type of hardware token. For the list of valid values, see the Duo Admin \s-1API\s0 documentation. Required. .RE .RS 4 .Sp Note that several of these keys can only be set on token creation and cannot be retrieved afterwards. .RE .IP "new(\s-1DUO, DATA\s0)" 4 .IX Item "new(DUO, DATA)" Creates a new Net::Duo::Admin::Token object from a full data set. \s-1DUO\s0 is the Net::Duo object that should be used for any further actions on this object. \s-1DATA\s0 should be the data structure returned by the Duo \s-1REST API\s0 for a single user, after \s-1JSON\s0 decoding. .IP "new(\s-1DUO, ID\s0)" 4 .IX Item "new(DUO, ID)" Creates a new Net::Duo::Admin::Token by \s-1ID.\s0 \s-1DUO\s0 is the Net::Duo object that is used to retrieve the token from Duo and will be used for any subsequent operations. The \s-1ID\s0 should be the Duo identifier of the token. This constructor is distinguished from the previous constructor by checking whether \s-1ID\s0 is a reference. .SH "INSTANCE ACTION METHODS" .IX Header "INSTANCE ACTION METHODS" .IP "\fBdelete()\fR" 4 .IX Item "delete()" Delete this token from Duo. After successful completion of this call, the Net::Duo::Admin::Token object should be considered read-only, since no further changes to the object can be meaningfully sent to Duo. .IP "\fBjson()\fR" 4 .IX Item "json()" Convert the data stored in the object to \s-1JSON\s0 and return the results. The resulting \s-1JSON\s0 should match the \s-1JSON\s0 that one would get back from the Duo web service when retrieving the same object (plus any changes made locally to the object via set_*() methods). This is primarily intended for debugging dumps or for passing Duo objects to other systems via further \&\s-1JSON\s0 APIs. .SH "INSTANCE DATA METHODS" .IX Header "INSTANCE DATA METHODS" .IP "\fBserial()\fR" 4 .IX Item "serial()" The serial number of the hardware token, used to uniquely identify the hardware token when paired with \fBtype()\fR. .Sp .Vb 4 \& serial => \*(Aqsimple\*(Aq, \& token_id => \*(Aqsimple\*(Aq, \& type => \*(Aqsimple\*(Aq, \& users => \*(AqNet::Duo::Admin::User\*(Aq, .Ve .IP "\fBtoken_id()\fR" 4 .IX Item "token_id()" The unique \s-1ID\s0 of this token as generated by Duo on token creation. .IP "\fBtype()\fR" 4 .IX Item "type()" The type of token. For the list of valid values, see the Duo Admin \s-1API\s0 documentation. .IP "\fBusers()\fR" 4 .IX Item "users()" The users associated with this token as a list of Net::Duo::Admin::User objects. .SH "AUTHOR" .IX Header "AUTHOR" Russ Allbery .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright 2014 The Board of Trustees of the Leland Stanford Junior University .PP Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \*(L"Software\*(R"), 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: .PP The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. .PP \&\s-1THE SOFTWARE IS PROVIDED \*(L"AS IS\*(R", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.\s0 \s-1IN 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.\s0 .SH "SEE ALSO" .IX Header "SEE ALSO" Net::Duo::Admin .PP Duo Admin \s-1API\s0 for tokens .PP This module is part of the Net::Duo distribution. The current version of Net::Duo is available from \s-1CPAN,\s0 or directly from its web site at .