.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43)
.\"
.\" 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 "LWP::Authen::OAuth2::ServiceProvider::Line 3pm"
.TH LWP::Authen::OAuth2::ServiceProvider::Line 3pm "2023-02-04" "perl v5.36.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"
LWP::Authen::OAuth2::ServiceProvider::Line \- Access Line OAuth2 API v2
.SH "VERSION"
.IX Header "VERSION"
version 0.20
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 6
\&    my $oauth2 = LWP::Authen::OAuth2\->new(
\&        service_provider => \*(AqLine\*(Aq,
\&        redirect_uri     => \*(Aqhttp://example.com/\*(Aq,
\&        client_id        => \*(Aqline_client_id\*(Aq      # Retrieved from https://developers.line.me/
\&        client_secret    => \*(Aqline_client_secret\*(Aq  # Retrieved from https://developers.line.me/
\&    );
\&
\&    my $url = $oauth2\->authorization_url(state => $state);
\&
\&    # ... Send user to authorization URL and get authorization $code ...
\&
\&    $oauth2\->request_tokens(code => $code);
\&
\&    # Simple requests
\&
\&    # User Info
\&    my $profile       = $oauth2\->make_api_call(\*(Aqprofile\*(Aq);
\&    my $userId        = $profile\->{userId};
\&    my $displayName   = $profile\->{displayName};
\&    my $pictureUrl    = $profile\->{pictureUrl};
\&    my $statusMessage = $profile\->{statusMessage};
\&
\&    # Refresh
\&    $oauth2\->refresh_access_token();
\&
\&    # More complex requests...
\&
\&    # Verify
\&    # Manually send the request using the internal user agent \- see explanation in "Line API Documentation" below.
\&    my $access_token_str = $oauth2\->access_token\->access_token;
\&    my $res = $oauth2\->user_agent\->post($oauth2\->api_url_base.\*(Aqoauth/verify\*(Aq => { access_token => $access_token_str });
\&    my $content = eval { decode_json($res\->content) };
\&    my $scope      = $content\->{scope};
\&    my $client_id  = $content\->{client_id};
\&    my $expires_in = $content\->{expires_in};
\&
\&    # Revoke
\&    # Look up the internal refresh token \- see explanation in "Line API Documentation" below.
\&    my $refresh_token_str = $oauth2\->access_token\->refresh_token;
\&    $oauth2\->post($oauth2\->api_url_base.\*(Aqoauth/revoke\*(Aq => { refresh_token => $refresh_token_str });
.Ve
.SH "REGISTERING"
.IX Header "REGISTERING"
Individual users must have an account created with the Line application <https://line.me/download>.  In order to log in with OAuth2, users must register their email address. Device-specific instructions can be found on the Line support site <https://help.line.me/>.
.PP
\&\s-1API\s0 clients can follow the Line Login <https://developers.line.me/line-login/overview> documentation to set up the OAuth2 credentials.
.SH "Line API Documentation"
.IX Header "Line API Documentation"
See the Line Social \s-1REST API\s0 Reference <https://devdocs.line.me/en/#how-to-use-the-apis>.
.PP
As of writing, there are two simple \s-1API\s0 calls: \f(CW\*(C`profile\*(C'\fR and \f(CW\*(C`refresh\*(C'\fR.
.PP
There are also \f(CW\*(C`verify\*(C'\fR and \f(CW\*(C`revoke\*(C'\fR endpoints, which require a bit more work.
.ie n .IP """verify""" 4
.el .IP "\f(CWverify\fR" 4
.IX Item "verify"
\&\f(CW\*(C`verify\*(C'\fR is designed for verifying pre-existing access tokens. Instead of using the \f(CW\*(C`Authorization\*(C'\fR header, this endpoint expects the access token to be form-urlencoded in the request body. Because of this, it's necessary to get access to the internal access token string to send in the request body. The LWP::Authen::OAuth2::ServiceProvider::Line::AccessToken token class used by this service provider provides the \f(CW\*(C`access_token\*(C'\fR accessor for this purpose.
.Sp
The server seems to ignore the \f(CW\*(C`Authorization\*(C'\fR header for this request, so including it is probably not a problem. If you want to avoid sending the access token in the header, it's necessary to manually construct the request and decode the response.
.Sp
See \*(L"\s-1SYNOPSIS\*(R"\s0 for usage examples.
.ie n .IP """revoke""" 4
.el .IP "\f(CWrevoke\fR" 4
.IX Item "revoke"
\&\f(CW\*(C`revoke\*(C'\fR requires the refresh token to be form-urlencoded in the request body. Because of this, it's necessary to get access to the internal refresh token string to send in the request body. The LWP::Authen::OAuth2::ServiceProvider::Line::AccessToken token class used by this service provider provides the \f(CW\*(C`refresh_token\*(C'\fR accessor for this purpose. See \*(L"\s-1SYNOPSYS\*(R"\s0 for usage examples.
.SH "Refresh timing"
.IX Header "Refresh timing"
Line access tokens can be refreshed at any time up until 10 days after the access token expires. The LWP::Authen::OAuth2::ServiceProvider::Line::AccessToken token class used by this service provider extends the \f(CW\*(C`should_refresh\*(C'\fR method for this purpose, causing \f(CW\*(C`$oauth2\->should_refresh()\*(C'\fR to return false if this 10\-day period has lapsed.
.SH "AUTHOR"
.IX Header "AUTHOR"
Adam Millerchip, \f(CW\*(C`<adam at millerchip.net>\*(C'\fR
.SH "AUTHORS"
.IX Header "AUTHORS"
.IP "\(bu" 4
Ben Tilly, <btilly at gmail.com>
.IP "\(bu" 4
Thomas Klausner <domm@plix.at>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
This software is copyright (c) 2013 \- 2022 by Ben Tilly, Rent.com, Thomas Klausner.
.PP
This is free software; you can redistribute it and/or modify it under
the same terms as the Perl 5 programming language system itself.