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

  • Constructor Details

    • RealmAssignmentApi

      public RealmAssignmentApi()

    • RealmAssignmentApi

      public RealmAssignmentApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • activateRealmAssignment

      public void activateRealmAssignment(String assignmentId) throws ApiException
      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 ApiException
      Activate 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

      public RealmAssignment createRealmAssignment(CreateRealmAssignmentRequest body) throws ApiException
      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 ApiException
      Create 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

      public void deactivateRealmAssignment(String assignmentId) throws ApiException
      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 ApiException
      Deactivate 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

      public void deleteRealmAssignment(String assignmentId) throws ApiException
      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 ApiException
      Delete 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

      public OperationResponse executeRealmAssignment(OperationRequest body) throws ApiException
      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 ApiException
      Execute 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

      public RealmAssignment getRealmAssignment(String assignmentId) throws ApiException
      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 ApiException
      Retrieve 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](https://developer.okta.com/docs/api/#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 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](https://developer.okta.com/docs/api/#pagination). (optional)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<OperationResponse>
      Throws:
      ApiException - if fails to make API call

    • listRealmAssignments

      public List<RealmAssignment> listRealmAssignments(Integer limit, String after) throws ApiException
      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](https://developer.okta.com/docs/api/#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 ApiException
      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](https://developer.okta.com/docs/api/#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 ApiException
      Replace 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()