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="2024-09-23T16:19:57.008753975Z[Etc/UTC]",
           comments="Generator version: 7.8.0")
public class RoleBTargetClientApi
extends Object

Constructor Summary

Constructors

Constructor	Description
RoleBTargetClientApi()
RoleBTargetClientApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
void	assignAppTargetInstanceRoleForClient(String clientId, String roleAssignmentId, String appName, String appId)	Assign a Client Role Application Instance Target Assigns an app instance target to an `APP_ADMIN` Role Assignment to a client Application.
void	assignAppTargetInstanceRoleForClient(String clientId, String roleAssignmentId, String appName, String appId, Map<String,String> additionalHeaders)	Assign a Client Role Application Instance Target Assigns an app instance target to an `APP_ADMIN` Role Assignment to a client Application.
void	assignAppTargetRoleToClient(String clientId, String roleAssignmentId, String appName)	Assign a Client Role Application Target Assigns an OIN app target for an `APP_ADMIN` Role Assignment to a client Application.
void	assignAppTargetRoleToClient(String clientId, String roleAssignmentId, String appName, Map<String,String> additionalHeaders)	Assign a Client Role Application Target Assigns an OIN app target for an `APP_ADMIN` Role Assignment to a client Application.
void	assignGroupTargetRoleForClient(String clientId, String roleAssignmentId, String groupId)	Assign a Client Role Group Target Assigns a Group target to a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a client Application.
void	assignGroupTargetRoleForClient(String clientId, String roleAssignmentId, String groupId, Map<String,String> additionalHeaders)	Assign a Client Role Group Target Assigns a Group target to a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a client Application.
ApiClient	getApiClient()
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
List<CatalogApplication>	listAppTargetRoleToClient(String clientId, String roleAssignmentId, String after, Integer limit)	List all Client Role Application Targets Lists all OIN app targets for an `APP_ADMIN` Role that's assigned to a client Application (by `clientId`).
List<CatalogApplication>	listAppTargetRoleToClient(String clientId, String roleAssignmentId, String after, Integer limit, Map<String,String> additionalHeaders)	List all Client Role Application Targets Lists all OIN app targets for an `APP_ADMIN` Role that's assigned to a client Application (by `clientId`).
List<Group>	listGroupTargetRoleForClient(String clientId, String roleAssignmentId, String after, Integer limit)	List all Client Role Group Targets Lists all Group targets for a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a client.
List<Group>	listGroupTargetRoleForClient(String clientId, String roleAssignmentId, String after, Integer limit, Map<String,String> additionalHeaders)	List all Client Role Group Targets Lists all Group targets for a `USER_ADMIN`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a client.
void	removeAppTargetInstanceRoleForClient(String clientId, String roleAssignmentId, String appName, String appId)	Unassign a Client Role Application Instance Target Unassigns an OIN app instance target from a Role Assignment to a client Application > **Note:** You can't remove the last app instance target from a Role Assignment since this causes an exception.
void	removeAppTargetInstanceRoleForClient(String clientId, String roleAssignmentId, String appName, String appId, Map<String,String> additionalHeaders)	Unassign a Client Role Application Instance Target Unassigns an OIN app instance target from a Role Assignment to a client Application > **Note:** You can't remove the last app instance target from a Role Assignment since this causes an exception.
void	removeAppTargetRoleFromClient(String clientId, String roleAssignmentId, String appName)	Unassign a Client Role Application Target Unassigns an OIN app target for a Role Assignment to a client Application > **Note:** You can't remove the last OIN app target from a Role Assignment since operation causes an exception.
void	removeAppTargetRoleFromClient(String clientId, String roleAssignmentId, String appName, Map<String,String> additionalHeaders)	Unassign a Client Role Application Target Unassigns an OIN app target for a Role Assignment to a client Application > **Note:** You can't remove the last OIN app target from a Role Assignment since operation causes an exception.
void	removeGroupTargetRoleFromClient(String clientId, String roleAssignmentId, String groupId)	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 Application.
void	removeGroupTargetRoleFromClient(String clientId, String roleAssignmentId, String groupId, Map<String,String> additionalHeaders)	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 Application.
void	setApiClient(ApiClient apiClient)

Methods inherited from class java.lang.Object

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

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 Application Instance Target Assigns an app instance target to an `APP_ADMIN` Role Assignment to a client Application. 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 - Application name for the app type (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 Application Instance Target Assigns an app instance target to an `APP_ADMIN` Role Assignment to a client Application. 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 - Application name for the app type (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 Application Target Assigns an OIN app target for an `APP_ADMIN` Role Assignment to a client Application. When you assign an app target from the OIN catalog, you reduce the scope of the Role Assignment. The Role 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 - Application name for the app type (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 Application Target Assigns an OIN app target for an `APP_ADMIN` Role Assignment to a client Application. When you assign an app target from the OIN catalog, you reduce the scope of the Role Assignment. The Role 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 - Application name for the app type (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`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a client Application. 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`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a client Application. 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 Application Targets Lists all OIN app targets for an `APP_ADMIN` Role that's assigned to a client Application (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). (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 Application Targets Lists all OIN app targets for an `APP_ADMIN` Role that's assigned to a client Application (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). (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

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`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a client. If the Role isn't scoped to specific Group targets, an empty array `[]` is returned.

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). (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`, `HELP_DESK_ADMIN`, or `GROUP_MEMBERSHIP_ADMIN` Role Assignment to a client. If the Role isn't scoped to specific Group targets, an empty array `[]` is returned.

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). (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

removeAppTargetInstanceRoleForClient

public void removeAppTargetInstanceRoleForClient(String clientId,
 String roleAssignmentId,
 String appName,
 String appId)
                                          throws ApiException

Unassign a Client Role Application Instance Target Unassigns an OIN app instance target from a Role Assignment to a client Application > **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 the apps, delete the Role Assignment and recreate a new 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 - Application name for the app type (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 Application Instance Target Unassigns an OIN app instance target from a Role Assignment to a client Application > **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 the apps, delete the Role Assignment and recreate a new 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 - Application name for the app type (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 Application Target Unassigns an OIN app target for a Role Assignment to a client Application > **Note:** You can't remove the last OIN app target from a Role Assignment since operation causes an exception. > If you need a Role assignment that applies to all apps, delete the Role Assignment and recreate a new 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 - Application name for the app type (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 Application Target Unassigns an OIN app target for a Role Assignment to a client Application > **Note:** You can't remove the last OIN app target from a Role Assignment since operation causes an exception. > If you need a Role assignment that applies to all apps, delete the Role Assignment and recreate a new 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 - Application name for the app type (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 Application. > **Note:** You can't remove the last Group target from a Role Assignment, as it causes an exception. If you need a Role Assignment that applies to all Groups, delete the Role Assignment and recreate a new 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 Application. > **Note:** You can't remove the last Group target from a Role Assignment, as it causes an exception. If you need a Role Assignment that applies to all Groups, delete the Role Assignment and recreate a new 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()