README.md

InstanceSettings

Overview

Modify the settings of your instance.

Available Operations

• get - Fetch the current instance
• update - Update instance settings
• updateRestrictions - Update instance restrictions
• getCommunication - Get instance communication settings
• updateCommunication - Update instance communication settings
• getOAuthApplicationSettings - Get OAuth application settings
• updateOAuthApplicationSettings - Update OAuth application settings
• changeDomain - Update production instance domain
• getOrganizationSettings - Get instance organization settings
• updateOrganizationSettings - Update instance organization settings
• getInstanceProtect - Get instance protect settings
• updateInstanceProtect - Update instance protect settings

get

Fetches the current instance

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.operations.GetInstanceResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Clerk sdk = Clerk.builder()
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        GetInstanceResponse res = sdk.instanceSettings().get()
                .call();

        if (res.instance().isPresent()) {
            System.out.println(res.instance().get());
        }
    }
}

Response

GetInstanceResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

update

Updates the settings of an instance

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.ClerkErrors;
import com.clerk.backend_api.models.operations.UpdateInstanceResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ClerkErrors, Exception {

        Clerk sdk = Clerk.builder()
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        UpdateInstanceResponse res = sdk.instanceSettings().update()
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
request	UpdateInstanceRequestBody	✔️	The request object to use for the request.

Response

UpdateInstanceResponse

Errors

Error Type	Status Code	Content Type
models/errors/ClerkErrors	422	application/json
models/errors/SDKError	4XX, 5XX	*/*

updateRestrictions

Updates the restriction settings of an instance

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.ClerkErrors;
import com.clerk.backend_api.models.operations.UpdateInstanceRestrictionsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ClerkErrors, Exception {

        Clerk sdk = Clerk.builder()
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        UpdateInstanceRestrictionsResponse res = sdk.instanceSettings().updateRestrictions()
                .call();

        if (res.instanceRestrictions().isPresent()) {
            System.out.println(res.instanceRestrictions().get());
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	UpdateInstanceRestrictionsRequestBody	✔️	The request object to use for the request.

Response

UpdateInstanceRestrictionsResponse

Errors

Error Type	Status Code	Content Type
models/errors/ClerkErrors	402, 422	application/json
models/errors/SDKError	4XX, 5XX	*/*

getCommunication

Retrieves the per-instance SMS communication settings, including the SMS country blocklist.

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.operations.GetInstanceCommunicationResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Clerk sdk = Clerk.builder()
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        GetInstanceCommunicationResponse res = sdk.instanceSettings().getCommunication()
                .call();

        if (res.instanceCommunication().isPresent()) {
            System.out.println(res.instanceCommunication().get());
        }
    }
}

Response

GetInstanceCommunicationResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

updateCommunication

