Package com.okta.sdk.resource.api

Class RoleAssignmentBGroupApi

java.lang.Object

com.okta.sdk.resource.api.RoleAssignmentBGroupApi

@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 RoleAssignmentBGroupApi
extends Object

Constructor Summary

Constructors

Constructor	Description
RoleAssignmentBGroupApi()
RoleAssignmentBGroupApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
AssignRoleToGroup200Response	assignRoleToGroup(String groupId, AssignRoleToGroupRequest assignRoleRequest, Boolean disableNotifications)	Assign a role to a group Assigns a [standard role](/openapi/okta-management/guides/roles/#standard-roles) to a group.
AssignRoleToGroup200Response	assignRoleToGroup(String groupId, AssignRoleToGroupRequest assignRoleRequest, Boolean disableNotifications, Map<String,String> additionalHeaders)	Assign a role to a group Assigns a [standard role](/openapi/okta-management/guides/roles/#standard-roles) to a group.
ApiClient	getApiClient()
AssignRoleToGroup200Response	getGroupAssignedRole(String groupId, String roleAssignmentId)	Retrieve a group role assignment Retrieves a role assigned to a group (identified by the `groupId`).
AssignRoleToGroup200Response	getGroupAssignedRole(String groupId, String roleAssignmentId, Map<String,String> additionalHeaders)	Retrieve a group role assignment Retrieves a role assigned to a group (identified by the `groupId`).
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
List<ListGroupAssignedRoles200ResponseInner>	listGroupAssignedRoles(String groupId, String expand)	List all group role assignments Lists all assigned roles of a group by `groupId`
List<ListGroupAssignedRoles200ResponseInner>	listGroupAssignedRoles(String groupId, String expand, Map<String,String> additionalHeaders)	List all group role assignments Lists all assigned roles of a group by `groupId`
Iterable<ListGroupAssignedRoles200ResponseInner>	listGroupAssignedRolesPaged(String groupId, String expand)	List all group role assignments (Paginated) Lists all assigned roles of a group by `groupId` This method returns a lazy, paginated iterable that automatically handles pagination.
Iterable<ListGroupAssignedRoles200ResponseInner>	listGroupAssignedRolesPaged(String groupId, String expand, Map<String,String> additionalHeaders)	List all group role assignments (Paginated with additional headers) Lists all assigned roles of a group by `groupId` This method returns a lazy, paginated iterable that automatically handles pagination.
void	setApiClient(ApiClient apiClient)
void	unassignRoleFromGroup(String groupId, String roleAssignmentId)	Unassign a group role Unassigns a role assignment (identified by `roleAssignmentId`) from a group (identified by the `groupId`)
void	unassignRoleFromGroup(String groupId, String roleAssignmentId, Map<String,String> additionalHeaders)	Unassign a group role Unassigns a role assignment (identified by `roleAssignmentId`) from a group (identified by the `groupId`)

Methods inherited from class java.lang.Object

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

Constructor Details

RoleAssignmentBGroupApi

public RoleAssignmentBGroupApi()

RoleAssignmentBGroupApi

public RoleAssignmentBGroupApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

assignRoleToGroup

public AssignRoleToGroup200Response assignRoleToGroup(String groupId,
 AssignRoleToGroupRequest assignRoleRequest,
 Boolean disableNotifications)
                                               throws ApiException

Assign a role to a group Assigns a [standard role](/openapi/okta-management/guides/roles/#standard-roles) to a group. You can also assign a custom role to a group, but the preferred method to assign a custom role to a group is to create a binding between the custom role, the resource set, and the group. See [Create a role resource set binding](/openapi/okta-management/management/tag/RoleDResourceSetBinding/#tag/RoleDResourceSetBinding/operation/createResourceSetBinding). > **Notes:** > * The request payload is different for standard and custom role assignments. > * For IAM-based standard role assignments, use the request payload for standard roles. However, the response payload for IAM-based role assignments is similar to the custom role's assignment response.

Parameters:

groupId - The `id` of the group (required)

assignRoleRequest - (required)

disableNotifications - Grants the group third-party admin status when set to `true` (optional, default to false)

Returns:

AssignRoleToGroup200Response

Throws:

ApiException - if fails to make API call

assignRoleToGroup

public AssignRoleToGroup200Response assignRoleToGroup(String groupId,
 AssignRoleToGroupRequest assignRoleRequest,
 Boolean disableNotifications,
 Map<String,String> additionalHeaders)
                                               throws ApiException

Assign a role to a group Assigns a [standard role](/openapi/okta-management/guides/roles/#standard-roles) to a group. You can also assign a custom role to a group, but the preferred method to assign a custom role to a group is to create a binding between the custom role, the resource set, and the group. See [Create a role resource set binding](/openapi/okta-management/management/tag/RoleDResourceSetBinding/#tag/RoleDResourceSetBinding/operation/createResourceSetBinding). > **Notes:** > * The request payload is different for standard and custom role assignments. > * For IAM-based standard role assignments, use the request payload for standard roles. However, the response payload for IAM-based role assignments is similar to the custom role's assignment response.

Parameters:

groupId - The `id` of the group (required)

assignRoleRequest - (required)

disableNotifications - Grants the group third-party admin status when set to `true` (optional, default to false)

additionalHeaders - additionalHeaders for this call

Returns:

AssignRoleToGroup200Response

Throws:

ApiException - if fails to make API call

getGroupAssignedRole

public AssignRoleToGroup200Response getGroupAssignedRole(String groupId,
 String roleAssignmentId)
                                                  throws ApiException

Retrieve a group role assignment Retrieves a role assigned to a group (identified by the `groupId`). The `roleAssignmentId` is the unique identifier for either a standard role group assignment object or a custom role resource set binding object.

Parameters:

groupId - The `id` of the group (required)

roleAssignmentId - The `id` of the role assignment (required)

Returns:

AssignRoleToGroup200Response

Throws:

ApiException - if fails to make API call

getGroupAssignedRole

public AssignRoleToGroup200Response getGroupAssignedRole(String groupId,
 String roleAssignmentId,
 Map<String,String> additionalHeaders)
                                                  throws ApiException

Retrieve a group role assignment Retrieves a role assigned to a group (identified by the `groupId`). The `roleAssignmentId` is the unique identifier for either a standard role group assignment object or a custom role resource set binding object.

Parameters:

groupId - The `id` of the group (required)

roleAssignmentId - The `id` of the role assignment (required)

additionalHeaders - additionalHeaders for this call

Returns:

AssignRoleToGroup200Response

Throws:

ApiException - if fails to make API call

listGroupAssignedRoles

public List<ListGroupAssignedRoles200ResponseInner> listGroupAssignedRoles(String groupId,
 String expand)
                                                                    throws ApiException

List all group role assignments Lists all assigned roles of a group by `groupId`

Parameters:

groupId - The `id` of the group (required)

expand - An optional parameter used to return targets configured for the standard role assignment in the `embedded` property. Supported values: `targets/groups` or `targets/catalog/apps` (optional)

Returns:

List<ListGroupAssignedRoles200ResponseInner>

Throws:

ApiException - if fails to make API call

listGroupAssignedRoles

public List<ListGroupAssignedRoles200ResponseInner> listGroupAssignedRoles(String groupId,
 String expand,
 Map<String,String> additionalHeaders)
                                                                    throws ApiException

List all group role assignments Lists all assigned roles of a group by `groupId`

Parameters:

groupId - The `id` of the group (required)

expand - An optional parameter used to return targets configured for the standard role assignment in the `embedded` property. Supported values: `targets/groups` or `targets/catalog/apps` (optional)

additionalHeaders - additionalHeaders for this call

Returns:

List<ListGroupAssignedRoles200ResponseInner>

Throws:

ApiException - if fails to make API call

listGroupAssignedRolesPaged

public Iterable<ListGroupAssignedRoles200ResponseInner> listGroupAssignedRolesPaged(String groupId,
 String expand)

List all group role assignments (Paginated) Lists all assigned roles of a group by `groupId` 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:

groupId - The `id` of the group (required)

expand - An optional parameter used to return targets configured for the standard role assignment in the `embedded` property. Supported values: `targets/groups` or `targets/catalog/apps` (optional)

Returns:

Iterable<ListGroupAssignedRoles200ResponseInner> lazy iterable over all pages

listGroupAssignedRolesPaged

public Iterable<ListGroupAssignedRoles200ResponseInner> listGroupAssignedRolesPaged(String groupId,
 String expand,
 Map<String,String> additionalHeaders)

List all group role assignments (Paginated with additional headers) Lists all assigned roles of a group by `groupId` This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.

Parameters:

groupId - The `id` of the group (required)

expand - An optional parameter used to return targets configured for the standard role assignment in the `embedded` property. Supported values: `targets/groups` or `targets/catalog/apps` (optional)

additionalHeaders - additional headers for this call

Returns:

Iterable<ListGroupAssignedRoles200ResponseInner> lazy iterable over all pages

unassignRoleFromGroup

public void unassignRoleFromGroup(String groupId,
 String roleAssignmentId)
                           throws ApiException

Unassign a group role Unassigns a role assignment (identified by `roleAssignmentId`) from a group (identified by the `groupId`)

Parameters:

groupId - The `id` of the group (required)

roleAssignmentId - The `id` of the role assignment (required)

Throws:

ApiException - if fails to make API call

unassignRoleFromGroup

public void unassignRoleFromGroup(String groupId,
 String roleAssignmentId,
 Map<String,String> additionalHeaders)
                           throws ApiException

Unassign a group role Unassigns a role assignment (identified by `roleAssignmentId`) from a group (identified by the `groupId`)

Parameters:

groupId - The `id` of the group (required)

roleAssignmentId - The `id` of the role assignment (required)

additionalHeaders - additionalHeaders for this call

Throws:

ApiException - if fails to make API call

getObjectMapper

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