mirror of
https://github.com/LukeHagar/clerk-sdk-java.git
synced 2025-12-06 04:19:25 +00:00
86 lines
4.3 KiB
Markdown
86 lines
4.3 KiB
Markdown
# Proxy
|
|
(*proxy()*)
|
|
|
|
### Available Operations
|
|
|
|
* [verifyDomain](#verifydomain) - Verify the proxy configuration for your domain
|
|
|
|
## verifyDomain
|
|
|
|
This endpoint can be used to validate that a proxy-enabled domain is operational.
|
|
It tries to verify that the proxy URL provided in the parameters maps to a functional proxy that can reach the Clerk Frontend API.
|
|
|
|
You can use this endpoint before you set a proxy URL for a domain. This way you can ensure that switching to proxy-based
|
|
configuration will not lead to downtime for your instance.
|
|
|
|
The `proxy_url` parameter allows for testing proxy configurations for domains that don't have a proxy URL yet, or operate on
|
|
a different proxy URL than the one provided. It can also be used to re-validate a domain that is already configured to work with a proxy.
|
|
|
|
### Example Usage
|
|
|
|
```java
|
|
package hello.world;
|
|
|
|
import com.clerk.backend_api.Clerk;
|
|
import com.clerk.backend_api.models.components.*;
|
|
import com.clerk.backend_api.models.components.Security;
|
|
import com.clerk.backend_api.models.operations.*;
|
|
import com.clerk.backend_api.utils.EventStream;
|
|
import java.math.BigDecimal;
|
|
import java.math.BigDecimal;
|
|
import java.math.BigInteger;
|
|
import java.time.LocalDate;
|
|
import java.time.OffsetDateTime;
|
|
import java.util.Optional;
|
|
import org.openapitools.jackson.nullable.JsonNullable;
|
|
import static java.util.Map.entry;
|
|
|
|
public class Application {
|
|
|
|
public static void main(String[] args) throws Exception {
|
|
try {
|
|
Clerk sdk = Clerk.builder()
|
|
.bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
|
|
.build();
|
|
|
|
VerifyDomainProxyRequestBody req = VerifyDomainProxyRequestBody.builder()
|
|
.build();
|
|
|
|
VerifyDomainProxyResponse res = sdk.proxy().verifyDomain()
|
|
.request(req)
|
|
.call();
|
|
|
|
if (res.proxyCheck().isPresent()) {
|
|
// handle response
|
|
}
|
|
} catch (com.clerk.backend_api.models.errors.ClerkErrors e) {
|
|
// handle exception
|
|
throw e;
|
|
} catch (com.clerk.backend_api.models.errors.SDKError e) {
|
|
// handle exception
|
|
throw e;
|
|
} catch (Exception e) {
|
|
// handle exception
|
|
throw e;
|
|
}
|
|
}
|
|
}
|
|
```
|
|
|
|
### Parameters
|
|
|
|
| Parameter | Type | Required | Description |
|
|
| ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
|
|
| `request` | [com.clerk.backend_api.models.operations.VerifyDomainProxyRequestBody](../../models/operations/VerifyDomainProxyRequestBody.md) | :heavy_check_mark: | The request object to use for the request. |
|
|
|
|
|
|
### Response
|
|
|
|
**[Optional<? extends com.clerk.backend_api.models.operations.VerifyDomainProxyResponse>](../../models/operations/VerifyDomainProxyResponse.md)**
|
|
### Errors
|
|
|
|
| Error Object | Status Code | Content Type |
|
|
| ------------------------- | ------------------------- | ------------------------- |
|
|
| models/errors/ClerkErrors | 400,422 | application/json |
|
|
| models/errors/SDKError | 4xx-5xx | */* |
|