org.openapitools.client.api

Class RoleAssignmentApi

java.lang.Object

org.openapitools.client.api.RoleAssignmentApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2022-10-28T09:54:00.189-05:00[America/Chicago]")
 @Component(value="org.openapitools.client.api.RoleAssignmentApi")
public class RoleAssignmentApi
extends java.lang.Object

Constructor Summary

Constructors

Constructor and Description
RoleAssignmentApi()
RoleAssignmentApi(ApiClient apiClient)

Method Summary

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