Package com.okta.sdk.resource.api

Class RoleBTargetClientApi

java.lang.Object
com.okta.sdk.resource.api.RoleBTargetClientApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", date="2026-03-13T17:36:05.533634+05:30[Asia/Kolkata]", comments="Generator version: 7.15.0") public class RoleBTargetClientApi extends Object

  • Constructor Details

    • RoleBTargetClientApi

      public RoleBTargetClientApi()

    • RoleBTargetClientApi

      public RoleBTargetClientApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • assignAppTargetInstanceRoleForClient

      public void assignAppTargetInstanceRoleForClient(String clientId, String roleAssignmentId, String appName, String appId) throws ApiException
      Assign a client role app instance target Assigns an app instance target to an `APP_ADMIN` role assignment to a client. 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 only specific configurations of the Salesforce app.
      Parameters:
      clientId - `client_id` of the app (required)
      roleAssignmentId - The `id` of the role assignment (required)
      appName - Name of the app definition (the OIN catalog app key name) (required)
      appId - Application ID (required)
      Throws:
      ApiException - if fails to make API call

    • assignAppTargetInstanceRoleForClient

      public void assignAppTargetInstanceRoleForClient(String clientId, String roleAssignmentId, String appName, String appId, Map<String,String> additionalHeaders) throws ApiException
      Assign a client role app instance target Assigns an app instance target to an `APP_ADMIN` role assignment to a client. 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 only specific configurations of the Salesforce app.
      Parameters:
      clientId - `client_id` of the app (required)
      roleAssignmentId - The `id` of the role assignment (required)
      appName - Name of the app definition (the OIN catalog app key name) (required)
      appId - Application ID (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • assignAppTargetRoleToClient

      public void assignAppTargetRoleToClient(String clientId, String roleAssignmentId, String appName) throws ApiException
      Assign a client role app target Assigns an OIN app target for an `APP_ADMIN` role assignment to a client. When you assign an app target from the OIN catalog, you reduce the scope of the role assignment. The role assignment applies to only app instances that are included in the specified OIN app target. An assigned OIN app target overrides any existing app instance targets. For example, if a user is 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:
      clientId - `client_id` of the app (required)
      roleAssignmentId - The `id` of the role assignment (required)
      appName - Name of the app definition (the OIN catalog app key name) (required)
      Throws:
      ApiException - if fails to make API call

    • assignAppTargetRoleToClient

      public void assignAppTargetRoleToClient(String clientId, String roleAssignmentId, String appName, Map<String,String> additionalHeaders) throws ApiException
      Assign a client role app target Assigns an OIN app target for an `APP_ADMIN` role assignment to a client. When you assign an app target from the OIN catalog, you reduce the scope of the role assignment. The role assignment applies to only app instances that are included in the specified OIN app target. An assigned OIN app target overrides any existing app instance targets. For example, if a user is 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:
      clientId - `client_id` of the app (required)
      roleAssignmentId - The `id` of the role assignment (required)
      appName - Name of the app definition (the OIN catalog app key name) (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • assignGroupTargetRoleForClient

      public void assignGroupTargetRoleForClient(String clientId, String roleAssignmentId, String groupId) throws ApiException
      Assign a client role group target Assigns a group target to a [`USER_ADMIN`](/openapi/okta-management/guides/roles/#standard-roles), `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` role assignment to a client app. 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:
      clientId - `client_id` of the app (required)
      roleAssignmentId - The `id` of the role assignment (required)
      groupId - The `id` of the group (required)
      Throws:
      ApiException - if fails to make API call

    • assignGroupTargetRoleForClient

      public void assignGroupTargetRoleForClient(String clientId, String roleAssignmentId, String groupId, Map<String,String> additionalHeaders) throws ApiException
      Assign a client role group target Assigns a group target to a [`USER_ADMIN`](/openapi/okta-management/guides/roles/#standard-roles), `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` role assignment to a client app. 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:
      clientId - `client_id` of the app (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

    • listAppTargetRoleToClient

      public List<CatalogApplication> listAppTargetRoleToClient(String clientId, String roleAssignmentId, String after, Integer limit) throws ApiException
      List all client role app targets Lists all OIN app targets for an `APP_ADMIN` role that's assigned to a client (by `clientId`).
      Parameters:
      clientId - `client_id` of the app (required)
      roleAssignmentId - The `id` of the role assignment (required)
      after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header). (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      Returns:
      List<CatalogApplication>
      Throws:
      ApiException - if fails to make API call

    • listAppTargetRoleToClient

      public List<CatalogApplication> listAppTargetRoleToClient(String clientId, String roleAssignmentId, String after, Integer limit, Map<String,String> additionalHeaders) throws ApiException
      List all client role app targets Lists all OIN app targets for an `APP_ADMIN` role that's assigned to a client (by `clientId`).
      Parameters:
      clientId - `client_id` of the app (required)
      roleAssignmentId - The `id` of the role assignment (required)
      after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header). (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<CatalogApplication>
      Throws:
      ApiException - if fails to make API call

    • listAppTargetRoleToClientPaged

      public Iterable<CatalogApplication> listAppTargetRoleToClientPaged(String clientId, String roleAssignmentId, String after, Integer limit)
      List all client role app targets (Paginated) Lists all OIN app targets for an `APP_ADMIN` role that's assigned to a client (by `clientId`). This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks. Use this method in a for-each loop to automatically fetch all pages without manual cursor management.
      Parameters:
      clientId - `client_id` of the app (required)
      roleAssignmentId - The `id` of the role assignment (required)
      after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header). (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      Returns:
      Iterable<CatalogApplication> lazy iterable over all pages

    • listAppTargetRoleToClientPaged

      public Iterable<CatalogApplication> listAppTargetRoleToClientPaged(String clientId, String roleAssignmentId, String after, Integer limit, Map<String,String> additionalHeaders)
      List all client role app targets (Paginated with additional headers) Lists all OIN app targets for an `APP_ADMIN` role that's assigned to a client (by `clientId`). This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.
      Parameters:
      clientId - `client_id` of the app (required)
      roleAssignmentId - The `id` of the role assignment (required)
      after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header). (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      additionalHeaders - additional headers for this call
      Returns:
      Iterable<CatalogApplication> lazy iterable over all pages

    • listGroupTargetRoleForClient

      public List<Group> listGroupTargetRoleForClient(String clientId, String roleAssignmentId, String after, Integer limit) throws ApiException
      List all client role group targets Lists all group targets for a [`USER_ADMIN`](/openapi/okta-management/guides/roles/#standard-roles), `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` role assignment to a client. If the role isn't scoped to specific group targets, Okta returns an empty array `[]`.
      Parameters:
      clientId - `client_id` of the app (required)
      roleAssignmentId - The `id` of the role assignment (required)
      after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header). (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      Returns:
      List<Group>
      Throws:
      ApiException - if fails to make API call

    • listGroupTargetRoleForClient

      public List<Group> listGroupTargetRoleForClient(String clientId, String roleAssignmentId, String after, Integer limit, Map<String,String> additionalHeaders) throws ApiException
      List all client role group targets Lists all group targets for a [`USER_ADMIN`](/openapi/okta-management/guides/roles/#standard-roles), `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` role assignment to a client. If the role isn't scoped to specific group targets, Okta returns an empty array `[]`.
      Parameters:
      clientId - `client_id` of the app (required)
      roleAssignmentId - The `id` of the role assignment (required)
      after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header). (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<Group>
      Throws:
      ApiException - if fails to make API call

    • listGroupTargetRoleForClientPaged

      public Iterable<Group> listGroupTargetRoleForClientPaged(String clientId, String roleAssignmentId, String after, Integer limit)
      List all client role group targets (Paginated) Lists all group targets for a [`USER_ADMIN`](/openapi/okta-management/guides/roles/#standard-roles), `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` role assignment to a client. If the role isn't scoped to specific group targets, Okta returns an empty array `[]`. This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks. Use this method in a for-each loop to automatically fetch all pages without manual cursor management.
      Parameters:
      clientId - `client_id` of the app (required)
      roleAssignmentId - The `id` of the role assignment (required)
      after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header). (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      Returns:
      Iterable<Group> lazy iterable over all pages

    • listGroupTargetRoleForClientPaged

      public Iterable<Group> listGroupTargetRoleForClientPaged(String clientId, String roleAssignmentId, String after, Integer limit, Map<String,String> additionalHeaders)
      List all client role group targets (Paginated with additional headers) Lists all group targets for a [`USER_ADMIN`](/openapi/okta-management/guides/roles/#standard-roles), `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` role assignment to a client. If the role isn't scoped to specific group targets, Okta returns an empty array `[]`. This method returns a lazy, paginated iterable that automatically handles pagination. It is thread-safe and does not cause memory leaks.
      Parameters:
      clientId - `client_id` of the app (required)
      roleAssignmentId - The `id` of the role assignment (required)
      after - The cursor to use for pagination. It is an opaque string that specifies your current location in the list and is obtained from the `Link` response header. See [Pagination](https://developer.okta.com/docs/api/#pagination) and [Link header](https://developer.okta.com/docs/api/#link-header). (optional)
      limit - A limit on the number of objects to return (optional, default to 20)
      additionalHeaders - additional headers for this call
      Returns:
      Iterable<Group> lazy iterable over all pages

    • removeAppTargetInstanceRoleForClient

      public void removeAppTargetInstanceRoleForClient(String clientId, String roleAssignmentId, String appName, String appId) throws ApiException
      Unassign a client role app instance target Unassigns an app instance target from a role assignment to a client app > **Note:** You can't remove the last app instance target from a role assignment. > If you need a role assignment that applies to all the apps, delete the role assignment with the instance target and create another one. See [Unassign a client role](/openapi/okta-management/management/tag/RoleAssignmentClient/#tag/RoleAssignmentClient/operation/deleteRoleFromClient).
      Parameters:
      clientId - `client_id` of the app (required)
      roleAssignmentId - The `id` of the role assignment (required)
      appName - Name of the app definition (the OIN catalog app key name) (required)
      appId - Application ID (required)
      Throws:
      ApiException - if fails to make API call

    • removeAppTargetInstanceRoleForClient

      public void removeAppTargetInstanceRoleForClient(String clientId, String roleAssignmentId, String appName, String appId, Map<String,String> additionalHeaders) throws ApiException
      Unassign a client role app instance target Unassigns an app instance target from a role assignment to a client app > **Note:** You can't remove the last app instance target from a role assignment. > If you need a role assignment that applies to all the apps, delete the role assignment with the instance target and create another one. See [Unassign a client role](/openapi/okta-management/management/tag/RoleAssignmentClient/#tag/RoleAssignmentClient/operation/deleteRoleFromClient).
      Parameters:
      clientId - `client_id` of the app (required)
      roleAssignmentId - The `id` of the role assignment (required)
      appName - Name of the app definition (the OIN catalog app key name) (required)
      appId - Application ID (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • removeAppTargetRoleFromClient

      public void removeAppTargetRoleFromClient(String clientId, String roleAssignmentId, String appName) throws ApiException
      Unassign a client role app target Unassigns an OIN app target for a role assignment to a client app > **Note:** You can't remove the last OIN app target from a role assignment. > If you need a role assignment that applies to all apps, delete the role assignment with the target and create another one. See [Unassign a client role](/openapi/okta-management/management/tag/RoleAssignmentClient/#tag/RoleAssignmentClient/operation/deleteRoleFromClient).
      Parameters:
      clientId - `client_id` of the app (required)
      roleAssignmentId - The `id` of the role assignment (required)
      appName - Name of the app definition (the OIN catalog app key name) (required)
      Throws:
      ApiException - if fails to make API call

    • removeAppTargetRoleFromClient

      public void removeAppTargetRoleFromClient(String clientId, String roleAssignmentId, String appName, Map<String,String> additionalHeaders) throws ApiException
      Unassign a client role app target Unassigns an OIN app target for a role assignment to a client app > **Note:** You can't remove the last OIN app target from a role assignment. > If you need a role assignment that applies to all apps, delete the role assignment with the target and create another one. See [Unassign a client role](/openapi/okta-management/management/tag/RoleAssignmentClient/#tag/RoleAssignmentClient/operation/deleteRoleFromClient).
      Parameters:
      clientId - `client_id` of the app (required)
      roleAssignmentId - The `id` of the role assignment (required)
      appName - Name of the app definition (the OIN catalog app key name) (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • removeGroupTargetRoleFromClient

      public void removeGroupTargetRoleFromClient(String clientId, String roleAssignmentId, String groupId) throws ApiException
      Unassign a client role group target Unassigns a Group target from a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` role assignment to a client app. > **Note:** You can't remove the last group target from a role assignment. If you need a role assignment that applies to all groups, delete the role assignment with the target and create another one. See [Unassign a client role](/openapi/okta-management/management/tag/RoleAssignmentClient/#tag/RoleAssignmentClient/operation/deleteRoleFromClient).
      Parameters:
      clientId - `client_id` of the app (required)
      roleAssignmentId - The `id` of the role assignment (required)
      groupId - The `id` of the group (required)
      Throws:
      ApiException - if fails to make API call

    • removeGroupTargetRoleFromClient

      public void removeGroupTargetRoleFromClient(String clientId, String roleAssignmentId, String groupId, Map<String,String> additionalHeaders) throws ApiException
      Unassign a client role group target Unassigns a Group target from a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` role assignment to a client app. > **Note:** You can't remove the last group target from a role assignment. If you need a role assignment that applies to all groups, delete the role assignment with the target and create another one. See [Unassign a client role](/openapi/okta-management/management/tag/RoleAssignmentClient/#tag/RoleAssignmentClient/operation/deleteRoleFromClient).
      Parameters:
      clientId - `client_id` of the app (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()