View on
MetaCPAN
search.cpan.org is shutting down
For details read Perl NOC. After June 25th this page will redirect to MetaCPAN.org
Lee Johnson > Net-OAuth2-AuthorizationServer-0.18 > Net::OAuth2::AuthorizationServer::ClientCredentialsGrant

Download:
Net-OAuth2-AuthorizationServer-0.18.tar.gz

Dependencies

Annotate this POD

Website

View/Report Bugs
Source  

NAME ^

Net::OAuth2::AuthorizationServer::ClientCredentialsGrant - OAuth2 Client Credentials Grant

SYNOPSIS ^

  my $Grant = Net::OAuth2::AuthorizationServer::ClientCredentialsGrant->new(
    clients => {
      TrendyNewService => {
        client_secret  => 'TopSecretClientSecret',
        # 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 / ],
  );

DESCRIPTION ^

This module implements the OAuth2 "Client Credentials Grant" flow as described at http://tools.ietf.org/html/rfc6749#section-4.4.

CONSTRUCTOR ARGUMENTS ^

Along with those detailed at "CONSTRUCTOR ARGUMENTS" in Net::OAuth2::AuthorizationServer::Manual the following are supported by this grant type:

CALLBACK FUNCTIONS ^

The following callbacks are supported by this grant type:

  verify_client_cb
  store_access_token_cb
  verify_access_token_cb

Please see "CALLBACK FUNCTIONS" in Net::OAuth2::AuthorizationServer::Manual for documentation on each callback function.

AUTHOR ^

Lee Johnson - leejo@cpan.org

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:

    https://github.com/Humanstate/net-oauth2-authorizationserver
syntax highlighting: