org.openapitools.client.api

Class RoleTargetApi

java.lang.Object

org.openapitools.client.api.RoleTargetApi

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

Constructor Summary

Constructors

Constructor and Description
RoleTargetApi()
RoleTargetApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
void	assignAllAppsAsTargetToRoleForUser(String userId, String roleId) Assign all Apps as Target to Role Assigns all Apps as Target to Role
void	assignAppInstanceTargetToAppAdminRoleForGroup(String groupId, String roleId, String appName, String applicationId) Assign an Application Instance Target to Application Administrator Role Assigns App Instance Target to App Administrator Role given to a Group
void	assignAppInstanceTargetToAppAdminRoleForUser(String userId, String roleId, String appName, String applicationId) Assign an Application Instance Target to an Application Administrator Role Assigns anapplication instance target to appplication administrator role
void	assignAppTargetToAdminRoleForGroup(String groupId, String roleId, String appName) Assign an Application Target to Administrator Role Assigns an application target to administrator role
void	assignAppTargetToAdminRoleForUser(String userId, String roleId, String appName) Assign an Application Target to Administrator Role Assigns an application target to administrator role
void	assignGroupTargetToGroupAdminRole(String groupId, String roleId, String targetGroupId) Assign a Group Target to a Group Role Assigns a group target to a group role
void	assignGroupTargetToUserRole(String userId, String roleId, String groupId) Assign a Group Target to Role Assigns a Group Target to Role
ApiClient	getApiClient()
List<CatalogApplication>	listApplicationTargetsForApplicationAdministratorRoleForGroup(String groupId, String roleId, String after, Integer limit) List all Application Targets for an Application Administrator Role Lists all App targets for an `APP_ADMIN` Role assigned to a Group.
PagedList	listApplicationTargetsForApplicationAdministratorRoleForGroupWithPaginationInfo(String groupId, String roleId, String after, Integer limit) List all Application Targets for an Application Administrator Role Lists all App targets for an `APP_ADMIN` Role assigned to a Group.
List<CatalogApplication>	listApplicationTargetsForApplicationAdministratorRoleForUser(String userId, String roleId, String after, Integer limit) List all Application Targets for Application Administrator Role Lists all App targets for an `APP_ADMIN` Role assigned to a User.
PagedList	listApplicationTargetsForApplicationAdministratorRoleForUserWithPaginationInfo(String userId, String roleId, String after, Integer limit) List all Application Targets for Application Administrator Role Lists all App targets for an `APP_ADMIN` Role assigned to a User.
List<Group>	listGroupTargetsForGroupRole(String groupId, String roleId, String after, Integer limit) List all Group Targets for a Group Role Lists all group targets for a group role
PagedList	listGroupTargetsForGroupRoleWithPaginationInfo(String groupId, String roleId, String after, Integer limit) List all Group Targets for a Group Role Lists all group targets for a group role
List<Group>	listGroupTargetsForRole(String userId, String roleId, String after, Integer limit) List all Group Targets for Role Lists all group targets for role
PagedList	listGroupTargetsForRoleWithPaginationInfo(String userId, String roleId, String after, Integer limit) List all Group Targets for Role Lists all group targets for role
void	setApiClient(ApiClient apiClient)
void	unassignAppInstanceTargetFromAdminRoleForUser(String userId, String roleId, String appName, String applicationId) Unassign an Application Instance Target from an Application Administrator Role Unassigns an application instance target from an application administrator role
void	unassignAppInstanceTargetToAppAdminRoleForGroup(String groupId, String roleId, String appName, String applicationId) Unassign an Application Instance Target from an Application Administrator Role Unassigns an application instance target from application administrator role
void	unassignAppTargetFromAppAdminRoleForUser(String userId, String roleId, String appName) Unassign an Application Target from an Application Administrator Role Unassigns an application target from application administrator role
void	unassignAppTargetToAdminRoleForGroup(String groupId, String roleId, String appName) Unassign an Application Target from Application Administrator Role Unassigns an application target from application administrator role
void	unassignGroupTargetFromGroupAdminRole(String groupId, String roleId, String targetGroupId) Unassign a Group Target from a Group Role Unassigns a group target from a group role
void	unassignGroupTargetFromUserAdminRole(String userId, String roleId, String groupId) Unassign a Group Target from Role Unassigns a Group Target from Role

Methods inherited from class java.lang.Object

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

Constructor Detail

RoleTargetApi

public RoleTargetApi()

RoleTargetApi

@Autowired
public RoleTargetApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

assignAllAppsAsTargetToRoleForUser

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

Assign all Apps as Target to Role Assigns all Apps as Target to Role

200 - Success

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

assignAppInstanceTargetToAppAdminRoleForGroup

public void assignAppInstanceTargetToAppAdminRoleForGroup(String groupId,
                                                          String roleId,
                                                          String appName,
                                                          String applicationId)
                                                   throws org.springframework.web.client.RestClientException

Assign an Application Instance Target to Application Administrator Role Assigns App Instance Target to App Administrator Role given to a Group

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

roleId - (required)

appName - (required)

applicationId - (required)

Throws:

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

assignAppInstanceTargetToAppAdminRoleForUser

public void assignAppInstanceTargetToAppAdminRoleForUser(String userId,
                                                         String roleId,
                                                         String appName,
                                                         String applicationId)
                                                  throws org.springframework.web.client.RestClientException

Assign an Application Instance Target to an Application Administrator Role Assigns anapplication instance target to appplication administrator role

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

roleId - (required)

appName - (required)

applicationId - (required)

Throws:

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

assignAppTargetToAdminRoleForGroup

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

Assign an Application Target to Administrator Role Assigns an application target to administrator role

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

roleId - (required)

appName - (required)

Throws:

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

assignAppTargetToAdminRoleForUser

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

Assign an Application Target to Administrator Role Assigns an application target to administrator role

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

roleId - (required)

appName - (required)

Throws:

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

assignGroupTargetToGroupAdminRole

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

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

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

roleId - (required)

targetGroupId - (required)

Throws:

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

assignGroupTargetToUserRole

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

Assign a Group Target to Role Assigns a Group Target to Role

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

roleId - (required)

groupId - (required)

Throws:

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

listApplicationTargetsForApplicationAdministratorRoleForGroup

public List<CatalogApplication> listApplicationTargetsForApplicationAdministratorRoleForGroup(String groupId,
                                                                                              String roleId,
                                                                                              String after,
                                                                                              Integer limit)
                                                                                       throws org.springframework.web.client.RestClientException

List all Application Targets for an Application Administrator Role Lists all App targets for an `APP_ADMIN` Role assigned to a Group. This methods return list may include full Applications or Instances. The response for an instance will have an `ID` value, while Application will not have an ID.

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

roleId - (required)

after - (optional)

limit - (optional, default to 20)

Returns:

List<CatalogApplication>

Throws:

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

listApplicationTargetsForApplicationAdministratorRoleForGroupWithPaginationInfo

public PagedList listApplicationTargetsForApplicationAdministratorRoleForGroupWithPaginationInfo(String groupId,
                                                                                                 String roleId,
                                                                                                 String after,
                                                                                                 Integer limit)
                                                                                          throws org.springframework.web.client.RestClientException

List all Application Targets for an Application Administrator Role Lists all App targets for an `APP_ADMIN` Role assigned to a Group. This methods return list may include full Applications or Instances. The response for an instance will have an `ID` value, while Application will not have an ID.

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

roleId - (required)

after - (optional)

limit - (optional, default to 20)

Returns:

ResponseEntity<List<CatalogApplication>>

Throws:

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

listApplicationTargetsForApplicationAdministratorRoleForUser

public List<CatalogApplication> listApplicationTargetsForApplicationAdministratorRoleForUser(String userId,
                                                                                             String roleId,
                                                                                             String after,
                                                                                             Integer limit)
                                                                                      throws org.springframework.web.client.RestClientException

List all Application Targets for Application Administrator Role Lists all App targets for an `APP_ADMIN` Role assigned to a User. This methods return list may include full Applications or Instances. The response for an instance will have an `ID` value, while Application will not have an ID.

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

roleId - (required)

after - (optional)

limit - (optional, default to 20)

Returns:

List<CatalogApplication>

Throws:

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

listApplicationTargetsForApplicationAdministratorRoleForUserWithPaginationInfo

