Package com.okta.sdk.resource.api

Class IdentitySourceApi

java.lang.Object
com.okta.sdk.resource.api.IdentitySourceApi
@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 IdentitySourceApi extends Object

  • Constructor Details

    • IdentitySourceApi

      public IdentitySourceApi()

    • IdentitySourceApi

      public IdentitySourceApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • createIdentitySourceSession

      public IdentitySourceSession createIdentitySourceSession(String identitySourceId) throws ApiException
      Create an identity source session Creates an identity source session for the given identity source instance
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      Returns:
      IdentitySourceSession
      Throws:
      ApiException - if fails to make API call

    • createIdentitySourceSession

      public IdentitySourceSession createIdentitySourceSession(String identitySourceId, Map<String,String> additionalHeaders) throws ApiException
      Create an identity source session Creates an identity source session for the given identity source instance
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      IdentitySourceSession
      Throws:
      ApiException - if fails to make API call

    • createIdentitySourceUser

      public void createIdentitySourceUser(String identitySourceId, UserRequestSchema userRequestSchema) throws ApiException
      Create an identity source user Creates a user in an identity source for the given identity source instance
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      userRequestSchema - (optional)
      Throws:
      ApiException - if fails to make API call

    • createIdentitySourceUser

      public void createIdentitySourceUser(String identitySourceId, UserRequestSchema userRequestSchema, Map<String,String> additionalHeaders) throws ApiException
      Create an identity source user Creates a user in an identity source for the given identity source instance
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      userRequestSchema - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • deleteIdentitySourceSession

      public void deleteIdentitySourceSession(String identitySourceId, String sessionId) throws ApiException
      Delete an identity source session Deletes an identity source session for a given identity source ID and session Id
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      sessionId - The ID of the identity source session (required)
      Throws:
      ApiException - if fails to make API call

    • deleteIdentitySourceSession

      public void deleteIdentitySourceSession(String identitySourceId, String sessionId, Map<String,String> additionalHeaders) throws ApiException
      Delete an identity source session Deletes an identity source session for a given identity source ID and session Id
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      sessionId - The ID of the identity source session (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • deleteIdentitySourceUser

      public void deleteIdentitySourceUser(String identitySourceId, String externalId) throws ApiException
      Delete an identity source user Deletes a user in an identity source for the given identity source instance and external ID
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      externalId - The external ID of the user (required)
      Throws:
      ApiException - if fails to make API call

    • deleteIdentitySourceUser

      public void deleteIdentitySourceUser(String identitySourceId, String externalId, Map<String,String> additionalHeaders) throws ApiException
      Delete an identity source user Deletes a user in an identity source for the given identity source instance and external ID
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      externalId - The external ID of the user (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getIdentitySourceSession

      public IdentitySourceSession getIdentitySourceSession(String identitySourceId, String sessionId) throws ApiException
      Retrieve an identity source session Retrieves an identity source session for a given identity source ID and session ID
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      sessionId - The ID of the identity source session (required)
      Returns:
      IdentitySourceSession
      Throws:
      ApiException - if fails to make API call

    • getIdentitySourceSession

      public IdentitySourceSession getIdentitySourceSession(String identitySourceId, String sessionId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve an identity source session Retrieves an identity source session for a given identity source ID and session ID
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      sessionId - The ID of the identity source session (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      IdentitySourceSession
      Throws:
      ApiException - if fails to make API call

    • getIdentitySourceUser

      public UserResponseSchema getIdentitySourceUser(String identitySourceId, String externalId) throws ApiException
      Retrieve an identity source user Retrieves a user by external ID in an identity source for the given identity source instance
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      externalId - The external ID of the user (required)
      Returns:
      UserResponseSchema
      Throws:
      ApiException - if fails to make API call

    • getIdentitySourceUser

      public UserResponseSchema getIdentitySourceUser(String identitySourceId, String externalId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve an identity source user Retrieves a user by external ID in an identity source for the given identity source instance
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      externalId - The external ID of the user (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      UserResponseSchema
      Throws:
      ApiException - if fails to make API call

    • listIdentitySourceSessions

      public List<IdentitySourceSession> listIdentitySourceSessions(String identitySourceId) throws ApiException
      List all identity source sessions Lists all identity source sessions for the given identity source instance
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      Returns:
      List<IdentitySourceSession>
      Throws:
      ApiException - if fails to make API call

    • listIdentitySourceSessions

      public List<IdentitySourceSession> listIdentitySourceSessions(String identitySourceId, Map<String,String> additionalHeaders) throws ApiException
      List all identity source sessions Lists all identity source sessions for the given identity source instance
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<IdentitySourceSession>
      Throws:
      ApiException - if fails to make API call

    • listIdentitySourceSessionsPaged

      public Iterable<IdentitySourceSession> listIdentitySourceSessionsPaged(String identitySourceId)
      List all identity source sessions (Paginated) Lists all identity source sessions for the given identity source instance 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:
      identitySourceId - The ID of the identity source for which the session is created (required)
      Returns:
      Iterable<IdentitySourceSession> lazy iterable over all pages

    • listIdentitySourceSessionsPaged

      public Iterable<IdentitySourceSession> listIdentitySourceSessionsPaged(String identitySourceId, Map<String,String> additionalHeaders)
      List all identity source sessions (Paginated with additional headers) Lists all identity source sessions for the given identity source instance This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      additionalHeaders - additional headers for this call
      Returns:
      Iterable<IdentitySourceSession> lazy iterable over all pages

    • replaceExistingIdentitySourceUser

      public UserResponseSchema replaceExistingIdentitySourceUser(String identitySourceId, String externalId, UserRequestSchema userRequestSchema) throws ApiException
      Replace an existing identity source user Replaces an existing user for the given identity source instance and external ID
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      externalId - The external ID of the user (required)
      userRequestSchema - (optional)
      Returns:
      UserResponseSchema
      Throws:
      ApiException - if fails to make API call

    • replaceExistingIdentitySourceUser

      public UserResponseSchema replaceExistingIdentitySourceUser(String identitySourceId, String externalId, UserRequestSchema userRequestSchema, Map<String,String> additionalHeaders) throws ApiException
      Replace an existing identity source user Replaces an existing user for the given identity source instance and external ID
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      externalId - The external ID of the user (required)
      userRequestSchema - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      UserResponseSchema
      Throws:
      ApiException - if fails to make API call

    • startImportFromIdentitySource

      public IdentitySourceSession startImportFromIdentitySource(String identitySourceId, String sessionId) throws ApiException
      Start the import from the identity source Starts the import from the identity source described by the uploaded bulk operations
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      sessionId - The ID of the identity source session (required)
      Returns:
      IdentitySourceSession
      Throws:
      ApiException - if fails to make API call

    • startImportFromIdentitySource

      public IdentitySourceSession startImportFromIdentitySource(String identitySourceId, String sessionId, Map<String,String> additionalHeaders) throws ApiException
      Start the import from the identity source Starts the import from the identity source described by the uploaded bulk operations
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      sessionId - The ID of the identity source session (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      IdentitySourceSession
      Throws:
      ApiException - if fails to make API call

    • updateIdentitySourceUsers

      public UserResponseSchema updateIdentitySourceUsers(String identitySourceId, String externalId, UsersUpdateRequestSchema usersUpdateRequestSchema) throws ApiException
      Update an identity source user Updates a user to an identity source for the given identity source instance and external ID
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      externalId - The external ID of the user (required)
      usersUpdateRequestSchema - (optional)
      Returns:
      UserResponseSchema
      Throws:
      ApiException - if fails to make API call

    • updateIdentitySourceUsers

      public UserResponseSchema updateIdentitySourceUsers(String identitySourceId, String externalId, UsersUpdateRequestSchema usersUpdateRequestSchema, Map<String,String> additionalHeaders) throws ApiException
      Update an identity source user Updates a user to an identity source for the given identity source instance and external ID
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      externalId - The external ID of the user (required)
      usersUpdateRequestSchema - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      UserResponseSchema
      Throws:
      ApiException - if fails to make API call

    • uploadIdentitySourceDataForDelete

      public void uploadIdentitySourceDataForDelete(String identitySourceId, String sessionId, BulkDeleteRequestBody bulkDeleteRequestBody) throws ApiException
      Upload the data to be deleted in Okta Uploads external IDs of entities that need to be deleted in Okta from the identity source for the given session
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      sessionId - The ID of the identity source session (required)
      bulkDeleteRequestBody - (optional)
      Throws:
      ApiException - if fails to make API call

    • uploadIdentitySourceDataForDelete

      public void uploadIdentitySourceDataForDelete(String identitySourceId, String sessionId, BulkDeleteRequestBody bulkDeleteRequestBody, Map<String,String> additionalHeaders) throws ApiException
      Upload the data to be deleted in Okta Uploads external IDs of entities that need to be deleted in Okta from the identity source for the given session
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      sessionId - The ID of the identity source session (required)
      bulkDeleteRequestBody - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • uploadIdentitySourceDataForUpsert

      public void uploadIdentitySourceDataForUpsert(String identitySourceId, String sessionId, BulkUpsertRequestBody bulkUpsertRequestBody) throws ApiException
      Upload the data to be upserted in Okta Uploads entities that need to be inserted or updated in Okta from the identity source for the given session
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      sessionId - The ID of the identity source session (required)
      bulkUpsertRequestBody - (optional)
      Throws:
      ApiException - if fails to make API call

    • uploadIdentitySourceDataForUpsert

      public void uploadIdentitySourceDataForUpsert(String identitySourceId, String sessionId, BulkUpsertRequestBody bulkUpsertRequestBody, Map<String,String> additionalHeaders) throws ApiException
      Upload the data to be upserted in Okta Uploads entities that need to be inserted or updated in Okta from the identity source for the given session
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      sessionId - The ID of the identity source session (required)
      bulkUpsertRequestBody - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • uploadIdentitySourceGroupMembershipsForDelete

      public void uploadIdentitySourceGroupMembershipsForDelete(String identitySourceId, String sessionId, BulkGroupMembershipsDeleteRequestBody bulkGroupMembershipsDeleteRequestBody) throws ApiException
      Upload the group memberships to be deleted in Okta Uploads the group memberships that need to be deleted in Okta from the identity source for the given session
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      sessionId - The ID of the identity source session (required)
      bulkGroupMembershipsDeleteRequestBody - (optional)
      Throws:
      ApiException - if fails to make API call

    • uploadIdentitySourceGroupMembershipsForDelete

      public void uploadIdentitySourceGroupMembershipsForDelete(String identitySourceId, String sessionId, BulkGroupMembershipsDeleteRequestBody bulkGroupMembershipsDeleteRequestBody, Map<String,String> additionalHeaders) throws ApiException
      Upload the group memberships to be deleted in Okta Uploads the group memberships that need to be deleted in Okta from the identity source for the given session
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      sessionId - The ID of the identity source session (required)
      bulkGroupMembershipsDeleteRequestBody - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • uploadIdentitySourceGroupMembershipsForUpsert

      public void uploadIdentitySourceGroupMembershipsForUpsert(String identitySourceId, String sessionId, BulkGroupMembershipsUpsertRequestBody bulkGroupMembershipsUpsertRequestBody) throws ApiException
      Upload the group memberships to be upserted in Okta Uploads the group memberships that need to be inserted or updated in Okta from the identity source for the given session
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      sessionId - The ID of the identity source session (required)
      bulkGroupMembershipsUpsertRequestBody - (optional)
      Throws:
      ApiException - if fails to make API call

    • uploadIdentitySourceGroupMembershipsForUpsert

      public void uploadIdentitySourceGroupMembershipsForUpsert(String identitySourceId, String sessionId, BulkGroupMembershipsUpsertRequestBody bulkGroupMembershipsUpsertRequestBody, Map<String,String> additionalHeaders) throws ApiException
      Upload the group memberships to be upserted in Okta Uploads the group memberships that need to be inserted or updated in Okta from the identity source for the given session
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      sessionId - The ID of the identity source session (required)
      bulkGroupMembershipsUpsertRequestBody - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • uploadIdentitySourceGroupsDataForDelete

      public void uploadIdentitySourceGroupsDataForDelete(String identitySourceId, String sessionId, BulkGroupDeleteRequestBody bulkGroupDeleteRequestBody) throws ApiException
      Upload the group external IDs to be deleted in Okta Uploads external IDs of groups that need to be deleted in Okta from the identity source for the given session
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      sessionId - The ID of the identity source session (required)
      bulkGroupDeleteRequestBody - (optional)
      Throws:
      ApiException - if fails to make API call

    • uploadIdentitySourceGroupsDataForDelete

      public void uploadIdentitySourceGroupsDataForDelete(String identitySourceId, String sessionId, BulkGroupDeleteRequestBody bulkGroupDeleteRequestBody, Map<String,String> additionalHeaders) throws ApiException
      Upload the group external IDs to be deleted in Okta Uploads external IDs of groups that need to be deleted in Okta from the identity source for the given session
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      sessionId - The ID of the identity source session (required)
      bulkGroupDeleteRequestBody - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • uploadIdentitySourceGroupsForUpsert

      public void uploadIdentitySourceGroupsForUpsert(String identitySourceId, String sessionId, BulkGroupUpsertRequestBody bulkGroupUpsertRequestBody) throws ApiException
      Upload the group profiles without memberships to be upserted in Okta Uploads the group profiles without memberships that need to be inserted or updated in Okta from the identity source for the given session
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      sessionId - The ID of the identity source session (required)
      bulkGroupUpsertRequestBody - (optional)
      Throws:
      ApiException - if fails to make API call

    • uploadIdentitySourceGroupsForUpsert

      public void uploadIdentitySourceGroupsForUpsert(String identitySourceId, String sessionId, BulkGroupUpsertRequestBody bulkGroupUpsertRequestBody, Map<String,String> additionalHeaders) throws ApiException
      Upload the group profiles without memberships to be upserted in Okta Uploads the group profiles without memberships that need to be inserted or updated in Okta from the identity source for the given session
      Parameters:
      identitySourceId - The ID of the identity source for which the session is created (required)
      sessionId - The ID of the identity source session (required)
      bulkGroupUpsertRequestBody - (optional)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getObjectMapper

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