.\" Automatically generated by Pod::Man 4.10 (Pod::Simple 3.35)
.\"
.\" 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 "Net::OAuth2::AuthorizationServer::ClientCredentialsGrant 3pm"
.TH Net::OAuth2::AuthorizationServer::ClientCredentialsGrant 3pm "2019-02-24" "perl v5.28.1" "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::OAuth2::AuthorizationServer::ClientCredentialsGrant \- OAuth2 Client Credentials Grant
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 12
\&  my $Grant = Net::OAuth2::AuthorizationServer::ClientCredentialsGrant\->new(
\&    clients => {
\&      TrendyNewService => {
\&        client_secret  => \*(AqTopSecretClientSecret\*(Aq,
\&        # optional
\&        scopes        => {
\&          post_images   => 1,
\&          annoy_friends => 1,
\&        },
\&      },
\&    }
\&  );
\&
\&  # verify a client against known clients
\&  my ( $is_valid,$error,$scopes ) = $Grant\->verify_client(
\&    client_id     => $client_id,
\&        client_secret => $client_secret,
\&    scopes        => [ qw/ list of scopes / ], # optional
\&  );
\&
\&  # generate a token
\&  my $token = $Grant\->token(
\&    client_id       => $client_id,
\&    scopes          => [ qw/ list of scopes / ],
\&    user_id         => $user_id,      # optional
\&        jwt_claims_cb   => sub { ... },   # optional, see jwt_claims_cb in Manual
\&  );
\&
\&  # store access token
\&  $Grant\->store_access_token(
\&    client_id         => $client,
\&    access_token      => $access_token,
\&    scopes            => [ qw/ list of scopes / ],
\&  );
\&
\&  # verify an access token
\&  my ( $is_valid,$error ) = $Grant\->verify_access_token(
\&    access_token     => $access_token,
\&    scopes           => [ qw/ list of scopes / ],
\&  );
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This module implements the OAuth2 \*(L"Client Credentials Grant\*(R" flow as described
at <http://tools.ietf.org/html/rfc6749#section\-4.4>.
.SH "CONSTRUCTOR ARGUMENTS"
.IX Header "CONSTRUCTOR ARGUMENTS"
Along with those detailed at \*(L"\s-1CONSTRUCTOR ARGUMENTS\*(R"\s0 in Net::OAuth2::AuthorizationServer::Manual
the following are supported by this grant type:
.SH "CALLBACK FUNCTIONS"
.IX Header "CALLBACK FUNCTIONS"
The following callbacks are supported by this grant type:
.PP
.Vb 3
\&  verify_client_cb
\&  store_access_token_cb
\&  verify_access_token_cb
.Ve
.PP
Please see \*(L"\s-1CALLBACK FUNCTIONS\*(R"\s0 in Net::OAuth2::AuthorizationServer::Manual for
documentation on each callback function.
.SH "AUTHOR"
.IX Header "AUTHOR"
Lee Johnson \- \f(CW\*(C`leejo@cpan.org\*(C'\fR
.SH "LICENSE"
.IX Header "LICENSE"
This library is free software; you can redistribute it and/or modify it under
the same terms as Perl itself. If you would like to contribute documentation
or file a bug report then please raise an issue / pull request:
.PP
.Vb 1
\&    https://github.com/Humanstate/net\-oauth2\-authorizationserver
.Ve