public PagedList listApplicationTargetsForApplicationAdministratorRoleForUserWithPaginationInfo(String userId,
                                                                                                String roleId,
                                                                                                String after,
                                                                                                Integer limit)
                                                                                         throws org.springframework.web.client.RestClientException

List all Application Targets for Application Administrator Role Lists all App targets for an `APP_ADMIN` Role assigned to a User. This methods return list may include full Applications or Instances. The response for an instance will have an `ID` value, while Application will not have an ID.

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

roleId - (required)

after - (optional)

limit - (optional, default to 20)

Returns:

ResponseEntity<List<CatalogApplication>>

Throws:

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

listGroupTargetsForGroupRole

public List<Group> listGroupTargetsForGroupRole(String groupId,
                                                String roleId,
                                                String after,
                                                Integer limit)
                                         throws org.springframework.web.client.RestClientException

List all Group Targets for a Group Role Lists all group targets for a group role

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

roleId - (required)

after - (optional)

limit - (optional, default to 20)

Returns:

List<Group>

Throws:

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

listGroupTargetsForGroupRoleWithPaginationInfo

public PagedList listGroupTargetsForGroupRoleWithPaginationInfo(String groupId,
                                                                String roleId,
                                                                String after,
                                                                Integer limit)
                                                         throws org.springframework.web.client.RestClientException

List all Group Targets for a Group Role Lists all group targets for a group role

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

roleId - (required)

after - (optional)

limit - (optional, default to 20)

Returns:

ResponseEntity<List<Group>>

Throws:

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

listGroupTargetsForRole

public List<Group> listGroupTargetsForRole(String userId,
                                           String roleId,
                                           String after,
                                           Integer limit)
                                    throws org.springframework.web.client.RestClientException

List all Group Targets for Role Lists all group targets for role

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

roleId - (required)

after - (optional)

limit - (optional, default to 20)

Returns:

List<Group>

Throws:

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

listGroupTargetsForRoleWithPaginationInfo

public PagedList listGroupTargetsForRoleWithPaginationInfo(String userId,
                                                           String roleId,
                                                           String after,
                                                           Integer limit)
                                                    throws org.springframework.web.client.RestClientException

List all Group Targets for Role Lists all group targets for role

200 - Success

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

roleId - (required)

after - (optional)

limit - (optional, default to 20)

Returns:

ResponseEntity<List<Group>>

Throws:

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

unassignAppInstanceTargetFromAdminRoleForUser

public void unassignAppInstanceTargetFromAdminRoleForUser(String userId,
                                                          String roleId,
                                                          String appName,
                                                          String applicationId)
                                                   throws org.springframework.web.client.RestClientException

Unassign an Application Instance Target from an Application Administrator Role Unassigns an application instance target from an application administrator role

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

roleId - (required)

appName - (required)

applicationId - (required)

Throws:

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

unassignAppInstanceTargetToAppAdminRoleForGroup

public void unassignAppInstanceTargetToAppAdminRoleForGroup(String groupId,
                                                            String roleId,
                                                            String appName,
                                                            String applicationId)
                                                     throws org.springframework.web.client.RestClientException

Unassign an Application Instance Target from an Application Administrator Role Unassigns an application instance target from application administrator role

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

roleId - (required)

appName - (required)

applicationId - (required)

Throws:

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

unassignAppTargetFromAppAdminRoleForUser

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

Unassign an Application Target from an Application Administrator Role Unassigns an application target from application administrator role

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

roleId - (required)

appName - (required)

Throws:

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

unassignAppTargetToAdminRoleForGroup

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

Unassign an Application Target from Application Administrator Role Unassigns an application target from application administrator role

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

roleId - (required)

appName - (required)

Throws:

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

unassignGroupTargetFromGroupAdminRole

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

Unassign a Group Target from a Group Role Unassigns a group target from a group role

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

groupId - (required)

roleId - (required)

targetGroupId - (required)

Throws:

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

unassignGroupTargetFromUserAdminRole

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

Unassign a Group Target from Role Unassigns a Group Target from Role

204 - No Content

403 - Forbidden

404 - Not Found

429 - Too Many Requests

Parameters:

userId - (required)

roleId - (required)

groupId - (required)

Throws:

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