Package com.okta.sdk.resource.api

Class RealmApi

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

  • Constructor Details

    • RealmApi

      public RealmApi()

    • RealmApi

      public RealmApi(ApiClient apiClient)

  • Method Details

    • getApiClient

      public ApiClient getApiClient()

    • setApiClient

      public void setApiClient(ApiClient apiClient)

    • createRealm

      public Realm createRealm(CreateRealmRequest body) throws ApiException
      Create a Realm Creates a new Realm
      Parameters:
      body - (required)
      Returns:
      Realm
      Throws:
      ApiException - if fails to make API call

    • createRealm

      public Realm createRealm(CreateRealmRequest body, Map<String,String> additionalHeaders) throws ApiException
      Create a Realm Creates a new Realm
      Parameters:
      body - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      Realm
      Throws:
      ApiException - if fails to make API call

    • deleteRealm

      public void deleteRealm(String realmId) throws ApiException
      Delete a Realm Deletes a Realm permanently. This operation can only be performed after disassociating other entities like Users and Identity Providers from a Realm.
      Parameters:
      realmId - `id` of the Realm (required)
      Throws:
      ApiException - if fails to make API call

    • deleteRealm

      public void deleteRealm(String realmId, Map<String,String> additionalHeaders) throws ApiException
      Delete a Realm Deletes a Realm permanently. This operation can only be performed after disassociating other entities like Users and Identity Providers from a Realm.
      Parameters:
      realmId - `id` of the Realm (required)
      additionalHeaders - additionalHeaders for this call
      Throws:
      ApiException - if fails to make API call

    • getRealm

      public Realm getRealm(String realmId) throws ApiException
      Retrieve a Realm Retrieves a Realm
      Parameters:
      realmId - `id` of the Realm (required)
      Returns:
      Realm
      Throws:
      ApiException - if fails to make API call

    • getRealm

      public Realm getRealm(String realmId, Map<String,String> additionalHeaders) throws ApiException
      Retrieve a Realm Retrieves a Realm
      Parameters:
      realmId - `id` of the Realm (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      Realm
      Throws:
      ApiException - if fails to make API call

    • listRealms

      public List<Realm> listRealms(Integer limit, String after, String search, String sortBy, String sortOrder) throws ApiException
      List all Realms Lists all Realms
      Parameters:
      limit - Specifies the number of results returned. Defaults to 10 if `search` is provided. (optional, default to 200)
      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)
      search - Searches for Realms with a supported filtering expression for most properties (optional)
      sortBy - Specifies field to sort by and can be any single property (for search queries only). (optional)
      sortOrder - Specifies sort order `asc` or `desc` (for search queries only). This parameter is ignored if `sortBy` isn't present. (optional, default to asc)
      Returns:
      List<Realm>
      Throws:
      ApiException - if fails to make API call

    • listRealms

      public List<Realm> listRealms(Integer limit, String after, String search, String sortBy, String sortOrder, Map<String,String> additionalHeaders) throws ApiException
      List all Realms Lists all Realms
      Parameters:
      limit - Specifies the number of results returned. Defaults to 10 if `search` is provided. (optional, default to 200)
      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)
      search - Searches for Realms with a supported filtering expression for most properties (optional)
      sortBy - Specifies field to sort by and can be any single property (for search queries only). (optional)
      sortOrder - Specifies sort order `asc` or `desc` (for search queries only). This parameter is ignored if `sortBy` isn't present. (optional, default to asc)
      additionalHeaders - additionalHeaders for this call
      Returns:
      List<Realm>
      Throws:
      ApiException - if fails to make API call

    • replaceRealm

      public Realm replaceRealm(String realmId, UpdateRealmRequest body) throws ApiException
      Replace the realm profile Replaces the realm profile
      Parameters:
      realmId - `id` of the Realm (required)
      body - (required)
      Returns:
      Realm
      Throws:
      ApiException - if fails to make API call

    • replaceRealm

      public Realm replaceRealm(String realmId, UpdateRealmRequest body, Map<String,String> additionalHeaders) throws ApiException
      Replace the realm profile Replaces the realm profile
      Parameters:
      realmId - `id` of the Realm (required)
      body - (required)
      additionalHeaders - additionalHeaders for this call
      Returns:
      Realm
      Throws:
      ApiException - if fails to make API call

    • getObjectMapper

      protected static com.fasterxml.jackson.databind.ObjectMapper getObjectMapper()