Package com.okta.sdk.resource.api

Class ApplicationSsoFederatedClaimsApi

java.lang.Object

com.okta.sdk.resource.api.ApplicationSsoFederatedClaimsApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2026-03-13T17:36:05.533634+05:30[Asia/Kolkata]",
           comments="Generator version: 7.15.0")
public class ApplicationSsoFederatedClaimsApi
extends Object

Constructor Summary

Constructors

Constructor	Description
ApplicationSsoFederatedClaimsApi()
ApplicationSsoFederatedClaimsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
FederatedClaim	createFederatedClaim(String appId, FederatedClaimRequestBody federatedClaimRequestBody)	Create a federated claim Creates a claim that will be included in tokens produced by federation protocols (for example: OIDC `id_tokens` or SAML Assertions)
FederatedClaim	createFederatedClaim(String appId, FederatedClaimRequestBody federatedClaimRequestBody, Map<String,String> additionalHeaders)	Create a federated claim Creates a claim that will be included in tokens produced by federation protocols (for example: OIDC `id_tokens` or SAML Assertions)
void	deleteFederatedClaim(String appId, String claimId)	Delete a federated claim Deletes a federated claim by `claimId`
void	deleteFederatedClaim(String appId, String claimId, Map<String,String> additionalHeaders)	Delete a federated claim Deletes a federated claim by `claimId`
ApiClient	getApiClient()
FederatedClaimRequestBody	getFederatedClaim(String appId, String claimId)	Retrieve a federated claim Retrieves a federated claim by `claimId`
FederatedClaimRequestBody	getFederatedClaim(String appId, String claimId, Map<String,String> additionalHeaders)	Retrieve a federated claim Retrieves a federated claim by `claimId`
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
List<FederatedClaim>	listFederatedClaims(String appId)	List all configured federated claims Lists all federated claims for your app
List<FederatedClaim>	listFederatedClaims(String appId, Map<String,String> additionalHeaders)	List all configured federated claims Lists all federated claims for your app
Iterable<FederatedClaim>	listFederatedClaimsPaged(String appId)	List all configured federated claims (Paginated) Lists all federated claims for your app This method returns a lazy, paginated iterable that automatically handles pagination.
Iterable<FederatedClaim>	listFederatedClaimsPaged(String appId, Map<String,String> additionalHeaders)	List all configured federated claims (Paginated with additional headers) Lists all federated claims for your app This method returns a lazy, paginated iterable that automatically handles pagination.
FederatedClaim	replaceFederatedClaim(String appId, String claimId, FederatedClaim federatedClaim)	Replace a federated claim Replaces a claim that will be included in tokens produced by federation protocols (for example: OIDC `id_tokens` or SAML Assertions)
FederatedClaim	replaceFederatedClaim(String appId, String claimId, FederatedClaim federatedClaim, Map<String,String> additionalHeaders)	Replace a federated claim Replaces a claim that will be included in tokens produced by federation protocols (for example: OIDC `id_tokens` or SAML Assertions)
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

Constructor Details

ApplicationSsoFederatedClaimsApi

public ApplicationSsoFederatedClaimsApi()

ApplicationSsoFederatedClaimsApi

public ApplicationSsoFederatedClaimsApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createFederatedClaim

public FederatedClaim createFederatedClaim(String appId,
 FederatedClaimRequestBody federatedClaimRequestBody)
                                    throws ApiException

Create a federated claim Creates a claim that will be included in tokens produced by federation protocols (for example: OIDC `id_tokens` or SAML Assertions)

Parameters:

appId - Application ID (required)

federatedClaimRequestBody - (required)

Returns:

FederatedClaim

Throws:

ApiException - if fails to make API call

createFederatedClaim

public FederatedClaim createFederatedClaim(String appId,
 FederatedClaimRequestBody federatedClaimRequestBody,
 Map<String,String> additionalHeaders)
                                    throws ApiException

Create a federated claim Creates a claim that will be included in tokens produced by federation protocols (for example: OIDC `id_tokens` or SAML Assertions)

Parameters:

appId - Application ID (required)

federatedClaimRequestBody - (required)

additionalHeaders - additionalHeaders for this call

Returns:

FederatedClaim

Throws:

ApiException - if fails to make API call

deleteFederatedClaim

public void deleteFederatedClaim(String appId,
 String claimId)
                          throws ApiException

Delete a federated claim Deletes a federated claim by `claimId`

Parameters:

appId - Application ID (required)

claimId - The unique `id` of the federated claim (required)

Throws:

ApiException - if fails to make API call

deleteFederatedClaim

public void deleteFederatedClaim(String appId,
 String claimId,
 Map<String,String> additionalHeaders)
                          throws ApiException

Delete a federated claim Deletes a federated claim by `claimId`

Parameters:

appId - Application ID (required)

claimId - The unique `id` of the federated claim (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getFederatedClaim

public FederatedClaimRequestBody getFederatedClaim(String appId,
 String claimId)
                                            throws ApiException

Retrieve a federated claim Retrieves a federated claim by `claimId`

Parameters:

appId - Application ID (required)

claimId - The unique `id` of the federated claim (required)

Returns:

FederatedClaimRequestBody

Throws:

ApiException - if fails to make API call

getFederatedClaim

public FederatedClaimRequestBody getFederatedClaim(String appId,
 String claimId,
 Map<String,String> additionalHeaders)
                                            throws ApiException

Retrieve a federated claim Retrieves a federated claim by `claimId`

Parameters:

appId - Application ID (required)

claimId - The unique `id` of the federated claim (required)

additionalHeaders - additionalHeaders for this call

Returns:

FederatedClaimRequestBody

Throws:

ApiException - if fails to make API call

listFederatedClaims

public List<FederatedClaim> listFederatedClaims(String appId)
                                         throws ApiException

List all configured federated claims Lists all federated claims for your app

Parameters:

appId - Application ID (required)

Returns:

List<FederatedClaim>

Throws:

ApiException - if fails to make API call

listFederatedClaims

public List<FederatedClaim> listFederatedClaims(String appId,
 Map<String,String> additionalHeaders)
                                         throws ApiException

List all configured federated claims Lists all federated claims for your app

Parameters:

appId - Application ID (required)

additionalHeaders - additionalHeaders for this call

Returns:

List<FederatedClaim>

Throws:

ApiException - if fails to make API call

listFederatedClaimsPaged

public Iterable<FederatedClaim> listFederatedClaimsPaged(String appId)

List all configured federated claims (Paginated) Lists all federated claims for your app This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks. Use this method in a for-each loop to automatically fetch all pages without manual cursor management.

Parameters:

appId - Application ID (required)

Returns:

Iterable<FederatedClaim> lazy iterable over all pages

listFederatedClaimsPaged

public Iterable<FederatedClaim> listFederatedClaimsPaged(String appId,
 Map<String,String> additionalHeaders)

List all configured federated claims (Paginated with additional headers) Lists all federated claims for your app This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.

Parameters:

appId - Application ID (required)

additionalHeaders - additional headers for this call

Returns:

Iterable<FederatedClaim> lazy iterable over all pages

replaceFederatedClaim

public FederatedClaim replaceFederatedClaim(String appId,
 String claimId,
 FederatedClaim federatedClaim)
                                     throws ApiException

Replace a federated claim Replaces a claim that will be included in tokens produced by federation protocols (for example: OIDC `id_tokens` or SAML Assertions)

Parameters:

appId - Application ID (required)

claimId - The unique `id` of the federated claim (required)

federatedClaim - (optional)

Returns:

FederatedClaim

Throws:

ApiException - if fails to make API call

replaceFederatedClaim

public FederatedClaim replaceFederatedClaim(String appId,
 String claimId,
 FederatedClaim federatedClaim,
 Map<String,String> additionalHeaders)
                                     throws ApiException

Replace a federated claim Replaces a claim that will be included in tokens produced by federation protocols (for example: OIDC `id_tokens` or SAML Assertions)

Parameters:

appId - Application ID (required)

claimId - The unique `id` of the federated claim (required)

federatedClaim - (optional)

additionalHeaders - additionalHeaders for this call

Returns:

FederatedClaim

Throws:

ApiException - if fails to make API call

getObjectMapper

protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()