Skip to content

README.md

Latest commit

 

History

History
168 lines (116 loc) · 8.27 KB

README.md

File metadata and controls

168 lines (116 loc) · 8.27 KB

Clients

Overview

Available Operations

  • list - List all clients ⚠️ Deprecated
  • verify - Verify a client
  • get - Get a client

list

Returns a list of all clients. The clients are returned sorted by creation date, with the newest clients appearing first. Warning: the endpoint is being deprecated and will be removed in future versions.

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

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.GetClientListResponse;
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();

        GetClientListResponse res = sdk.clients().list()
                .limit(10L)
                .offset(0L)
                .call();

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

Parameters

Parameter Type Required Description
paginated Optional<Boolean> ➖ Whether to paginate the results.
If true, the results will be paginated.
If false, the results will not be paginated.
limit Optional<Long> ➖ Applies a limit to the number of results returned.
Can be used for paginating the results together with offset.
offset Optional<Long> ➖ Skip the first offset results when paginating.
Needs to be an integer greater or equal to zero.
To be used in conjunction with limit.

Response

GetClientListResponse

Errors

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

verify

Verifies the client in the provided token

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.VerifyClientResponse;
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();

        VerifyClientResponse res = sdk.clients().verify()
                .call();

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

Parameters

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

Response

VerifyClientResponse

Errors

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

get

Returns the details of a client.

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.GetClientResponse;
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();

        GetClientResponse res = sdk.clients().get()
                .clientId("<id>")
                .call();

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

Parameters

Parameter Type Required Description
clientId String ✔️ Client ID.

Response

GetClientResponse

Errors

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