Skip to content

Latest commit

 

History

History
164 lines (112 loc) · 5.7 KB

README.md

File metadata and controls

164 lines (112 loc) · 5.7 KB
Raw

ClerkRedirectUrls

(redirectUrls())

Overview

Available Operations

  • create - Create a redirect URL
  • get - Retrieve a redirect URL
  • delete - Delete a redirect URL

create

Create a redirect URL

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.CreateRedirectURLRequestBody;
import com.clerk.backend_api.models.operations.CreateRedirectURLResponse;
import java.lang.Exception;

public class Application {

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

        Clerk sdk = Clerk.builder()
                .bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
            .build();

        CreateRedirectURLRequestBody req = CreateRedirectURLRequestBody.builder()
                .build();

        CreateRedirectURLResponse res = sdk.redirectUrls().create()
                .request(req)
                .call();

        if (res.redirectURL().isPresent()) {
            // handle response
        }
    }
}

Parameters

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

Response

CreateRedirectURLResponse

Errors

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

get

Retrieve the details of the redirect URL with the given ID

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.GetRedirectURLResponse;
import java.lang.Exception;

public class Application {

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

        Clerk sdk = Clerk.builder()
                .bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
            .build();

        GetRedirectURLResponse res = sdk.redirectUrls().get()
                .id("<id>")
                .call();

        if (res.redirectURL().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter Type Required Description
id String ✔️ The ID of the redirect URL

Response

GetRedirectURLResponse

Errors

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

delete

Remove the selected redirect URL from the whitelist 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.DeleteRedirectURLResponse;
import java.lang.Exception;

public class Application {

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

        Clerk sdk = Clerk.builder()
                .bearerAuth("<YOUR_BEARER_TOKEN_HERE>")
            .build();

        DeleteRedirectURLResponse res = sdk.redirectUrls().delete()
                .id("<id>")
                .call();

        if (res.deletedObject().isPresent()) {
            // handle response
        }
    }
}

Parameters

Parameter Type Required Description
id String ✔️ The ID of the redirect URL

Response

DeleteRedirectURLResponse

Errors

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