Class RoleTargetApi

java.lang.Object
com.okta.sdk.resource.api.RoleTargetApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-06-17T07:49:15.347219-05:00[America/Chicago]", comments="Generator version: 7.5.0") public class RoleTargetApi extends Object
  • Constructor Details

    • RoleTargetApi

      public RoleTargetApi()
    • RoleTargetApi

      public RoleTargetApi(ApiClient apiClient)
  • Method Details

    • getApiClient

      public ApiClient getApiClient()
    • setApiClient

      public void setApiClient(ApiClient apiClient)
    • assignAllAppsAsTargetToRoleForUser

      public void assignAllAppsAsTargetToRoleForUser(String userId, String roleId) throws ApiException
      Assign all Apps as Target to Role Assigns all Apps as Target to Role
      Parameters:
      userId - (required)
      roleId - `id` of the Role (required)
      Throws:
      ApiException - if fails to make API call
    • assignAllAppsAsTargetToRoleForUser

      public void assignAllAppsAsTargetToRoleForUser(String userId, String roleId, Map<String,String> additionalHeaders) throws ApiException
      Assign all Apps as Target to Role Assigns all Apps as Target to Role
      Parameters:
      userId - (required)
      roleId - `id` of the Role (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call
    • assignAppInstanceTargetToAppAdminRoleForGroup

      public void assignAppInstanceTargetToAppAdminRoleForGroup(String groupId, String roleId, String appName, String appId) throws ApiException
      Assign an Application Instance Target to Application Administrator Role Assigns App Instance Target to App Administrator Role given to a Group
      Parameters:
      groupId - The `id` of the group (required)
      roleId - `id` of the Role (required)
      appName - (required)
      appId - ID of the Application (required)
      Throws:
      ApiException - if fails to make API call
    • assignAppInstanceTargetToAppAdminRoleForGroup

      public void assignAppInstanceTargetToAppAdminRoleForGroup(String groupId, String roleId, String appName, String appId, Map<String,String> additionalHeaders) throws ApiException
      Assign an Application Instance Target to Application Administrator Role Assigns App Instance Target to App Administrator Role given to a Group
      Parameters:
      groupId - The `id` of the group (required)
      roleId - `id` of the Role (required)
      appName - (required)
      appId - ID of the Application (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call
    • assignAppInstanceTargetToAppAdminRoleForUser

      public void assignAppInstanceTargetToAppAdminRoleForUser(String userId, String roleId, String appName, String appId) throws ApiException
      Assign an Application Instance Target to an Application Administrator Role Assigns anapplication instance target to appplication administrator role
      Parameters:
      userId - (required)
      roleId - `id` of the Role (required)
      appName - (required)
      appId - ID of the Application (required)
      Throws:
      ApiException - if fails to make API call
    • assignAppInstanceTargetToAppAdminRoleForUser

      public void assignAppInstanceTargetToAppAdminRoleForUser(String userId, String roleId, String appName, String appId, Map<String,String> additionalHeaders) throws ApiException
      Assign an Application Instance Target to an Application Administrator Role Assigns anapplication instance target to appplication administrator role
      Parameters:
      userId - (required)
      roleId - `id` of the Role (required)
      appName - (required)
      appId - ID of the Application (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call
    • assignAppTargetToAdminRoleForGroup

      public void assignAppTargetToAdminRoleForGroup(String groupId, String roleId, String appName) throws ApiException
      Assign an Application Target to Administrator Role Assigns an application target to administrator role
      Parameters:
      groupId - The `id` of the group (required)
      roleId - `id` of the Role (required)
      appName - (required)
      Throws:
      ApiException - if fails to make API call
    • assignAppTargetToAdminRoleForGroup

      public void assignAppTargetToAdminRoleForGroup(String groupId, String roleId, String appName, Map<String,String> additionalHeaders) throws ApiException
      Assign an Application Target to Administrator Role Assigns an application target to administrator role
      Parameters:
      groupId - The `id` of the group (required)
      roleId - `id` of the Role (required)
      appName - (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call
    • assignAppTargetToAdminRoleForUser

      public void assignAppTargetToAdminRoleForUser(String userId, String roleId, String appName) throws ApiException
      Assign an Application Target to Administrator Role Assigns an application target to administrator role
      Parameters:
      userId - (required)
      roleId - `id` of the Role (required)
      appName - (required)
      Throws:
      ApiException - if fails to make API call
    • assignAppTargetToAdminRoleForUser

      public void assignAppTargetToAdminRoleForUser(String userId, String roleId, String appName, Map<String,String> additionalHeaders) throws ApiException
      Assign an Application Target to Administrator Role Assigns an application target to administrator role
      Parameters:
      userId - (required)
      roleId - `id` of the Role (required)
      appName - (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call
    • assignGroupTargetToGroupAdminRole

      public void assignGroupTargetToGroupAdminRole(String groupId, String roleId, String targetGroupId) throws ApiException
      Assign a Group Target to a Group Role Assigns a group target to a group role
      Parameters:
      groupId - The `id` of the group (required)
      roleId - `id` of the Role (required)
      targetGroupId - (required)
      Throws:
      ApiException - if fails to make API call
    • assignGroupTargetToGroupAdminRole

      public void assignGroupTargetToGroupAdminRole(String groupId, String roleId, String targetGroupId, Map<String,String> additionalHeaders) throws ApiException
      Assign a Group Target to a Group Role Assigns a group target to a group role
      Parameters:
      groupId - The `id` of the group (required)
      roleId - `id` of the Role (required)
      targetGroupId - (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call
    • assignGroupTargetToUserRole

      public void assignGroupTargetToUserRole(String userId, String roleId, String groupId) throws ApiException
      Assign a Group Target to Role Assigns a Group Target to Role
      Parameters:
      userId - (required)
      roleId - `id` of the Role (required)
      groupId - The `id` of the group (required)
      Throws:
      ApiException - if fails to make API call
    • assignGroupTargetToUserRole

      public void assignGroupTargetToUserRole(String userId, String roleId, String groupId, Map<String,String> additionalHeaders) throws ApiException
      Assign a Group Target to Role Assigns a Group Target to Role
      Parameters:
      userId - (required)
      roleId - `id` of the Role (required)
      groupId - The `id` of the group (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call
    • listApplicationTargetsForApplicationAdministratorRoleForGroup

      public List<CatalogApplication> listApplicationTargetsForApplicationAdministratorRoleForGroup(String groupId, String roleId, String after, Integer limit) throws ApiException
      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.
      Parameters:
      groupId - The `id` of the group (required)
      roleId - `id` of the Role (required)
      after - (optional)
      limit - (optional, default to 20)
      Returns:
      List<CatalogApplication>
      Throws:
      ApiException - if fails to make API call
    • listApplicationTargetsForApplicationAdministratorRoleForGroup

      public List<CatalogApplication> listApplicationTargetsForApplicationAdministratorRoleForGroup(String groupId, String roleId, String after, Integer limit, Map<String,String> additionalHeaders) throws ApiException
      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.
      Parameters:
      groupId - The `id` of the group (required)
      roleId - `id` of the Role (required)
      after - (optional)
      limit - (optional, default to 20)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<CatalogApplication>
      Throws:
      ApiException - if fails to make API call
    • listApplicationTargetsForApplicationAdministratorRoleForUser

      public List<CatalogApplication> listApplicationTargetsForApplicationAdministratorRoleForUser(String userId, String roleId, String after, Integer limit) throws ApiException
      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.
      Parameters:
      userId - (required)
      roleId - `id` of the Role (required)
      after - (optional)
      limit - (optional, default to 20)
      Returns:
      List<CatalogApplication>
      Throws:
      ApiException - if fails to make API call
    • listApplicationTargetsForApplicationAdministratorRoleForUser

      public List<CatalogApplication> listApplicationTargetsForApplicationAdministratorRoleForUser(String userId, String roleId, String after, Integer limit, Map<String,String> additionalHeaders) throws ApiException
      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.
      Parameters:
      userId - (required)
      roleId - `id` of the Role (required)
      after - (optional)
      limit - (optional, default to 20)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<CatalogApplication>
      Throws:
      ApiException - if fails to make API call
    • listGroupTargetsForGroupRole

      public List<Group> listGroupTargetsForGroupRole(String groupId, String roleId, String after, Integer limit) throws ApiException
      List all Group Targets for a Group Role Lists all group targets for a group role
      Parameters:
      groupId - The `id` of the group (required)
      roleId - `id` of the Role (required)
      after - (optional)
      limit - (optional, default to 20)
      Returns:
      List<Group>
      Throws:
      ApiException - if fails to make API call
    • listGroupTargetsForGroupRole

      public List<Group> listGroupTargetsForGroupRole(String groupId, String roleId, String after, Integer limit, Map<String,String> additionalHeaders) throws ApiException
      List all Group Targets for a Group Role Lists all group targets for a group role
      Parameters:
      groupId - The `id` of the group (required)
      roleId - `id` of the Role (required)
      after - (optional)
      limit - (optional, default to 20)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<Group>
      Throws:
      ApiException - if fails to make API call
    • listGroupTargetsForRole

      public List<Group> listGroupTargetsForRole(String userId, String roleId, String after, Integer limit) throws ApiException
      List all Group Targets for Role Lists all group targets for role
      Parameters:
      userId - (required)
      roleId - `id` of the Role (required)
      after - (optional)
      limit - (optional, default to 20)
      Returns:
      List<Group>
      Throws:
      ApiException - if fails to make API call
    • listGroupTargetsForRole

      public List<Group> listGroupTargetsForRole(String userId, String roleId, String after, Integer limit, Map<String,String> additionalHeaders) throws ApiException
      List all Group Targets for Role Lists all group targets for role
      Parameters:
      userId - (required)
      roleId - `id` of the Role (required)
      after - (optional)
      limit - (optional, default to 20)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<Group>
      Throws:
      ApiException - if fails to make API call
    • unassignAppInstanceTargetFromAdminRoleForUser

      public void unassignAppInstanceTargetFromAdminRoleForUser(String userId, String roleId, String appName, String appId) throws ApiException
      Unassign an Application Instance Target from an Application Administrator Role Unassigns an application instance target from an application administrator role
      Parameters:
      userId - (required)
      roleId - `id` of the Role (required)
      appName - (required)
      appId - ID of the Application (required)
      Throws:
      ApiException - if fails to make API call
    • unassignAppInstanceTargetFromAdminRoleForUser

      public void unassignAppInstanceTargetFromAdminRoleForUser(String userId, String roleId, String appName, String appId, Map<String,String> additionalHeaders) throws ApiException
      Unassign an Application Instance Target from an Application Administrator Role Unassigns an application instance target from an application administrator role
      Parameters:
      userId - (required)
      roleId - `id` of the Role (required)
      appName - (required)
      appId - ID of the Application (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call
    • unassignAppInstanceTargetToAppAdminRoleForGroup

      public void unassignAppInstanceTargetToAppAdminRoleForGroup(String groupId, String roleId, String appName, String appId) throws ApiException
      Unassign an Application Instance Target from an Application Administrator Role Unassigns an application instance target from application administrator role
      Parameters:
      groupId - The `id` of the group (required)
      roleId - `id` of the Role (required)
      appName - (required)
      appId - ID of the Application (required)
      Throws:
      ApiException - if fails to make API call
    • unassignAppInstanceTargetToAppAdminRoleForGroup

      public void unassignAppInstanceTargetToAppAdminRoleForGroup(String groupId, String roleId, String appName, String appId, Map<String,String> additionalHeaders) throws ApiException
      Unassign an Application Instance Target from an Application Administrator Role Unassigns an application instance target from application administrator role
      Parameters:
      groupId - The `id` of the group (required)
      roleId - `id` of the Role (required)
      appName - (required)
      appId - ID of the Application (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call
    • unassignAppTargetFromAppAdminRoleForUser

      public void unassignAppTargetFromAppAdminRoleForUser(String userId, String roleId, String appName) throws ApiException
      Unassign an Application Target from an Application Administrator Role Unassigns an application target from application administrator role
      Parameters:
      userId - (required)
      roleId - `id` of the Role (required)
      appName - (required)
      Throws:
      ApiException - if fails to make API call
    • unassignAppTargetFromAppAdminRoleForUser

      public void unassignAppTargetFromAppAdminRoleForUser(String userId, String roleId, String appName, Map<String,String> additionalHeaders) throws ApiException
      Unassign an Application Target from an Application Administrator Role Unassigns an application target from application administrator role
      Parameters:
      userId - (required)
      roleId - `id` of the Role (required)
      appName - (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call
    • unassignAppTargetToAdminRoleForGroup

      public void unassignAppTargetToAdminRoleForGroup(String groupId, String roleId, String appName) throws ApiException
      Unassign an Application Target from Application Administrator Role Unassigns an application target from application administrator role
      Parameters:
      groupId - The `id` of the group (required)
      roleId - `id` of the Role (required)
      appName - (required)
      Throws:
      ApiException - if fails to make API call
    • unassignAppTargetToAdminRoleForGroup

      public void unassignAppTargetToAdminRoleForGroup(String groupId, String roleId, String appName, Map<String,String> additionalHeaders) throws ApiException
      Unassign an Application Target from Application Administrator Role Unassigns an application target from application administrator role
      Parameters:
      groupId - The `id` of the group (required)
      roleId - `id` of the Role (required)
      appName - (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call
    • unassignGroupTargetFromGroupAdminRole

      public void unassignGroupTargetFromGroupAdminRole(String groupId, String roleId, String targetGroupId) throws ApiException
      Unassign a Group Target from a Group Role Unassigns a group target from a group role
      Parameters:
      groupId - The `id` of the group (required)
      roleId - `id` of the Role (required)
      targetGroupId - (required)
      Throws:
      ApiException - if fails to make API call
    • unassignGroupTargetFromGroupAdminRole

      public void unassignGroupTargetFromGroupAdminRole(String groupId, String roleId, String targetGroupId, Map<String,String> additionalHeaders) throws ApiException
      Unassign a Group Target from a Group Role Unassigns a group target from a group role
      Parameters:
      groupId - The `id` of the group (required)
      roleId - `id` of the Role (required)
      targetGroupId - (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call
    • unassignGroupTargetFromUserAdminRole

      public void unassignGroupTargetFromUserAdminRole(String userId, String roleId, String groupId) throws ApiException
      Unassign a Group Target from Role Unassigns a Group Target from Role
      Parameters:
      userId - (required)
      roleId - `id` of the Role (required)
      groupId - The `id` of the group (required)
      Throws:
      ApiException - if fails to make API call
    • unassignGroupTargetFromUserAdminRole

      public void unassignGroupTargetFromUserAdminRole(String userId, String roleId, String groupId, Map<String,String> additionalHeaders) throws ApiException
      Unassign a Group Target from Role Unassigns a Group Target from Role
      Parameters:
      userId - (required)
      roleId - `id` of the Role (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()