com.sap.cloud.security.xsuaa.client

Interface OAuth2TokenKeyService

All Known Implementing Classes:

DefaultOAuth2TokenKeyService, SpringOAuth2TokenKeyService

public interface OAuth2TokenKeyService

Method Summary

Modifier and Type	Method and Description
default String	retrieveTokenKeys(URI tokenKeysEndpointUri) Deprecated. gets removed in favor of retrieveTokenKeys(URI, String) with next major version 3.0.0
String	retrieveTokenKeys(URI tokenKeysEndpointUri, String zoneId) Requests token web key set from OAuth Server.

Method Detail

retrieveTokenKeys

@Deprecated
default String retrieveTokenKeys(@Nonnull
                                             URI tokenKeysEndpointUri)
                                      throws OAuth2ServiceException

Deprecated. gets removed in favor of retrieveTokenKeys(URI, String) with next major version 3.0.0

Same as retrieveTokenKeys(URI, String) except that zoneId is set to null.

Throws:

OAuth2ServiceException

retrieveTokenKeys

String retrieveTokenKeys(@Nonnull
                         URI tokenKeysEndpointUri,
                         @Nullable
                         String zoneId)
                  throws OAuth2ServiceException

Requests token web key set from OAuth Server.

Parameters:

tokenKeysEndpointUri - the token endpoint URI (jku).

zoneId - the zone uuid of the tenant. Obligatory parameter in context of multi-tenant IAS applications to make sure that the zone uuid belongs to the IAS tenant.

Returns:

An endpoint which returns the list of JSON Web Token (JWT) keys as JSON string.

Throws:

OAuth2ServiceException - in case of an error during the http request.