ClientCredentialsGrant (security-oauth2 3.7.1 API)

java.lang.Object
- io.micronaut.security.oauth2.grants.AbstractClientSecureGrant
- - io.micronaut.security.oauth2.grants.ClientCredentialsGrant

All Implemented Interfaces:: AsMap, SecureGrant

@Introspected
public class ClientCredentialsGrant
extends AbstractClientSecureGrant
implements SecureGrant, AsMap

Client Credentials Grant.

Since:: 1.2.0
See Also:: Access Token Request

Field Summary

Fields
Modifier and Type Field Description

static java.lang.String KEY_SCOPES
- Fields inherited from class io.micronaut.security.oauth2.grants.AbstractClientSecureGrant
  clientId, clientSecret
- Fields inherited from interface io.micronaut.security.oauth2.grants.SecureGrant
  KEY_CLIENT_ID, KEY_CLIENT_SECRET

Constructor Summary

Constructors
Constructor Description

ClientCredentialsGrant()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.lang.String`	`getGrantType()`
`java.lang.String`	`getScope()`
`void`	`setGrantType(java.lang.String grantType)`
`void`	`setScope(java.lang.String scope)`
`java.util.Map<java.lang.String,java.lang.String>`	`toMap()`

Methods inherited from class io.micronaut.security.oauth2.grants.AbstractClientSecureGrant
getClientId, getClientSecret, setClientId, setClientSecret

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.micronaut.security.oauth2.grants.SecureGrant
setClientId, setClientSecret

- Field Detail
  - KEY_SCOPES
```
public static final java.lang.String KEY_SCOPES
```
    See Also:
    
    Constant Field Values
- Constructor Detail
  - ClientCredentialsGrant
```
public ClientCredentialsGrant()
```
- Method Detail
  - getGrantType
```
@NonNull
public java.lang.String getGrantType()
```
    Specified by:
    
    getGrantType in class AbstractClientSecureGrant
    
    Returns:
    
    Grant Type.
  - setGrantType
```
public void setGrantType(@NonNull
                         java.lang.String grantType)
```
    Specified by:
    
    setGrantType in class AbstractClientSecureGrant
    
    Parameters:
    
    grantType - Grant type
  - getScope
```
@Nullable
public java.lang.String getScope()
```
    Returns:
    
    Requested scope values for the access token.
  - setScope
```
public void setScope(@Nullable
                     java.lang.String scope)
```
    Parameters:
    
    scope - Requested scope values for the access token.
  - toMap
```
@NonNull
public java.util.Map<java.lang.String,java.lang.String> toMap()
```
    Specified by:
    
    toMap in interface AsMap
    
    Overrides:
    
    toMap in class AbstractClientSecureGrant
    
    Returns:
    
    this object as a Map