com.sap.cloud.security.token

Interface AccessToken

All Superinterfaces:

Serializable, Token

public interface AccessToken
extends Token

Represents an access token in the format of a JSON Web Token (not a short opaque token). In difference to a ID token the access token has no/less information about the user but has information about the authorities (scopes).

Method Summary

Modifier and Type	Method and Description
default String	getAttributeFromClaimAsString(String claimName, String attributeName) Returns the String value of a claim attribute.
default List<String>	getAttributeFromClaimAsStringList(String claimName, String attributeName) Returns the String list of a claim attribute.
GrantType	getGrantType() Returns the grant type of the jwt token.
Set<String>	getScopes() Returns the list of the claim "scope".
boolean	hasLocalScope(String scope) Check if a local scope is available in the authentication token.
boolean	hasScope(String scope) Checks if a scope is available in the access token.

Methods inherited from interface com.sap.cloud.security.token.Token

getAudiences, getClaimAsJsonObject, getClaimAsString, getClaimAsStringList, getClaims, getClientId, getExpiration, getHeaderParameterAsString, getHeaders, getNotBefore, getPrincipal, getService, getTokenValue, getZoneId, hasClaim, hasHeaderParameter, isExpired

Method Detail

getScopes

Set<String> getScopes()

Returns the list of the claim "scope".

Returns:

the list of the claim scope or empty list.

hasScope

boolean hasScope(String scope)

Checks if a scope is available in the access token.

Parameters:

scope - name of the scope

Returns:

true if scope is available

hasLocalScope

boolean hasLocalScope(@Nonnull
                      String scope)

Check if a local scope is available in the authentication token. The exact definition of a local scope depends on the specific token implementation.

Parameters:

scope - name of local scope

Returns:

true if local scope is available

getGrantType

@Nullable
GrantType getGrantType()

Returns the grant type of the jwt token.

Returns:

the grant type

getAttributeFromClaimAsString

@Nullable
default String getAttributeFromClaimAsString(String claimName,
                                                       String attributeName)

Returns the String value of a claim attribute.
"claimName": { "attributeName": "attributeValueAsString" },

Example:
import static com.sap.cloud.security.token.TokenClaims.XSUAA.*; token.getAttributeFromClaimAsString(EXTERNAL_ATTRIBUTE, EXTERNAL_ATTRIBUTE_SUBACCOUNTID);

Returns:

the String value of a claim attribute or null if claim or its attribute does not exist.

getAttributeFromClaimAsStringList

@Nullable
default List<String> getAttributeFromClaimAsStringList(String claimName,
                                                                 String attributeName)

Returns the String list of a claim attribute.
"claimName": { "attributeName": ["attributeValueAsString", "attributeValue2AsString"] },

Example:
import static com.sap.cloud.security.token.TokenClaims.XSUAA.*; token.getAttributeFromClaimAsString(XS_USER_ATTRIBUTES, "custom_role");

Returns:

the String value of a claim attribute or null if claim or its attribute does not exist.