Class ApplicationGroupsApi

java.lang.Object
com.okta.sdk.resource.api.ApplicationGroupsApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-03-29T16:47:02.065887-05:00[America/Chicago]", comments="Generator version: 7.4.0") public class ApplicationGroupsApi extends Object
  • Constructor Details

    • ApplicationGroupsApi

      public ApplicationGroupsApi()
    • ApplicationGroupsApi

      public ApplicationGroupsApi(ApiClient apiClient)
  • Method Details

    • getApiClient

      public ApiClient getApiClient()
    • setApiClient

      public void setApiClient(ApiClient apiClient)
    • assignGroupToApplication

      public ApplicationGroupAssignment assignGroupToApplication(String appId, String groupId, ApplicationGroupAssignment applicationGroupAssignment) throws ApiException
      Assign a Group Assigns a group to an application
      Parameters:
      appId - ID of the Application (required)
      groupId - The `id` of the group (required)
      applicationGroupAssignment - (optional)
      Returns:
      ApplicationGroupAssignment
      Throws:
      ApiException - if fails to make API call
    • assignGroupToApplication

      public ApplicationGroupAssignment assignGroupToApplication(String appId, String groupId, ApplicationGroupAssignment applicationGroupAssignment, Map<String,String> additionalHeaders) throws ApiException
      Assign a Group Assigns a group to an application
      Parameters:
      appId - ID of the Application (required)
      groupId - The `id` of the group (required)
      applicationGroupAssignment - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ApplicationGroupAssignment
      Throws:
      ApiException - if fails to make API call
    • getApplicationGroupAssignment

      public ApplicationGroupAssignment getApplicationGroupAssignment(String appId, String groupId, String expand) throws ApiException
      Retrieve an Assigned Group Retrieves an application group assignment
      Parameters:
      appId - ID of the Application (required)
      groupId - The `id` of the group (required)
      expand - (optional)
      Returns:
      ApplicationGroupAssignment
      Throws:
      ApiException - if fails to make API call
    • getApplicationGroupAssignment

      public ApplicationGroupAssignment getApplicationGroupAssignment(String appId, String groupId, String expand, Map<String,String> additionalHeaders) throws ApiException
      Retrieve an Assigned Group Retrieves an application group assignment
      Parameters:
      appId - ID of the Application (required)
      groupId - The `id` of the group (required)
      expand - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      ApplicationGroupAssignment
      Throws:
      ApiException - if fails to make API call
    • listApplicationGroupAssignments

      public List<ApplicationGroupAssignment> listApplicationGroupAssignments(String appId, String q, String after, Integer limit, String expand) throws ApiException
      List all Assigned Groups Lists all group assignments for an application
      Parameters:
      appId - ID of the Application (required)
      q - (optional)
      after - Specifies the pagination cursor for the next page of assignments (optional)
      limit - Specifies the number of results for a page (optional, default to -1)
      expand - (optional)
      Returns:
      List<ApplicationGroupAssignment>
      Throws:
      ApiException - if fails to make API call
    • listApplicationGroupAssignments

      public List<ApplicationGroupAssignment> listApplicationGroupAssignments(String appId, String q, String after, Integer limit, String expand, Map<String,String> additionalHeaders) throws ApiException
      List all Assigned Groups Lists all group assignments for an application
      Parameters:
      appId - ID of the Application (required)
      q - (optional)
      after - Specifies the pagination cursor for the next page of assignments (optional)
      limit - Specifies the number of results for a page (optional, default to -1)
      expand - (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<ApplicationGroupAssignment>
      Throws:
      ApiException - if fails to make API call
    • unassignApplicationFromGroup

      public void unassignApplicationFromGroup(String appId, String groupId) throws ApiException
      Unassign a Group Unassigns a group from an application
      Parameters:
      appId - ID of the Application (required)
      groupId - The `id` of the group (required)
      Throws:
      ApiException - if fails to make API call
    • unassignApplicationFromGroup

      public void unassignApplicationFromGroup(String appId, String groupId, Map<String,String> additionalHeaders) throws ApiException
      Unassign a Group Unassigns a group from an application
      Parameters:
      appId - ID of the Application (required)
      groupId - The `id` of the group (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call
    • getObjectMapper

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