Package org.apache.polaris.service.catalog.api

Class IcebergRestOAuth2Api

java.lang.Object

org.apache.polaris.service.catalog.api.IcebergRestOAuth2Api

@Path("/api/catalog/v1/oauth/tokens")
@Generated(value="org.openapitools.codegen.languages.JavaResteasyServerCodegen",
           date="2025-12-29T15:11:16.406523497Z[UTC]",
           comments="Generator version: 7.12.0")
public class IcebergRestOAuth2Api
extends Object

The OAuth2Api API interface This file is automatically generated by the OpenAPI Code Generator based on configuration in the build.gradle file.

Constructor Summary

Constructors

Constructor	Description
IcebergRestOAuth2Api(IcebergRestOAuth2ApiService service)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	getToken(String authorization, String grantType, String scope, String clientId, String clientSecret, TokenType requestedTokenType, String subjectToken, TokenType subjectTokenType, String actorToken, TokenType actorTokenType, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)	The `oauth/tokens` endpoint is **DEPRECATED for REMOVAL**.

Methods inherited from class java.lang.Object

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

Constructor Details

IcebergRestOAuth2Api

@Inject
public IcebergRestOAuth2Api(IcebergRestOAuth2ApiService service)

Method Details

getToken

@POST
@Consumes("application/x-www-form-urlencoded")
@Produces("application/json")
@Timeout
public jakarta.ws.rs.core.Response getToken(@HeaderParam("Authorization")
 String authorization,
 @FormParam("grant_type")
 String grantType,
 @FormParam("scope")
 String scope,
 @FormParam("client_id")
 String clientId,
 @FormParam("client_secret")
 String clientSecret,
 @FormParam("requested_token_type")
 TokenType requestedTokenType,
 @FormParam("subject_token")
 String subjectToken,
 @FormParam("subject_token_type")
 TokenType subjectTokenType,
 @FormParam("actor_token")
 String actorToken,
 @FormParam("actor_token_type")
 TokenType actorTokenType,
 @Context
 org.apache.polaris.core.context.RealmContext realmContext,
 @Context
 jakarta.ws.rs.core.SecurityContext securityContext)

The `oauth/tokens` endpoint is **DEPRECATED for REMOVAL**. It is _not_ recommended to implement this endpoint, unless you are fully aware of the potential security implications. All clients are encouraged to explicitly set the configuration property `oauth2-server-uri` to the correct OAuth endpoint. Deprecated since Iceberg (Java) 1.6.0. The endpoint and related types will be removed from this spec in Iceberg (Java) 2.0. See [Security improvements in the Iceberg REST specification](https://github.com/apache/iceberg/issues/10537) Exchange credentials for a token using the OAuth2 client credentials flow or token exchange. This endpoint is used for three purposes - 1. To exchange client credentials (client ID and secret) for an access token This uses the client credentials flow. 2. To exchange a client token and an identity token for a more specific access token This uses the token exchange flow. 3. To exchange an access token for one with the same claims and a refreshed expiration period This uses the token exchange flow. For example, a catalog client may be configured with client credentials from the OAuth2 Authorization flow. This client would exchange its client ID and secret for an access token using the client credentials request with this endpoint (1). Subsequent requests would then use that access token. Some clients may also handle sessions that have additional user context. These clients would use the token exchange flow to exchange a user token (the \"subject\" token) from the session for a more specific access token for that user, using the catalog's access token as the \"actor\" token (2). The user ID token is the \"subject\" token and can be any token type allowed by the OAuth2 token exchange flow, including a unsecured JWT token with a sub claim. This request should use the catalog's bearer token in the \"Authorization\" header. Clients may also use the token exchange flow to refresh a token that is about to expire by sending a token exchange request (3). The request's \"subject\" token should be the expiring token. This request should use the subject token in the \"Authorization\" header. Response type: OAuthTokenResponse.

Parameters:

authorization -

grantType -

scope -

clientId - Client ID This can be sent in the request body, but OAuth2 recommends sending it in a Basic Authorization header.

clientSecret - Client secret This can be sent in the request body, but OAuth2 recommends sending it in a Basic Authorization header.

requestedTokenType -

subjectToken - Subject token for token exchange request

subjectTokenType -

actorToken - Actor token for token exchange request

actorTokenType -

Returns:

200 - OAuth2 token response for client credentials or token exchange