Package com.okta.sdk.resource.api

Class GroupPushMappingApi

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

  • Constructor Details

    • GroupPushMappingApi

      public GroupPushMappingApi()

    • GroupPushMappingApi

      public GroupPushMappingApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • createGroupPushMapping

      public GroupPushMapping createGroupPushMapping(String appId, CreateGroupPushMappingRequest body) throws ApiException
      Create a group push mapping Creates or links a group push mapping. **Note:** Either `targetGroupId` or `targetGroupName` must be provided, but not both. If `targetGroupId` is provided, it links to an existing group. If `targetGroupName` is provided, it creates a new group.
      Parameters:
      appId - Application ID (required)
      body - (required)
      Returns:
      GroupPushMapping
      Throws:
      ApiException - if fails to make API call

    • createGroupPushMapping

      public GroupPushMapping createGroupPushMapping(String appId, CreateGroupPushMappingRequest body, Map<String,String> additionalHeaders) throws ApiException
      Create a group push mapping Creates or links a group push mapping. **Note:** Either `targetGroupId` or `targetGroupName` must be provided, but not both. If `targetGroupId` is provided, it links to an existing group. If `targetGroupName` is provided, it creates a new group.
      Parameters:
      appId - Application ID (required)
      body - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      GroupPushMapping
      Throws:
      ApiException - if fails to make API call

    • deleteGroupPushMapping

      public void deleteGroupPushMapping(String appId, String mappingId, Boolean deleteTargetGroup) throws ApiException
      Delete a group push mapping Deletes a specific group push mapping. The group push mapping must be in an `INACTIVE` state.
      Parameters:
      appId - Application ID (required)
      mappingId - Group push mapping ID (required)
      deleteTargetGroup - If set to `true`, the target group is also deleted. If set to `false`, the target group isn't deleted. (required)
      Throws:
      ApiException - if fails to make API call

    • deleteGroupPushMapping

      public void deleteGroupPushMapping(String appId, String mappingId, Boolean deleteTargetGroup, Map<String,String> additionalHeaders) throws ApiException
      Delete a group push mapping Deletes a specific group push mapping. The group push mapping must be in an `INACTIVE` state.
      Parameters:
      appId - Application ID (required)
      mappingId - Group push mapping ID (required)
      deleteTargetGroup - If set to `true`, the target group is also deleted. If set to `false`, the target group isn't deleted. (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getGroupPushMapping

      public GroupPushMapping getGroupPushMapping(String appId, String mappingId) throws ApiException
      Retrieve a group push mapping Retrieves a group push mapping by ID
      Parameters:
      appId - Application ID (required)
      mappingId - Group push mapping ID (required)
      Returns:
      GroupPushMapping
      Throws:
      ApiException - if fails to make API call

    • getGroupPushMapping

      public GroupPushMapping getGroupPushMapping(String appId, String mappingId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve a group push mapping Retrieves a group push mapping by ID
      Parameters:
      appId - Application ID (required)
      mappingId - Group push mapping ID (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      GroupPushMapping
      Throws:
      ApiException - if fails to make API call

    • listGroupPushMappings

      public List<GroupPushMapping> listGroupPushMappings(String appId, String after, Integer limit, String lastUpdated, String sourceGroupId, GroupPushMappingStatus status) throws ApiException
      List all group push mappings Lists all group push mappings with pagination support
      Parameters:
      appId - Application ID (required)
      after - Specifies the pagination cursor for the next page of mappings (optional)
      limit - Specifies the number of results returned (optional, default to 100)
      lastUpdated - Filters group push mappings by last updated date. The `lastUpdated` parameter supports the following format: `YYYY-MM-DDTHH:mm:ssZ`. This filters mappings updated on or after the specified date and time in UTC. If you don't specify a value, all group push mappings are returned. (optional)
      sourceGroupId - Filters group push mappings by source group ID. If you don't specify a value, all group push mappings are returned. (optional)
      status - Filters group push mappings by status. If you don't specify a value, all group push mappings are returned. (optional)
      Returns:
      List<GroupPushMapping>
      Throws:
      ApiException - if fails to make API call

    • listGroupPushMappings

      public List<GroupPushMapping> listGroupPushMappings(String appId, String after, Integer limit, String lastUpdated, String sourceGroupId, GroupPushMappingStatus status, Map<String,String> additionalHeaders) throws ApiException
      List all group push mappings Lists all group push mappings with pagination support
      Parameters:
      appId - Application ID (required)
      after - Specifies the pagination cursor for the next page of mappings (optional)
      limit - Specifies the number of results returned (optional, default to 100)
      lastUpdated - Filters group push mappings by last updated date. The `lastUpdated` parameter supports the following format: `YYYY-MM-DDTHH:mm:ssZ`. This filters mappings updated on or after the specified date and time in UTC. If you don't specify a value, all group push mappings are returned. (optional)
      sourceGroupId - Filters group push mappings by source group ID. If you don't specify a value, all group push mappings are returned. (optional)
      status - Filters group push mappings by status. If you don't specify a value, all group push mappings are returned. (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<GroupPushMapping>
      Throws:
      ApiException - if fails to make API call

    • listGroupPushMappingsPaged

      public Iterable<GroupPushMapping> listGroupPushMappingsPaged(String appId, String after, Integer limit, String lastUpdated, String sourceGroupId, GroupPushMappingStatus status)
      List all group push mappings (Paginated) Lists all group push mappings with pagination support 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)
      after - Specifies the pagination cursor for the next page of mappings (optional)
      limit - Specifies the number of results returned (optional, default to 100)
      lastUpdated - Filters group push mappings by last updated date. The `lastUpdated` parameter supports the following format: `YYYY-MM-DDTHH:mm:ssZ`. This filters mappings updated on or after the specified date and time in UTC. If you don't specify a value, all group push mappings are returned. (optional)
      sourceGroupId - Filters group push mappings by source group ID. If you don't specify a value, all group push mappings are returned. (optional)
      status - Filters group push mappings by status. If you don't specify a value, all group push mappings are returned. (optional)
      Returns:
      Iterable<GroupPushMapping> lazy iterable over all pages

    • listGroupPushMappingsPaged

      public Iterable<GroupPushMapping> listGroupPushMappingsPaged(String appId, String after, Integer limit, String lastUpdated, String sourceGroupId, GroupPushMappingStatus status, Map<String,String> additionalHeaders)
      List all group push mappings (Paginated with additional headers) Lists all group push mappings with pagination support 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)
      after - Specifies the pagination cursor for the next page of mappings (optional)
      limit - Specifies the number of results returned (optional, default to 100)
      lastUpdated - Filters group push mappings by last updated date. The `lastUpdated` parameter supports the following format: `YYYY-MM-DDTHH:mm:ssZ`. This filters mappings updated on or after the specified date and time in UTC. If you don't specify a value, all group push mappings are returned. (optional)
      sourceGroupId - Filters group push mappings by source group ID. If you don't specify a value, all group push mappings are returned. (optional)
      status - Filters group push mappings by status. If you don't specify a value, all group push mappings are returned. (optional)
      additionalHeaders - additional headers for this call
      Returns:
      Iterable<GroupPushMapping> lazy iterable over all pages

    • updateGroupPushMapping

      public GroupPushMapping updateGroupPushMapping(String appId, String mappingId, UpdateGroupPushMappingRequest body) throws ApiException
      Update a group push mapping Updates the status of a group push mapping
      Parameters:
      appId - Application ID (required)
      mappingId - Group push mapping ID (required)
      body - (required)
      Returns:
      GroupPushMapping
      Throws:
      ApiException - if fails to make API call

    • updateGroupPushMapping

      public GroupPushMapping updateGroupPushMapping(String appId, String mappingId, UpdateGroupPushMappingRequest body, Map<String,String> additionalHeaders) throws ApiException
      Update a group push mapping Updates the status of a group push mapping
      Parameters:
      appId - Application ID (required)
      mappingId - Group push mapping ID (required)
      body - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      GroupPushMapping
      Throws:
      ApiException - if fails to make API call

    • getObjectMapper

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