Package org.springframework.security.oauth2.client.endpoint

Class OAuth2PasswordGrantRequest

java.lang.Object

org.springframework.security.oauth2.client.endpoint.AbstractOAuth2AuthorizationGrantRequest

org.springframework.security.oauth2.client.endpoint.OAuth2PasswordGrantRequest

@Deprecated(since="5.8",
            forRemoval=true)
public class OAuth2PasswordGrantRequest
extends AbstractOAuth2AuthorizationGrantRequest

Deprecated, for removal: This API element is subject to removal in a future version.

The OAuth 2.0 Security Best Current Practice disallows the use of the Resource Owner Password Credentials grant. See reference OAuth 2.0 Security Best Current Practice.

An OAuth 2.0 Resource Owner Password Credentials Grant request that holds the resource owner's credentials.

Since:

5.2

See Also:

• AbstractOAuth2AuthorizationGrantRequest
• Section 1.3.3 Resource Owner Password Credentials

Constructor Summary

Constructors

Constructor	Description
OAuth2PasswordGrantRequest(ClientRegistration clientRegistration, String username, String password)	Deprecated, for removal: This API element is subject to removal in a future version. Constructs an OAuth2PasswordGrantRequest using the provided parameters.

Method Summary

Modifier and Type	Method	Description
String	getPassword()	Deprecated, for removal: This API element is subject to removal in a future version. Returns the resource owner's password.
String	getUsername()	Deprecated, for removal: This API element is subject to removal in a future version. Returns the resource owner's username.

Methods inherited from class org.springframework.security.oauth2.client.endpoint.AbstractOAuth2AuthorizationGrantRequest

getClientRegistration, getGrantType

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

OAuth2PasswordGrantRequest

public OAuth2PasswordGrantRequest(ClientRegistration clientRegistration,
 String username,
 String password)

Deprecated, for removal: This API element is subject to removal in a future version.

Constructs an OAuth2PasswordGrantRequest using the provided parameters.

Parameters:

clientRegistration - the client registration

username - the resource owner's username

password - the resource owner's password

Method Details

getUsername

public String getUsername()

Deprecated, for removal: This API element is subject to removal in a future version.

Returns the resource owner's username.

Returns:

the resource owner's username

getPassword

public String getPassword()

Deprecated, for removal: This API element is subject to removal in a future version.

Returns the resource owner's password.

Returns:

the resource owner's password