Package com.okta.sdk.resource.api

Class RoleBTargetAdminApi

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

  • Constructor Details

    • RoleBTargetAdminApi

      public RoleBTargetAdminApi()

    • RoleBTargetAdminApi

      public RoleBTargetAdminApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • assignAllAppsAsTargetToRoleForUser

      public void assignAllAppsAsTargetToRoleForUser(String userId, String roleAssignmentId) throws ApiException
      Assign all Apps as Target to Role Assigns all Apps as Target to Role
      Parameters:
      userId - ID of an existing Okta user (required)
      roleAssignmentId - The `id` of the Role Assignment (required)
      Throws:
      ApiException - if fails to make API call

    • assignAllAppsAsTargetToRoleForUser

      public void assignAllAppsAsTargetToRoleForUser(String userId, String roleAssignmentId, Map<String,String> additionalHeaders) throws ApiException
      Assign all Apps as Target to Role Assigns all Apps as Target to Role
      Parameters:
      userId - ID of an existing Okta user (required)
      roleAssignmentId - The `id` of the Role Assignment (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • assignAppInstanceTargetToAppAdminRoleForUser

      public void assignAppInstanceTargetToAppAdminRoleForUser(String userId, String roleAssignmentId, String appName, String appId) throws ApiException
      Assign an Admin Role Application Instance Target Assigns an app instance target to an `APP_ADMIN` Role Assignment to an admin User. 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 can't assign permissions to manage all instances of an OIN app and then assign a subset of permission to the same OIN 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:
      userId - ID of an existing Okta user (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

    • assignAppInstanceTargetToAppAdminRoleForUser

      public void assignAppInstanceTargetToAppAdminRoleForUser(String userId, String roleAssignmentId, String appName, String appId, Map<String,String> additionalHeaders) throws ApiException
      Assign an Admin Role Application Instance Target Assigns an app instance target to an `APP_ADMIN` Role Assignment to an admin User. 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 can't assign permissions to manage all instances of an OIN app and then assign a subset of permission to the same OIN 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:
      userId - ID of an existing Okta user (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

    • assignAppTargetToAdminRoleForUser

      public void assignAppTargetToAdminRoleForUser(String userId, String roleAssignmentId, String appName) throws ApiException
      Assign an Admin Role Application Target Assigns an OIN app target for an `APP_ADMIN` Role Assignment to an admin User. When you assign the first 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. Assigning an OIN app target overrides any existing app instance targets of the OIN app. For example, if a user was assigned to administer a specific Facebook instance, a successful request to add an OIN app target with `facebook` for `appName` makes that user the administrator for all Facebook instances.
      Parameters:
      userId - ID of an existing Okta user (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

    • assignAppTargetToAdminRoleForUser

      public void assignAppTargetToAdminRoleForUser(String userId, String roleAssignmentId, String appName, Map<String,String> additionalHeaders) throws ApiException
      Assign an Admin Role Application Target Assigns an OIN app target for an `APP_ADMIN` Role Assignment to an admin User. When you assign the first 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. Assigning an OIN app target overrides any existing app instance targets of the OIN app. For example, if a user was assigned to administer a specific Facebook instance, a successful request to add an OIN app target with `facebook` for `appName` makes that user the administrator for all Facebook instances.
      Parameters:
      userId - ID of an existing Okta user (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

    • assignGroupTargetToUserRole

      public void assignGroupTargetToUserRole(String userId, String roleAssignmentId, String groupId) throws ApiException
      Assign an Admin Role Group Target Assigns a Group target for a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to an admin User. 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:
      userId - ID of an existing Okta user (required)
      roleAssignmentId - The `id` of the Role Assignment (required)
      groupId - The `id` of the group (required)
      Throws:
      ApiException - if fails to make API call

    • assignGroupTargetToUserRole

      public void assignGroupTargetToUserRole(String userId, String roleAssignmentId, String groupId, Map<String,String> additionalHeaders) throws ApiException
      Assign an Admin Role Group Target Assigns a Group target for a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to an admin User. 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:
      userId - ID of an existing Okta user (required)
      roleAssignmentId - The `id` of the Role Assignment (required)
      groupId - The `id` of the group (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • listApplicationTargetsForApplicationAdministratorRoleForUser

      public List<CatalogApplication> listApplicationTargetsForApplicationAdministratorRoleForUser(String userId, String roleAssignmentId, String after, Integer limit) throws ApiException
      List all Admin Role Application Targets Lists all app targets for an `APP_ADMIN` Role Assigned to a User. The response is a list that includes OIN-cataloged apps or app instances. The response payload for an app instance contains the `id` property, but an OIN-cataloged app payload doesn't.
      Parameters:
      userId - ID of an existing Okta user (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

    • listApplicationTargetsForApplicationAdministratorRoleForUser

      public List<CatalogApplication> listApplicationTargetsForApplicationAdministratorRoleForUser(String userId, String roleAssignmentId, String after, Integer limit, Map<String,String> additionalHeaders) throws ApiException
      List all Admin Role Application Targets Lists all app targets for an `APP_ADMIN` Role Assigned to a User. The response is a list that includes OIN-cataloged apps or app instances. The response payload for an app instance contains the `id` property, but an OIN-cataloged app payload doesn't.
      Parameters:
      userId - ID of an existing Okta user (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

    • listGroupTargetsForRole

      public List<Group> listGroupTargetsForRole(String userId, String roleAssignmentId, String after, Integer limit) throws ApiException
      List all Admin Role Group Targets Lists all Group targets for a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to an admin User. If the Role isn't scoped to specific Group targets, an empty array `[]` is returned.
      Parameters:
      userId - ID of an existing Okta user (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

    • listGroupTargetsForRole

      public List<Group> listGroupTargetsForRole(String userId, String roleAssignmentId, String after, Integer limit, Map<String,String> additionalHeaders) throws ApiException
      List all Admin Role Group Targets Lists all Group targets for a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to an admin User. If the Role isn't scoped to specific Group targets, an empty array `[]` is returned.
      Parameters:
      userId - ID of an existing Okta user (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

    • unassignAppInstanceTargetFromAdminRoleForUser

      public void unassignAppInstanceTargetFromAdminRoleForUser(String userId, String roleAssignmentId, String appName, String appId) throws ApiException
      Unassign an Admin Role Application Instance Target Unassigns an app instance target from an `APP_ADMIN` Role Assignment to an admin User. > **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.
      Parameters:
      userId - ID of an existing Okta user (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

    • unassignAppInstanceTargetFromAdminRoleForUser

      public void unassignAppInstanceTargetFromAdminRoleForUser(String userId, String roleAssignmentId, String appName, String appId, Map<String,String> additionalHeaders) throws ApiException
      Unassign an Admin Role Application Instance Target Unassigns an app instance target from an `APP_ADMIN` Role Assignment to an admin User. > **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.
      Parameters:
      userId - ID of an existing Okta user (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

    • unassignAppTargetFromAppAdminRoleForUser

      public void unassignAppTargetFromAppAdminRoleForUser(String userId, String roleAssignmentId, String appName) throws ApiException
      Unassign an Admin Role Application Target Unassigns an OIN app target from an `APP_ADMIN` Role Assignment to an admin User. > **Note:** You can't remove the last OIN 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 to the User and recreate a new one.
      Parameters:
      userId - ID of an existing Okta user (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

    • unassignAppTargetFromAppAdminRoleForUser

      public void unassignAppTargetFromAppAdminRoleForUser(String userId, String roleAssignmentId, String appName, Map<String,String> additionalHeaders) throws ApiException
      Unassign an Admin Role Application Target Unassigns an OIN app target from an `APP_ADMIN` Role Assignment to an admin User. > **Note:** You can't remove the last OIN 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 to the User and recreate a new one.
      Parameters:
      userId - ID of an existing Okta user (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

    • unassignGroupTargetFromUserAdminRole

      public void unassignGroupTargetFromUserAdminRole(String userId, String roleAssignmentId, String groupId) throws ApiException
      Unassign an Admin Role Group Target Unassigns a Group target from a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to an admin User. > **Note:** You can't remove the last Group target from a Role Assignment since this causes an exception. > If you need a Role Assignment that applies to all Groups, delete the Role Assignment to the User and recreate a new one.
      Parameters:
      userId - ID of an existing Okta user (required)
      roleAssignmentId - The `id` of the Role Assignment (required)
      groupId - The `id` of the group (required)
      Throws:
      ApiException - if fails to make API call

    • unassignGroupTargetFromUserAdminRole

      public void unassignGroupTargetFromUserAdminRole(String userId, String roleAssignmentId, String groupId, Map<String,String> additionalHeaders) throws ApiException
      Unassign an Admin Role Group Target Unassigns a Group target from a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to an admin User. > **Note:** You can't remove the last Group target from a Role Assignment since this causes an exception. > If you need a Role Assignment that applies to all Groups, delete the Role Assignment to the User and recreate a new one.
      Parameters:
      userId - ID of an existing Okta user (required)
      roleAssignmentId - The `id` of the Role Assignment (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()