org.openapitools.client.api

Class RealmApi

java.lang.Object

org.openapitools.client.api.RealmApi

@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen",
           date="2023-07-14T17:07:26.321-05:00[America/Chicago]")
public class RealmApi
extends Object

Constructor Summary

Constructors

Constructor and Description
RealmApi()
RealmApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method and Description
Realm	createRealm(Realm body) Create a Realm Creates a new Realm
Realm	createRealm(Realm body, Map<String,String> additionalHeaders) Create a Realm Creates a new Realm
void	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.
ApiClient	getApiClient()
protected static com.fasterxml.jackson.databind.ObjectMapper	getObjectMapper()
Realm	getRealm(String realmId) Retrieve a Realm Retrieves a Realm
Realm	getRealm(String realmId, Map<String,String> additionalHeaders) Retrieve a Realm Retrieves a Realm
List<Realm>	listRealms(Integer limit, String after, String search, String sortBy, String sortOrder) List all Realms Lists all Realms
List<Realm>	listRealms(Integer limit, String after, String search, String sortBy, String sortOrder, Map<String,String> additionalHeaders) List all Realms Lists all Realms
void	setApiClient(ApiClient apiClient)
Realm	updateRealm(String realmId, Realm body) Update a Realm Updates a Realm
Realm	updateRealm(String realmId, Realm body, Map<String,String> additionalHeaders) Update a Realm Updates a Realm

Methods inherited from class java.lang.Object

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

Constructor Detail

RealmApi

public RealmApi()

RealmApi

public RealmApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

createRealm

public Realm createRealm(Realm 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(Realm 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](/#pagination) for more information. (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](/#pagination) for more information. (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

updateRealm

public Realm updateRealm(String realmId,
                         Realm body)
                  throws ApiException

Update a Realm Updates a Realm

Parameters:

realmId - `id` of the Realm (required)

body - (required)

Returns:

Realm

Throws:

ApiException - if fails to make API call

updateRealm

public Realm updateRealm(String realmId,
                         Realm body,
                         Map<String,String> additionalHeaders)
                  throws ApiException

Update a Realm Updates a Realm

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