---
name: "Net::OAuth2::Profile::Password"
section: "3pm"
platform: "linux"
package: "libnet-oauth2-perl"
version: "0.67-1"
release: "Debian 13 (Trixie)"
platforms: ["linux"]
url: "https://new.carta.tech/Net::OAuth2::Profile::Password"
---

# Net::OAuth2::Profile::Password(3pm)

OAuth2 for web-server use

## NAME

Net::OAuth2::Profile::Password - OAuth2 for web-server use

## INHERITANCE

```
 Net::OAuth2::Profile::Password
   is a Net::OAuth2::Profile
```

## SYNOPSIS

```
  my $auth = Net::OAuth2::Profile::Password->new(...);
  $auth->get_access_token(...);
```

## DESCRIPTION

Extends "DESCRIPTION" in Net::OAuth2::Profile.

## METHODS

Extends "METHODS" in Net::OAuth2::Profile.

### Constructors

Extends "Constructors" in Net::OAuth2::Profile.

- Net::OAuth2::Profile::Password-\>**new**(%options)

  ```
   -Option           --Defined in          --Default
    client_id          Net::OAuth2::Profile  <required>
    client_secret      Net::OAuth2::Profile  <required>
    grant_type         Net::OAuth2::Profile  'password'
    hd                 Net::OAuth2::Profile  undef
    scope              Net::OAuth2::Profile  undef
    secrets_in_params  Net::OAuth2::Profile  <true>
    site               Net::OAuth2::Profile  undef
    state              Net::OAuth2::Profile  undef
    token_scheme       Net::OAuth2::Profile  'auth-header:Bearer'
    user_agent         Net::OAuth2::Profile  <created internally>
  ```

  - client\_id =\> STRING

    - client\_secret =\> STRING

    - grant\_type =\> STRING

    - hd =\> STRING

    - scope =\> STRING

    - secrets\_in\_params =\> BOOLEAN

    - site =\> URI

    - state =\> STRING

    - token\_scheme =\> SCHEME

    - user\_agent =\> LWP::UserAgent object

    ### Accessors

Extends "Accessors" in Net::OAuth2::Profile.

- $obj-\>**bearer\_token\_scheme**()

  Inherited, see "Accessors" in Net::OAuth2::Profile

- $obj-\>**grant\_type**()

  Inherited, see "Accessors" in Net::OAuth2::Profile

- $obj-\>**hd**()

  Inherited, see "Accessors" in Net::OAuth2::Profile

- $obj-\>**id**()

  Inherited, see "Accessors" in Net::OAuth2::Profile

- $obj-\>**scope**()

  Inherited, see "Accessors" in Net::OAuth2::Profile

- $obj-\>**secret**()

  Inherited, see "Accessors" in Net::OAuth2::Profile

- $obj-\>**site**()

  Inherited, see "Accessors" in Net::OAuth2::Profile

- $obj-\>**state**()

  Inherited, see "Accessors" in Net::OAuth2::Profile

- $obj-\>**user\_agent**()

  Inherited, see "Accessors" in Net::OAuth2::Profile

### Actions

Extends "Actions" in Net::OAuth2::Profile.

### Helpers

Extends "Helpers" in Net::OAuth2::Profile.

- $obj-\>**add\_token**($request, $token, $scheme)

  Inherited, see "Helpers" in Net::OAuth2::Profile

- $obj-\>**build\_request**($method, $uri, $params)

  Inherited, see "Helpers" in Net::OAuth2::Profile

- $obj-\>**params\_from\_response**($response, $reason)

  Inherited, see "Helpers" in Net::OAuth2::Profile

- $obj-\>**site\_url**( \<$uri\|$path\>, $params )

  Inherited, see "Helpers" in Net::OAuth2::Profile

### Action

- $obj-\>**get\_access\_token**(%options)

  ```
   -Option  --Default
    password  <required>
    username  <required>
  ```

  - password =\> PASSWORD

    - username =\> USER

    ## COPYRIGHTS

Copyrights 2013-2019 on the perl code and the related documentation\
  by \[Mark Overmeer \<markov@cpan.org\>\] for SURFnet bv, The Netherlands.  For other contributors see "Changes".

Copyrights 2011-2012 by Keith Grennan.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself. See *http://dev.perl.org/licenses/*