Package com.okta.sdk.resource.api

Class ApplicationGroupsApi

java.lang.Object
com.okta.sdk.resource.api.ApplicationGroupsApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-09-23T16:19:57.008753975Z[Etc/UTC]", comments="Generator version: 7.8.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 an Application Group Assigns a [Group](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Group/) to an app, which in turn assigns the app to each [User](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/User/) that belongs to the group. The resulting Application User [scope](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/ApplicationUsers/#tag/ApplicationUsers/operation/listApplicationUsers!c=200&path=scope&t=response) is `GROUP` since the assignment was from the group membership.
      Parameters:
      appId - Application ID (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 an Application Group Assigns a [Group](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Group/) to an app, which in turn assigns the app to each [User](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/User/) that belongs to the group. The resulting Application User [scope](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/ApplicationUsers/#tag/ApplicationUsers/operation/listApplicationUsers!c=200&path=scope&t=response) is `GROUP` since the assignment was from the group membership.
      Parameters:
      appId - Application ID (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 Application Group Retrieves an app group assignment
      Parameters:
      appId - Application ID (required)
      groupId - The `id` of the group (required)
      expand - An optional query parameter to return the corresponding assigned [Group](/openapi/okta-management/management/tag/Group/) or the group assignment metadata details in the `_embedded` property. (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 Application Group Retrieves an app group assignment
      Parameters:
      appId - Application ID (required)
      groupId - The `id` of the group (required)
      expand - An optional query parameter to return the corresponding assigned [Group](/openapi/okta-management/management/tag/Group/) or the group assignment metadata details in the `_embedded` property. (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 Application Groups Lists all app group assignments
      Parameters:
      appId - Application ID (required)
      q - Specifies a filter for a list of assigned groups returned based on their names. The value of `q` is matched against the group `name`. This filter only supports the `startsWith` operation that matches the `q` string against the beginning of the [Group name](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Group/#tag/Group/operation/listGroups!c=200&path=profile/name&t=response). (optional)
      after - Specifies the pagination cursor for the `next` page of results. Treat this as an opaque value obtained through the next link relationship. See [Pagination](https://developer.okta.com/docs/api/#pagination). (optional)
      limit - Specifies the number of objects to return per page. If there are multiple pages of results, the Link header contains a `next` link that you need to use as an opaque value (follow it, don't parse it). See [Pagination](/#pagination). (optional, default to 20)
      expand - An optional query parameter to return the corresponding assigned [Group](/openapi/okta-management/management/tag/Group/) or the group assignment metadata details in the `_embedded` property. (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 Application Groups Lists all app group assignments
      Parameters:
      appId - Application ID (required)
      q - Specifies a filter for a list of assigned groups returned based on their names. The value of `q` is matched against the group `name`. This filter only supports the `startsWith` operation that matches the `q` string against the beginning of the [Group name](https://developer.okta.com/docs/api/openapi/okta-management/management/tag/Group/#tag/Group/operation/listGroups!c=200&path=profile/name&t=response). (optional)
      after - Specifies the pagination cursor for the `next` page of results. Treat this as an opaque value obtained through the next link relationship. See [Pagination](https://developer.okta.com/docs/api/#pagination). (optional)
      limit - Specifies the number of objects to return per page. If there are multiple pages of results, the Link header contains a `next` link that you need to use as an opaque value (follow it, don't parse it). See [Pagination](/#pagination). (optional, default to 20)
      expand - An optional query parameter to return the corresponding assigned [Group](/openapi/okta-management/management/tag/Group/) or the group assignment metadata details in the `_embedded` property. (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 an Application Group Unassigns a Group from an app
      Parameters:
      appId - Application ID (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 an Application Group Unassigns a Group from an app
      Parameters:
      appId - Application ID (required)
      groupId - The `id` of the group (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • updateGroupAssignmentToApplication

      public ApplicationGroupAssignment updateGroupAssignmentToApplication(String appId, String groupId, List<JsonPatchOperation> jsonPatchOperation) throws ApiException
      Update an Application Group Updates a group assignment to an app
      Parameters:
      appId - Application ID (required)
      groupId - The `id` of the group (required)
      jsonPatchOperation - (optional
      Returns:
      ApplicationGroupAssignment
      Throws:
      ApiException - if fails to make API call

    • updateGroupAssignmentToApplication

      public ApplicationGroupAssignment updateGroupAssignmentToApplication(String appId, String groupId, List<JsonPatchOperation> jsonPatchOperation, Map<String,String> additionalHeaders) throws ApiException
      Update an Application Group Updates a group assignment to an app
      Parameters:
      appId - Application ID (required)
      groupId - The `id` of the group (required)
      jsonPatchOperation - (optional
      additionalHeaders - additionalHeaders for this call
      Returns:
      ApplicationGroupAssignment
      Throws:
      ApiException - if fails to make API call

    • getObjectMapper

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