Package com.okta.sdk.resource.api

Class RoleBTargetBGroupApi

java.lang.Object
com.okta.sdk.resource.api.RoleBTargetBGroupApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2024-09-23T16:19:57.008753975Z[Etc/UTC]", comments="Generator version: 7.8.0") public class RoleBTargetBGroupApi extends Object

  • Constructor Details

    • RoleBTargetBGroupApi

      public RoleBTargetBGroupApi()

    • RoleBTargetBGroupApi

      public RoleBTargetBGroupApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • assignAppInstanceTargetToAppAdminRoleForGroup

      public void assignAppInstanceTargetToAppAdminRoleForGroup(String groupId, String roleAssignmentId, String appName, String appId) throws ApiException
      Assign an Group Role Application Instance Target Assigns an app instance target to an `APP_ADMIN` Role Assignment to a Group. When you assign the first OIN app or app instance target, you reduce the scope of the Role Assignment. The Role no longer applies to all app targets, but applies only to the specified target. > **Note:** You can target a mixture of both OIN app and app instance targets, but you can't assign permissions to manage all instances of an OIN app and then assign a subset of permissions to the same app. For example, you can't specify that an admin has access to manage all instances of the Salesforce app and then also manage specific configurations of the Salesforce app.
      Parameters:
      groupId - The `id` of the group (required)
      roleAssignmentId - The `id` of the Role Assignment (required)
      appName - Application name for the app type (required)
      appId - Application ID (required)
      Throws:
      ApiException - if fails to make API call

    • assignAppInstanceTargetToAppAdminRoleForGroup

      public void assignAppInstanceTargetToAppAdminRoleForGroup(String groupId, String roleAssignmentId, String appName, String appId, Map<String,String> additionalHeaders) throws ApiException
      Assign an Group Role Application Instance Target Assigns an app instance target to an `APP_ADMIN` Role Assignment to a Group. When you assign the first OIN app or app instance target, you reduce the scope of the Role Assignment. The Role no longer applies to all app targets, but applies only to the specified target. > **Note:** You can target a mixture of both OIN app and app instance targets, but you can't assign permissions to manage all instances of an OIN app and then assign a subset of permissions to the same app. For example, you can't specify that an admin has access to manage all instances of the Salesforce app and then also manage specific configurations of the Salesforce app.
      Parameters:
      groupId - The `id` of the group (required)
      roleAssignmentId - The `id` of the Role Assignment (required)
      appName - Application name for the app type (required)
      appId - Application ID (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • assignAppTargetToAdminRoleForGroup

      public void assignAppTargetToAdminRoleForGroup(String groupId, String roleAssignmentId, String appName) throws ApiException
      Assign an Group Role Application Target Assigns an OIN app target to an `APP_ADMIN` Role Assignment to a Group. When you assign the first OIN app target, you reduce the scope of the Role Assignment. The Role no longer applies to all app targets but applies only to the specified target. An OIN app target that's assigned to the Role overrides any existing instance targets of the OIN app. For example, if a user is assigned to administer a specific Facebook instance, a successful request to add an OIN app with `facebook` for `appName` makes that user the administrator for all Facebook instances.
      Parameters:
      groupId - The `id` of the group (required)
      roleAssignmentId - The `id` of the Role Assignment (required)
      appName - Application name for the app type (required)
      Throws:
      ApiException - if fails to make API call

    • assignAppTargetToAdminRoleForGroup

      public void assignAppTargetToAdminRoleForGroup(String groupId, String roleAssignmentId, String appName, Map<String,String> additionalHeaders) throws ApiException
      Assign an Group Role Application Target Assigns an OIN app target to an `APP_ADMIN` Role Assignment to a Group. When you assign the first OIN app target, you reduce the scope of the Role Assignment. The Role no longer applies to all app targets but applies only to the specified target. An OIN app target that's assigned to the Role overrides any existing instance targets of the OIN app. For example, if a user is assigned to administer a specific Facebook instance, a successful request to add an OIN app with `facebook` for `appName` makes that user the administrator for all Facebook instances.
      Parameters:
      groupId - The `id` of the group (required)
      roleAssignmentId - The `id` of the Role Assignment (required)
      appName - Application name for the app type (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • assignGroupTargetToGroupAdminRole

      public void assignGroupTargetToGroupAdminRole(String groupId, String roleAssignmentId, String targetGroupId) throws ApiException
      Assign a Group Role Group Target Assigns a Group target to a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a Group. When you assign the first Group target, you reduce the scope of the Role Assignment. The Role no longer applies to all targets but applies only to the specified target.
      Parameters:
      groupId - The `id` of the group (required)
      roleAssignmentId - The `id` of the Role Assignment (required)
      targetGroupId - (required)
      Throws:
      ApiException - if fails to make API call

    • assignGroupTargetToGroupAdminRole

      public void assignGroupTargetToGroupAdminRole(String groupId, String roleAssignmentId, String targetGroupId, Map<String,String> additionalHeaders) throws ApiException
      Assign a Group Role Group Target Assigns a Group target to a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a Group. When you assign the first Group target, you reduce the scope of the Role Assignment. The Role no longer applies to all targets but applies only to the specified target.
      Parameters:
      groupId - The `id` of the group (required)
      roleAssignmentId - The `id` of the Role Assignment (required)
      targetGroupId - (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • listApplicationTargetsForApplicationAdministratorRoleForGroup

      public List<CatalogApplication> listApplicationTargetsForApplicationAdministratorRoleForGroup(String groupId, String roleAssignmentId, String after, Integer limit) throws ApiException
      List all Group Role Application Targets Lists all app targets for an `APP_ADMIN` Role Assignment to a Group. The response includes a list of OIN-cataloged apps or app instances. The response payload for an app instance contains the `id` property, but an OIN-cataloged app doesn't.
      Parameters:
      groupId - The `id` of the group (required)
      roleAssignmentId - The `id` of the Role Assignment (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 roleAssignmentId, String after, Integer limit, Map<String,String> additionalHeaders) throws ApiException
      List all Group Role Application Targets Lists all app targets for an `APP_ADMIN` Role Assignment to a Group. The response includes a list of OIN-cataloged apps or app instances. The response payload for an app instance contains the `id` property, but an OIN-cataloged app doesn't.
      Parameters:
      groupId - The `id` of the group (required)
      roleAssignmentId - The `id` of the Role Assignment (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 roleAssignmentId, String after, Integer limit) throws ApiException
      List all Group Role Group Targets Lists all Group targets for a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a Group. If the Role isn't scoped to specific Group targets, an empty array `[]` is returned.
      Parameters:
      groupId - The `id` of the group (required)
      roleAssignmentId - The `id` of the Role Assignment (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 roleAssignmentId, String after, Integer limit, Map<String,String> additionalHeaders) throws ApiException
      List all Group Role Group Targets Lists all Group targets for a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a Group. If the Role isn't scoped to specific Group targets, an empty array `[]` is returned.
      Parameters:
      groupId - The `id` of the group (required)
      roleAssignmentId - The `id` of the Role Assignment (required)
      after - (optional)
      limit - (optional, default to 20)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<Group>
      Throws:
      ApiException - if fails to make API call

    • unassignAppInstanceTargetToAppAdminRoleForGroup

      public void unassignAppInstanceTargetToAppAdminRoleForGroup(String groupId, String roleAssignmentId, String appName, String appId) throws ApiException
      Unassign an Group Role Application Instance Target Unassigns an app instance target from an `APP_ADMIN` Role Assignment to a Group > **Note:** You can't remove the last app instance target from a Role Assignment since this causes an exception. > If you need a Role Assignment that applies to all apps, delete the `APP_ADMIN` Role Assignment and recreate a new one. See [Unassign a Group Role](/openapi/okta-management/management/tag/RoleAssignmentBGroup/#tag/RoleAssignmentBGroup/operation/unassignRoleFromGroup).
      Parameters:
      groupId - The `id` of the group (required)
      roleAssignmentId - The `id` of the Role Assignment (required)
      appName - Application name for the app type (required)
      appId - Application ID (required)
      Throws:
      ApiException - if fails to make API call

    • unassignAppInstanceTargetToAppAdminRoleForGroup

      public void unassignAppInstanceTargetToAppAdminRoleForGroup(String groupId, String roleAssignmentId, String appName, String appId, Map<String,String> additionalHeaders) throws ApiException
      Unassign an Group Role Application Instance Target Unassigns an app instance target from an `APP_ADMIN` Role Assignment to a Group > **Note:** You can't remove the last app instance target from a Role Assignment since this causes an exception. > If you need a Role Assignment that applies to all apps, delete the `APP_ADMIN` Role Assignment and recreate a new one. See [Unassign a Group Role](/openapi/okta-management/management/tag/RoleAssignmentBGroup/#tag/RoleAssignmentBGroup/operation/unassignRoleFromGroup).
      Parameters:
      groupId - The `id` of the group (required)
      roleAssignmentId - The `id` of the Role Assignment (required)
      appName - Application name for the app type (required)
      appId - Application ID (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • unassignAppTargetToAdminRoleForGroup

      public void unassignAppTargetToAdminRoleForGroup(String groupId, String roleAssignmentId, String appName) throws ApiException
      Unassign a Group Role Application Target Unassigns an OIN app target from an `APP_ADMIN` Role Assignment to a Group > **Note:** You can't remove the last app target from a Role Assignment, since this causes an exception. > If you need a Role Assignment that applies to all apps, delete the `APP_ADMIN` Role Assignment and recreate a new one. See [Unassign a Group Role](/openapi/okta-management/management/tag/RoleAssignmentBGroup/#tag/RoleAssignmentBGroup/operation/unassignRoleFromGroup).
      Parameters:
      groupId - The `id` of the group (required)
      roleAssignmentId - The `id` of the Role Assignment (required)
      appName - Application name for the app type (required)
      Throws:
      ApiException - if fails to make API call

    • unassignAppTargetToAdminRoleForGroup

      public void unassignAppTargetToAdminRoleForGroup(String groupId, String roleAssignmentId, String appName, Map<String,String> additionalHeaders) throws ApiException
      Unassign a Group Role Application Target Unassigns an OIN app target from an `APP_ADMIN` Role Assignment to a Group > **Note:** You can't remove the last app target from a Role Assignment, since this causes an exception. > If you need a Role Assignment that applies to all apps, delete the `APP_ADMIN` Role Assignment and recreate a new one. See [Unassign a Group Role](/openapi/okta-management/management/tag/RoleAssignmentBGroup/#tag/RoleAssignmentBGroup/operation/unassignRoleFromGroup).
      Parameters:
      groupId - The `id` of the group (required)
      roleAssignmentId - The `id` of the Role Assignment (required)
      appName - Application name for the app type (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • unassignGroupTargetFromGroupAdminRole

      public void unassignGroupTargetFromGroupAdminRole(String groupId, String roleAssignmentId, String targetGroupId) throws ApiException
      Unassign a Group Role Group Target Unassigns a Group target from a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a Group.
      Parameters:
      groupId - The `id` of the group (required)
      roleAssignmentId - The `id` of the Role Assignment (required)
      targetGroupId - (required)
      Throws:
      ApiException - if fails to make API call

    • unassignGroupTargetFromGroupAdminRole

      public void unassignGroupTargetFromGroupAdminRole(String groupId, String roleAssignmentId, String targetGroupId, Map<String,String> additionalHeaders) throws ApiException
      Unassign a Group Role Group Target Unassigns a Group target from a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a Group.
      Parameters:
      groupId - The `id` of the group (required)
      roleAssignmentId - The `id` of the Role Assignment (required)
      targetGroupId - (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getObjectMapper

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