org.openapitools.client.api

Class RoleAssignmentApi

java.lang.Object

org.openapitools.client.api.RoleAssignmentApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-01-18T04:14:02.238-06:00[America/Chicago]")
 @Component(value="org.openapitools.client.api.RoleAssignmentApi")
public class RoleAssignmentApi
extends Object

Constructor Summary

Constructors

Constructor and Description
RoleAssignmentApi()
RoleAssignmentApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
<T> T	assignRoleToGroup(Class<?> T, String groupId, AssignRoleRequest assignRoleRequest, Boolean disableNotifications) Assign a Role to a Group Assigns a role to a group
Role	assignRoleToGroup(String groupId, AssignRoleRequest assignRoleRequest, Boolean disableNotifications) Assign a Role to a Group Assigns a role to a group
PagedList	assignRoleToGroupWithPaginationInfo(String groupId, AssignRoleRequest assignRoleRequest, Boolean disableNotifications) Assign a Role to a Group Assigns a role to a group
<T> T	assignRoleToUser(Class<?> T, String userId, AssignRoleRequest assignRoleRequest, Boolean disableNotifications) Assign a Role to a User Assigns a role to a user identified by `userId`
Role	assignRoleToUser(String userId, AssignRoleRequest assignRoleRequest, Boolean disableNotifications) Assign a Role to a User Assigns a role to a user identified by `userId`
PagedList	assignRoleToUserWithPaginationInfo(String userId, AssignRoleRequest assignRoleRequest, Boolean disableNotifications) Assign a Role to a User Assigns a role to a user identified by `userId`
ApiClient	getApiClient()
Role	getGroupAssignedRole(String groupId, String roleId) Retrieve a Role assigned to Group Retrieves a role identified by `roleId` assigned to group identified by `groupId`
PagedList	getGroupAssignedRoleWithPaginationInfo(String groupId, String roleId) Retrieve a Role assigned to Group Retrieves a role identified by `roleId` assigned to group identified by `groupId`
Role	getUserAssignedRole(String userId, String roleId) Retrieve a Role assigned to a User Retrieves a role identified by `roleId` assigned to a user identified by `userId`
PagedList	getUserAssignedRoleWithPaginationInfo(String userId, String roleId) Retrieve a Role assigned to a User Retrieves a role identified by `roleId` assigned to a user identified by `userId`
List<Role>	listAssignedRolesForUser(String userId, String expand) List all Roles assigned to a User Lists all roles assigned to a user identified by `userId`
PagedList	listAssignedRolesForUserWithPaginationInfo(String userId, String expand) List all Roles assigned to a User Lists all roles assigned to a user identified by `userId`
List<Role>	listGroupAssignedRoles(String groupId, String expand) List all Assigned Roles of Group Lists all assigned roles of group identified by `groupId`
PagedList	listGroupAssignedRolesWithPaginationInfo(String groupId, String expand) List all Assigned Roles of Group Lists all assigned roles of group identified by `groupId`
void	setApiClient(ApiClient apiClient)
void	unassignRoleFromGroup(String groupId, String roleId) Unassign a Role from a Group Unassigns a role identified by `roleId` assigned to group identified by `groupId`
void	unassignRoleFromUser(String userId, String roleId) Unassign a Role from a User Unassigns a role identified by `roleId` from a user identified by `userId`

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleAssignmentApi

public RoleAssignmentApi()

RoleAssignmentApi

@Autowired
public RoleAssignmentApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

assignRoleToGroup

public Role assignRoleToGroup(String groupId,
                              AssignRoleRequest assignRoleRequest,
                              Boolean disableNotifications)
                       throws org.springframework.web.client.RestClientException

Assign a Role to a Group Assigns a role to a group

200 - Success

201 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

assignRoleRequest - (required)

disableNotifications - Setting this to `true` grants the group third-party admin status (optional)

Returns:

Role

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

assignRoleToGroup

public <T> T assignRoleToGroup(Class<?> T,
                               String groupId,
                               AssignRoleRequest assignRoleRequest,
                               Boolean disableNotifications)
                        throws org.springframework.web.client.RestClientException

Assign a Role to a Group Assigns a role to a group

200 - Success

201 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

groupId - (required)

assignRoleRequest - (required)

disableNotifications - Setting this to `true` grants the group third-party admin status (optional)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

assignRoleToGroupWithPaginationInfo

public PagedList assignRoleToGroupWithPaginationInfo(String groupId,
                                                     AssignRoleRequest assignRoleRequest,
                                                     Boolean disableNotifications)
                                              throws org.springframework.web.client.RestClientException

Assign a Role to a Group Assigns a role to a group

200 - Success

201 - Success

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

assignRoleRequest - (required)

disableNotifications - Setting this to `true` grants the group third-party admin status (optional)

Returns:

