org.openapitools.client.api

Class ApplicationGroupsApi

java.lang.Object

org.openapitools.client.api.ApplicationGroupsApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-07-14T17:07:26.321-05:00[America/Chicago]")
public class ApplicationGroupsApi
extends Object

Constructor Summary

Constructors

Constructor and Description
ApplicationGroupsApi()
ApplicationGroupsApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
ApplicationGroupAssignment	assignGroupToApplication(String appId, String groupId, ApplicationGroupAssignment applicationGroupAssignment) Assign a Group Assigns a group to an application
ApplicationGroupAssignment	assignGroupToApplication(String appId, String groupId, ApplicationGroupAssignment applicationGroupAssignment, Map<String,String> additionalHeaders) Assign a Group Assigns a group to an application
ApiClient	getApiClient()
ApplicationGroupAssignment	getApplicationGroupAssignment(String appId, String groupId, String expand) Retrieve an Assigned Group Retrieves an application group assignment
ApplicationGroupAssignment	getApplicationGroupAssignment(String appId, String groupId, String expand, Map<String,String> additionalHeaders) Retrieve an Assigned Group Retrieves an application group assignment
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
List<ApplicationGroupAssignment>	listApplicationGroupAssignments(String appId, String q, String after, Integer limit, String expand) List all Assigned Groups Lists all group assignments for an application
List<ApplicationGroupAssignment>	listApplicationGroupAssignments(String appId, String q, String after, Integer limit, String expand, Map<String,String> additionalHeaders) List all Assigned Groups Lists all group assignments for an application
void	setApiClient(ApiClient apiClient)
void	unassignApplicationFromGroup(String appId, String groupId) Unassign a Group Unassigns a group from an application
void	unassignApplicationFromGroup(String appId, String groupId, Map<String,String> additionalHeaders) Unassign a Group Unassigns a group from an application

Methods inherited from class java.lang.Object

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

Constructor Detail

ApplicationGroupsApi

public ApplicationGroupsApi()

ApplicationGroupsApi

public ApplicationGroupsApi(ApiClient apiClient)

Method Detail

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()