Package com.okta.sdk.resource.api
Class RealmAssignmentApi
java.lang.Object
com.okta.sdk.resource.api.RealmAssignmentApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
date="2024-09-03T19:34:39.101116704Z[Etc/UTC]",
comments="Generator version: 7.7.0")
public class RealmAssignmentApi
extends Object
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
activateRealmAssignment
(String assignmentId) Activate a Realm Assignment Activates a Realm Assignmentvoid
activateRealmAssignment
(String assignmentId, Map<String, String> additionalHeaders) Activate a Realm Assignment Activates a Realm AssignmentCreate a Realm Assignment Creates a new Realm AssignmentcreateRealmAssignment
(CreateRealmAssignmentRequest body, Map<String, String> additionalHeaders) Create a Realm Assignment Creates a new Realm Assignmentvoid
deactivateRealmAssignment
(String assignmentId) Deactivate a Realm Assignment Deactivates a Realm Assignmentvoid
deactivateRealmAssignment
(String assignmentId, Map<String, String> additionalHeaders) Deactivate a Realm Assignment Deactivates a Realm Assignmentvoid
deleteRealmAssignment
(String assignmentId) Delete a Realm Assignment Deletes a Realm Assignmentvoid
deleteRealmAssignment
(String assignmentId, Map<String, String> additionalHeaders) Delete a Realm Assignment Deletes a Realm AssignmentExecute a Realm Assignment Executes a Realm AssignmentexecuteRealmAssignment
(OperationRequest body, Map<String, String> additionalHeaders) Execute a Realm Assignment Executes a Realm Assignmentprotected static com.fasterxml.jackson.databind.ObjectMapper
getRealmAssignment
(String assignmentId) Retrieve a Realm Assignment Retrieves a Realm AssignmentgetRealmAssignment
(String assignmentId, Map<String, String> additionalHeaders) Retrieve a Realm Assignment Retrieves a Realm AssignmentlistRealmAssignmentOperations
(Integer limit, String after) List all Realm Assignment operations Lists all Realm Assignment operations.List all Realm Assignment operations Lists all Realm Assignment operations.listRealmAssignments
(Integer limit, String after) List all Realm Assignments Lists all Realm AssignmentsList all Realm Assignments Lists all Realm AssignmentsreplaceRealmAssignment
(String assignmentId, UpdateRealmAssignmentRequest body) Replace a Realm Assignment Replaces a Realm AssignmentreplaceRealmAssignment
(String assignmentId, UpdateRealmAssignmentRequest body, Map<String, String> additionalHeaders) Replace a Realm Assignment Replaces a Realm Assignmentvoid
setApiClient
(ApiClient apiClient)
-
Constructor Details
-
RealmAssignmentApi
public RealmAssignmentApi() -
RealmAssignmentApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
activateRealmAssignment
Activate a Realm Assignment Activates a Realm Assignment- Parameters:
assignmentId
- `id` of the Realm Assignment (required)- Throws:
ApiException
- if fails to make API call
-
activateRealmAssignment
public void activateRealmAssignment(String assignmentId, Map<String, String> additionalHeaders) throws ApiExceptionActivate a Realm Assignment Activates a Realm Assignment- Parameters:
assignmentId
- `id` of the Realm Assignment (required)additionalHeaders
- additionalHeaders for this call- Throws:
ApiException
- if fails to make API call
-
createRealmAssignment
Create a Realm Assignment Creates a new Realm Assignment- Parameters:
body
- (required)- Returns:
- RealmAssignment
- Throws:
ApiException
- if fails to make API call
-
createRealmAssignment
public RealmAssignment createRealmAssignment(CreateRealmAssignmentRequest body, Map<String, String> additionalHeaders) throws ApiExceptionCreate a Realm Assignment Creates a new Realm Assignment- Parameters:
body
- (required)additionalHeaders
- additionalHeaders for this call- Returns:
- RealmAssignment
- Throws:
ApiException
- if fails to make API call
-
deactivateRealmAssignment
Deactivate a Realm Assignment Deactivates a Realm Assignment- Parameters:
assignmentId
- `id` of the Realm Assignment (required)- Throws:
ApiException
- if fails to make API call
-
deactivateRealmAssignment
public void deactivateRealmAssignment(String assignmentId, Map<String, String> additionalHeaders) throws ApiExceptionDeactivate a Realm Assignment Deactivates a Realm Assignment- Parameters:
assignmentId
- `id` of the Realm Assignment (required)additionalHeaders
- additionalHeaders for this call- Throws:
ApiException
- if fails to make API call
-
deleteRealmAssignment
Delete a Realm Assignment Deletes a Realm Assignment- Parameters:
assignmentId
- `id` of the Realm Assignment (required)- Throws:
ApiException
- if fails to make API call
-
deleteRealmAssignment
public void deleteRealmAssignment(String assignmentId, Map<String, String> additionalHeaders) throws ApiExceptionDelete a Realm Assignment Deletes a Realm Assignment- Parameters:
assignmentId
- `id` of the Realm Assignment (required)additionalHeaders
- additionalHeaders for this call- Throws:
ApiException
- if fails to make API call
-
executeRealmAssignment
Execute a Realm Assignment Executes a Realm Assignment- Parameters:
body
- (required)- Returns:
- OperationResponse
- Throws:
ApiException
- if fails to make API call
-
executeRealmAssignment
public OperationResponse executeRealmAssignment(OperationRequest body, Map<String, String> additionalHeaders) throws ApiExceptionExecute a Realm Assignment Executes a Realm Assignment- Parameters:
body
- (required)additionalHeaders
- additionalHeaders for this call- Returns:
- OperationResponse
- Throws:
ApiException
- if fails to make API call
-
getRealmAssignment
Retrieve a Realm Assignment Retrieves a Realm Assignment- Parameters:
assignmentId
- `id` of the Realm Assignment (required)- Returns:
- RealmAssignment
- Throws:
ApiException
- if fails to make API call
-
getRealmAssignment
public RealmAssignment getRealmAssignment(String assignmentId, Map<String, String> additionalHeaders) throws ApiExceptionRetrieve a Realm Assignment Retrieves a Realm Assignment- Parameters:
assignmentId
- `id` of the Realm Assignment (required)additionalHeaders
- additionalHeaders for this call- Returns:
- RealmAssignment
- Throws:
ApiException
- if fails to make API call
-
listRealmAssignmentOperations
public List<OperationResponse> listRealmAssignmentOperations(Integer limit, String after) throws ApiException List all Realm Assignment operations Lists all Realm Assignment operations. The upper limit is 200 and operations are sorted in descending order from most recent to oldest by id- Parameters:
limit
- A limit on the number of objects to return (optional, default to 20)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](/#pagination). (optional)- Returns:
- List<OperationResponse>
- Throws:
ApiException
- if fails to make API call
-
listRealmAssignmentOperations
public List<OperationResponse> listRealmAssignmentOperations(Integer limit, String after, Map<String, String> additionalHeaders) throws ApiExceptionList all Realm Assignment operations Lists all Realm Assignment operations. The upper limit is 200 and operations are sorted in descending order from most recent to oldest by id- Parameters:
limit
- A limit on the number of objects to return (optional, default to 20)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](/#pagination). (optional)additionalHeaders
- additionalHeaders for this call- Returns:
- List<OperationResponse>
- Throws:
ApiException
- if fails to make API call
-
listRealmAssignments
List all Realm Assignments Lists all Realm Assignments- Parameters:
limit
- A limit on the number of objects to return (optional, default to 20)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](/#pagination). (optional)- Returns:
- List<RealmAssignment>
- Throws:
ApiException
- if fails to make API call
-
listRealmAssignments
public List<RealmAssignment> listRealmAssignments(Integer limit, String after, Map<String, String> additionalHeaders) throws ApiExceptionList all Realm Assignments Lists all Realm Assignments- Parameters:
limit
- A limit on the number of objects to return (optional, default to 20)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](/#pagination). (optional)additionalHeaders
- additionalHeaders for this call- Returns:
- List<RealmAssignment>
- Throws:
ApiException
- if fails to make API call
-
replaceRealmAssignment
public RealmAssignment replaceRealmAssignment(String assignmentId, UpdateRealmAssignmentRequest body) throws ApiException Replace a Realm Assignment Replaces a Realm Assignment- Parameters:
assignmentId
- `id` of the Realm Assignment (required)body
- (required)- Returns:
- RealmAssignment
- Throws:
ApiException
- if fails to make API call
-
replaceRealmAssignment
public RealmAssignment replaceRealmAssignment(String assignmentId, UpdateRealmAssignmentRequest body, Map<String, String> additionalHeaders) throws ApiExceptionReplace a Realm Assignment Replaces a Realm Assignment- Parameters:
assignmentId
- `id` of the Realm Assignment (required)body
- (required)additionalHeaders
- additionalHeaders for this call- Returns:
- RealmAssignment
- Throws:
ApiException
- if fails to make API call
-
getObjectMapper
protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()
-