Replaces the SMS country blocklist for this instance. Pass the full set of ISO 3166-1 alpha-2 country codes that should be blocked; codes that aren't recognized as SMS-tier countries are silently dropped from the persisted list. Omitting blocked_country_codes is a no-op.

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.ClerkErrors;
import com.clerk.backend_api.models.operations.UpdateInstanceCommunicationResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ClerkErrors, Exception {

        Clerk sdk = Clerk.builder()
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        UpdateInstanceCommunicationResponse res = sdk.instanceSettings().updateCommunication()
                .call();

        if (res.instanceCommunication().isPresent()) {
            System.out.println(res.instanceCommunication().get());
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	UpdateInstanceCommunicationRequestBody	✔️	The request object to use for the request.

Response

UpdateInstanceCommunicationResponse

Errors

Error Type	Status Code	Content Type
models/errors/ClerkErrors	422	application/json
models/errors/SDKError	4XX, 5XX	*/*

getOAuthApplicationSettings

Retrieves the settings for OAuth applications for the instance (dynamic client registration, JWT access tokens, etc.).

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.operations.GetInstanceOAuthApplicationSettingsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Clerk sdk = Clerk.builder()
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        GetInstanceOAuthApplicationSettingsResponse res = sdk.instanceSettings().getOAuthApplicationSettings()
                .call();

        if (res.oAuthApplicationSettings().isPresent()) {
            System.out.println(res.oAuthApplicationSettings().get());
        }
    }
}

Response

GetInstanceOAuthApplicationSettingsResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

updateOAuthApplicationSettings

Updates the OAuth application settings for the instance.

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.ClerkErrors;
import com.clerk.backend_api.models.operations.UpdateInstanceOAuthApplicationSettingsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ClerkErrors, Exception {

        Clerk sdk = Clerk.builder()
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        UpdateInstanceOAuthApplicationSettingsResponse res = sdk.instanceSettings().updateOAuthApplicationSettings()
                .call();

        if (res.oAuthApplicationSettings().isPresent()) {
            System.out.println(res.oAuthApplicationSettings().get());
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	UpdateInstanceOAuthApplicationSettingsRequestBody	✔️	The request object to use for the request.

Response

UpdateInstanceOAuthApplicationSettingsResponse

Errors

Error Type	Status Code	Content Type
models/errors/ClerkErrors	422	application/json
models/errors/SDKError	4XX, 5XX	*/*

changeDomain

Change the domain of a production instance.

Changing the domain requires updating the DNS records accordingly, deploying new SSL certificates, updating your Social Connection's redirect URLs and setting the new keys in your code.

WARNING: Changing your domain will invalidate all current user sessions (i.e. users will be logged out). Also, while your application is being deployed, a small downtime is expected to occur.

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.ClerkErrors;
import com.clerk.backend_api.models.operations.ChangeProductionInstanceDomainResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ClerkErrors, Exception {

        Clerk sdk = Clerk.builder()
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        ChangeProductionInstanceDomainResponse res = sdk.instanceSettings().changeDomain()
                .call();

        // handle response
    }
}

Parameters

Parameter	Type	Required	Description
request	ChangeProductionInstanceDomainRequestBody	✔️	The request object to use for the request.

Response

ChangeProductionInstanceDomainResponse

Errors

Error Type	Status Code	Content Type
models/errors/ClerkErrors	400, 422	application/json
models/errors/SDKError	4XX, 5XX	*/*

getOrganizationSettings

Retrieves the organization settings of the instance

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.ClerkErrors;
import com.clerk.backend_api.models.operations.GetInstanceOrganizationSettingsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ClerkErrors, Exception {

        Clerk sdk = Clerk.builder()
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        GetInstanceOrganizationSettingsResponse res = sdk.instanceSettings().getOrganizationSettings()
                .call();

        if (res.organizationSettings().isPresent()) {
            System.out.println(res.organizationSettings().get());
        }
    }
}

Response

GetInstanceOrganizationSettingsResponse

Errors

Error Type	Status Code	Content Type
models/errors/ClerkErrors	402, 404, 422	application/json
models/errors/SDKError	4XX, 5XX	*/*

updateOrganizationSettings

Updates the organization settings of the instance

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.ClerkErrors;
import com.clerk.backend_api.models.operations.UpdateInstanceOrganizationSettingsResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ClerkErrors, Exception {

        Clerk sdk = Clerk.builder()
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        UpdateInstanceOrganizationSettingsResponse res = sdk.instanceSettings().updateOrganizationSettings()
                .call();

        if (res.organizationSettings().isPresent()) {
            System.out.println(res.organizationSettings().get());
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	UpdateInstanceOrganizationSettingsRequestBody	✔️	The request object to use for the request.

Response

UpdateInstanceOrganizationSettingsResponse

Errors

Error Type	Status Code	Content Type
models/errors/ClerkErrors	400, 402, 403, 404, 422	application/json
models/errors/SDKError	4XX, 5XX	*/*

getInstanceProtect

Get instance protect settings

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.operations.GetInstanceProtectResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws Exception {

        Clerk sdk = Clerk.builder()
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        GetInstanceProtectResponse res = sdk.instanceSettings().getInstanceProtect()
                .call();

        if (res.instanceProtect().isPresent()) {
            System.out.println(res.instanceProtect().get());
        }
    }
}

Response

GetInstanceProtectResponse

Errors

Error Type	Status Code	Content Type
models/errors/SDKError	4XX, 5XX	*/*

updateInstanceProtect

Update instance protect settings

Example Usage

package hello.world;

import com.clerk.backend_api.Clerk;
import com.clerk.backend_api.models.errors.ClerkErrors;
import com.clerk.backend_api.models.operations.UpdateInstanceProtectResponse;
import java.lang.Exception;

public class Application {

    public static void main(String[] args) throws ClerkErrors, Exception {

        Clerk sdk = Clerk.builder()
                .bearerAuth(System.getenv().getOrDefault("BEARER_AUTH", ""))
            .build();

        UpdateInstanceProtectResponse res = sdk.instanceSettings().updateInstanceProtect()
                .call();

        if (res.instanceProtect().isPresent()) {
            System.out.println(res.instanceProtect().get());
        }
    }
}

Parameters

Parameter	Type	Required	Description
request	UpdateInstanceProtectRequestBody	✔️	The request object to use for the request.

Response

UpdateInstanceProtectResponse

Errors

Error Type	Status Code	Content Type
models/errors/ClerkErrors	422	application/json
models/errors/SDKError	4XX, 5XX	*/*