ClientCredentialsGrant (Jans authentication server 1.1.2 API)

java.lang.Object
- io.jans.as.server.model.common.AbstractAuthorizationGrant
- - io.jans.as.server.model.common.AuthorizationGrant
  - - io.jans.as.server.model.common.ClientCredentialsGrant

All Implemented Interfaces:

IAuthorizationGrant
```
public class ClientCredentialsGrant
extends AuthorizationGrant
```
The client credentials (or other forms of client authentication) can be used as an authorization grant when the authorization scope is limited to the protected resources under the control of the client, or to protected resources previously arranged with the authorization server. Client credentials are used as an authorization grant typically when the client is acting on its own behalf (the client is also the resource owner), or is requesting access to protected resources based on an authorization previously arranged with the authorization server.

Version:

September 30, 2021

Author:

Javier Rojas Blum, Yuriy Movchan

Field Summary
- Fields inherited from class io.jans.as.server.model.common.AbstractAuthorizationGrant
  accessTokens, appConfiguration, refreshTokens, scopeChecker, txTokens

Constructor Summary

Constructors
Constructor	Description
`ClientCredentialsGrant()`
`ClientCredentialsGrant(io.jans.as.common.model.common.User user, io.jans.as.common.model.registration.Client client)`	Construct a client credentials grant.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`RefreshToken`	`createRefreshToken(ExecutionContext executionContext)`	The authorization server MUST NOT issue a refresh token.
`io.jans.as.model.common.GrantType`	`getGrantType()`
`void`	`init(io.jans.as.common.model.common.User user, io.jans.as.common.model.registration.Client client)`

Methods inherited from class io.jans.as.server.model.common.AuthorizationGrant
asToken, asToken, asToken, asToken, asToken, asTokenEntity, checkExpiredTokens, checkScopesPolicy, createAccessToken, createAccessTokenAsJwt, createIdToken, createRefreshToken, createRefreshToken, getScopesAsString, getSub, init, isCachedWithNoPersistence, isImplicitFlow, persist, persist, revokeAllTokens, save, setIsCachedWithNoPersistence

Methods inherited from class io.jans.as.server.model.common.AbstractAuthorizationGrant
getAccessToken, getAccessTokenLifetimeInSeconds, getAccessTokens, getAccessTokensCodes, getAcrValues, getAuthenticationTime, getAuthorizationCode, getAuthorizationGrantType, getAuthzDetails, getAuthzDetailsAsString, getClaims, getClient, getClientDn, getClientId, getCodeChallenge, getCodeChallengeMethod, getDpopJkt, getGrantId, getIdToken, getJwtAuthorizationRequest, getLongLivedAccessToken, getNonce, getReferenceId, getRefreshToken, getRefreshTokens, getRefreshTokensCodes, getScopes, getSessionDn, getTokenBindingHash, getTokenEntity, getTxToken, getTxTokens, getUser, getUserDn, getUserId, getX5ts256, setAccessTokens, setAcrValues, setAuthenticationTime, setAuthorizationCode, setAuthzDetails, setClaims, setCodeChallenge, setCodeChallengeMethod, setDpopJkt, setGrantId, setIdToken, setJwtAuthorizationRequest, setLongLivedAccessToken, setNonce, setReferenceId, setRefreshTokens, setScopes, setSessionDn, setTokenBindingHash, setTokenEntity, setTxTokens, setX5ts256, toString

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

- Constructor Detail
  - ClientCredentialsGrant
```
public ClientCredentialsGrant()
```
  - ClientCredentialsGrant
```
public ClientCredentialsGrant(io.jans.as.common.model.common.User user,
                              io.jans.as.common.model.registration.Client client)
```
    Construct a client credentials grant.
    
    Parameters:
    
    user - The resource owner.
    
    client - An application making protected resource requests on behalf of the resource owner and with its authorization.
- Method Detail
  - getGrantType
```
public io.jans.as.model.common.GrantType getGrantType()
```
  - init
```
public void init(io.jans.as.common.model.common.User user,
                 io.jans.as.common.model.registration.Client client)
```
  - createRefreshToken
```
public RefreshToken createRefreshToken(ExecutionContext executionContext)
```
    The authorization server MUST NOT issue a refresh token.
    
    Specified by:
    
    createRefreshToken in interface IAuthorizationGrant
    
    Overrides:
    
    createRefreshToken in class AuthorizationGrant