ResponseEntity<Role>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

assignRoleToUser

public Role assignRoleToUser(String userId,
                             AssignRoleRequest assignRoleRequest,
                             Boolean disableNotifications)
                      throws org.springframework.web.client.RestClientException

Assign a Role to a User Assigns a role to a user identified by `userId`

201 - Created

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

assignRoleRequest - (required)

disableNotifications - Setting this to `true` grants the user third-party admin status (optional)

Returns:

Role

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

assignRoleToUser

public <T> T assignRoleToUser(Class<?> T,
                              String userId,
                              AssignRoleRequest assignRoleRequest,
                              Boolean disableNotifications)
                       throws org.springframework.web.client.RestClientException

Assign a Role to a User Assigns a role to a user identified by `userId`

201 - Created

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

T - (required) - the assignable return type

userId - (required)

assignRoleRequest - (required)

disableNotifications - Setting this to `true` grants the user third-party admin status (optional)

Returns:

T instance

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

assignRoleToUserWithPaginationInfo

public PagedList assignRoleToUserWithPaginationInfo(String userId,
                                                    AssignRoleRequest assignRoleRequest,
                                                    Boolean disableNotifications)
                                             throws org.springframework.web.client.RestClientException

Assign a Role to a User Assigns a role to a user identified by `userId`

201 - Created

400 - Bad Request

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

assignRoleRequest - (required)

disableNotifications - Setting this to `true` grants the user third-party admin status (optional)

Returns:

ResponseEntity<Role>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getGroupAssignedRole

public Role getGroupAssignedRole(String groupId,
                                 String roleId)
                          throws org.springframework.web.client.RestClientException

Retrieve a Role assigned to Group Retrieves a role identified by `roleId` assigned to group identified by `groupId`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

roleId - (required)

Returns:

Role

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getGroupAssignedRoleWithPaginationInfo

public PagedList getGroupAssignedRoleWithPaginationInfo(String groupId,
                                                        String roleId)
                                                 throws org.springframework.web.client.RestClientException

Retrieve a Role assigned to Group Retrieves a role identified by `roleId` assigned to group identified by `groupId`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

roleId - (required)

Returns:

ResponseEntity<Role>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getUserAssignedRole

public Role getUserAssignedRole(String userId,
                                String roleId)
                         throws org.springframework.web.client.RestClientException

Retrieve a Role assigned to a User Retrieves a role identified by `roleId` assigned to a user identified by `userId`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

roleId - (required)

Returns:

Role

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

getUserAssignedRoleWithPaginationInfo

public PagedList getUserAssignedRoleWithPaginationInfo(String userId,
                                                       String roleId)
                                                throws org.springframework.web.client.RestClientException

Retrieve a Role assigned to a User Retrieves a role identified by `roleId` assigned to a user identified by `userId`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

roleId - (required)

Returns:

ResponseEntity<Role>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listAssignedRolesForUser

public List<Role> listAssignedRolesForUser(String userId,
                                           String expand)
                                    throws org.springframework.web.client.RestClientException

List all Roles assigned to a User Lists all roles assigned to a user identified by `userId`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

expand - (optional)

Returns:

List<Role>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listAssignedRolesForUserWithPaginationInfo

public PagedList listAssignedRolesForUserWithPaginationInfo(String userId,
                                                            String expand)
                                                     throws org.springframework.web.client.RestClientException

List all Roles assigned to a User Lists all roles assigned to a user identified by `userId`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

expand - (optional)

Returns:

ResponseEntity<List<Role>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listGroupAssignedRoles

public List<Role> listGroupAssignedRoles(String groupId,
                                         String expand)
                                  throws org.springframework.web.client.RestClientException

List all Assigned Roles of Group Lists all assigned roles of group identified by `groupId`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

expand - (optional)

Returns:

List<Role>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

listGroupAssignedRolesWithPaginationInfo

public PagedList listGroupAssignedRolesWithPaginationInfo(String groupId,
                                                          String expand)
                                                   throws org.springframework.web.client.RestClientException

List all Assigned Roles of Group Lists all assigned roles of group identified by `groupId`

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

expand - (optional)

Returns:

ResponseEntity<List<Role>>

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

unassignRoleFromGroup

public void unassignRoleFromGroup(String groupId,
                                  String roleId)
                           throws org.springframework.web.client.RestClientException

Unassign a Role from a Group Unassigns a role identified by `roleId` assigned to group identified by `groupId`

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

roleId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API

unassignRoleFromUser

public void unassignRoleFromUser(String userId,
                                 String roleId)
                          throws org.springframework.web.client.RestClientException

Unassign a Role from a User Unassigns a role identified by `roleId` from a user identified by `userId`

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

roleId - (required)

Throws:

org.springframework.web.client.RestClientException - if an error occurs while attempting to invoke the API