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-08-09T14:19:33.269913-05:00[America/Chicago]",
comments="Generator version: 7.7.0")
public class RealmApi
extends Object
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionCreate a Realm Creates a new RealmcreateRealm
(CreateRealmRequest body, Map<String, String> additionalHeaders) Create a Realm Creates a new Realmvoid
deleteRealm
(String realmId) Delete a Realm Deletes a Realm permanently.void
deleteRealm
(String realmId, Map<String, String> additionalHeaders) Delete a Realm Deletes a Realm permanently.protected static com.fasterxml.jackson.databind.ObjectMapper
Retrieve a Realm Retrieves a RealmRetrieve a Realm Retrieves a RealmList all Realms Lists all RealmslistRealms
(Integer limit, String after, String search, String sortBy, String sortOrder, Map<String, String> additionalHeaders) List all Realms Lists all RealmsreplaceRealm
(String realmId, UpdateRealmRequest body) Replace the realm profile Replaces the realm profilereplaceRealm
(String realmId, UpdateRealmRequest body, Map<String, String> additionalHeaders) Replace the realm profile Replaces the realm profilevoid
setApiClient
(ApiClient apiClient)
-
Constructor Details
-
RealmApi
public RealmApi() -
RealmApi
-
-
Method Details
-
getApiClient
-
setApiClient
-
createRealm
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 ApiExceptionCreate 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
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
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
Retrieve a Realm Retrieves a Realm- Parameters:
realmId
- `id` of the Realm (required)- Returns:
- Realm
- Throws:
ApiException
- if fails to make API call
-
getRealm
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](/#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 ApiExceptionList 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](/#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
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 ApiExceptionReplace 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()
-