Users

(users())

Available Operations

list - List all users
create - Create a new user
count - Count users
get - Retrieve a user
update - Update a user
delete - Delete a user
ban - Ban a user
unban - Unban a user
lock - Lock a user
unlock - Unlock a user
setProfileImage - Set user profile image
deleteProfileImage - Delete user profile image
updateMetadata - Merge and update a user's metadata
getOAuthAccessToken - Retrieve the OAuth access token of a user
getOrganizationMemberships - Retrieve all memberships for a user
verifyPassword - Verify the password of a user
verifyTOTP - Verify a TOTP or backup code for a user
disableMFA - Disable a user's MFA methods

list

Returns a list of all users. The users are returned sorted by creation date, with the newest users appearing first.

Example Usage

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

            GetUserListRequest req = GetUserListRequest.builder()
                .lastActiveAtSince(1700690400000L)
                .build();

            GetUserListResponse res = sdk.users().list()
                .request(req)
                .call();

            while (true) {
                if (res.userList().isPresent()) {
                    // handle response
                    Optional<GetUserListResponse> nextRes = res.next();
                    if (nextRes.isPresent()) {
                        res = nextRes.get();
                    } else {
                        break;
                    }
                }
            }
        } 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.GetUserListRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.clerk.backend_api.models.operations.GetUserListResponse>

Errors

Error Object	Status Code	Content Type
models/errors/ClerkErrors	400,401,422	application/json
models/errors/SDKError	4xx-5xx	/

create

Creates a new user. Your user management settings determine how you should setup your user model.

Any email address and phone number created using this method will be marked as verified.

Note: If you are performing a migration, check out our guide on zero downtime migrations.

A rate limit rule of 20 requests per 10 seconds is applied to this endpoint.

Example Usage

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

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

            CreateUserResponse res = sdk.users().create()
                .request(req)
                .call();

            if (res.user().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.CreateUserRequestBody	✔️	The request object to use for the request.

Response

Optional<? extends com.clerk.backend_api.models.operations.CreateUserResponse>

Errors

Error Object	Status Code	Content Type
models/errors/ClerkErrors	400,401,403,422	application/json
models/errors/SDKError	4xx-5xx	/

count

Returns a total count of all users that match the given filtering criteria.

Example Usage

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

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

            GetUsersCountResponse res = sdk.users().count()
                .request(req)
                .call();

            if (res.totalCount().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.GetUsersCountRequest	✔️	The request object to use for the request.

Response

Optional<? extends com.clerk.backend_api.models.operations.GetUsersCountResponse>

Errors

Error Object	Status Code	Content Type
models/errors/ClerkErrors	422	application/json
models/errors/SDKError	4xx-5xx	/

get

Retrieve the details of a user

Example Usage

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

            GetUserResponse res = sdk.users().get()
                .userId("<value>")
                .call();

            if (res.user().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
`userId`	String	✔️	The ID of the user to retrieve

Response

Optional<? extends com.clerk.backend_api.models.operations.GetUserResponse>

Errors

Error Object	Status Code	Content Type
models/errors/ClerkErrors	400,401,404	application/json
models/errors/SDKError	4xx-5xx	/

update

Update a user's attributes.

You can set the user's primary contact identifiers (email address and phone numbers) by updating the primary_email_address_id and primary_phone_number_id attributes respectively. Both IDs should correspond to verified identifications that belong to the user.

You can remove a user's username by setting the username attribute to null or the blank string "". This is a destructive action; the identification will be deleted forever. Usernames can be removed only if they are optional in your instance settings and there's at least one other identifier which can be used for authentication.

This endpoint allows changing a user's password. When passing the password parameter directly you have two further options. You can ignore the password policy checks for your instance by setting the skip_password_checks parameter to true. You can also choose to sign the user out of all their active sessions on any device once the password is updated. Just set sign_out_of_other_sessions to true.

Example Usage

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

            UpdateUserResponse res = sdk.users().update()
                .userId("<value>")
                .requestBody(UpdateUserRequestBody.builder()
                    .build())
                .call();

            if (res.user().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
`userId`	String	✔️	The ID of the user to update
`requestBody`	com.clerk.backend_api.models.operations.UpdateUserRequestBody	✔️	N/A

Response

Optional<? extends com.clerk.backend_api.models.operations.UpdateUserResponse>

Errors

Error Object	Status Code	Content Type
models/errors/ClerkErrors	400,401,404,422	application/json
models/errors/SDKError	4xx-5xx	/

delete

Delete the specified user

Example Usage

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

            DeleteUserResponse res = sdk.users().delete()
                .userId("<value>")
                .call();

            if (res.deletedObject().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
`userId`	String	✔️	The ID of the user to delete

Response

Optional<? extends com.clerk.backend_api.models.operations.DeleteUserResponse>

Errors

Error Object	Status Code	Content Type
models/errors/ClerkErrors	400,401,404	application/json
models/errors/SDKError	4xx-5xx	/

ban

Marks the given user as banned, which means that all their sessions are revoked and they are not allowed to sign in again.

Example Usage

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

            BanUserResponse res = sdk.users().ban()
                .userId("<value>")
                .call();

            if (res.user().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
`userId`	String	✔️	The ID of the user to ban

Response

Optional<? extends com.clerk.backend_api.models.operations.BanUserResponse>

Errors

Error Object	Status Code	Content Type
models/errors/ClerkErrors	402	application/json
models/errors/SDKError	4xx-5xx	/

unban

Removes the ban mark from the given user.

Example Usage

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

            UnbanUserResponse res = sdk.users().unban()
                .userId("<value>")
                .call();

            if (res.user().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
`userId`	String	✔️	The ID of the user to unban

Response

Optional<? extends com.clerk.backend_api.models.operations.UnbanUserResponse>

Errors

Error Object	Status Code	Content Type
models/errors/ClerkErrors	402	application/json
models/errors/SDKError	4xx-5xx	/

lock

Marks the given user as locked, which means they are not allowed to sign in again until the lock expires. Lock duration can be configured in the instance's restrictions settings.

Example Usage

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

            LockUserResponse res = sdk.users().lock()
                .userId("<value>")
                .call();

            if (res.user().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
`userId`	String	✔️	The ID of the user to lock

Response

Optional<? extends com.clerk.backend_api.models.operations.LockUserResponse>

Errors

Error Object	Status Code	Content Type
models/errors/ClerkErrors	403	application/json
models/errors/SDKError	4xx-5xx	/

unlock

Removes the lock from the given user.

Example Usage

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

            UnlockUserResponse res = sdk.users().unlock()
                .userId("<value>")
                .call();

            if (res.user().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
`userId`	String	✔️	The ID of the user to unlock

Response

Optional<? extends com.clerk.backend_api.models.operations.UnlockUserResponse>

Errors

Error Object	Status Code	Content Type
models/errors/ClerkErrors	403	application/json
models/errors/SDKError	4xx-5xx	/

setProfileImage

Update a user's profile image

Example Usage

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

            SetUserProfileImageResponse res = sdk.users().setProfileImage()
                .userId("<value>")
                .requestBody(SetUserProfileImageRequestBody.builder()
                    .build())
                .call();

            if (res.user().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
`userId`	String	✔️	The ID of the user to update the profile image for
`requestBody`	com.clerk.backend_api.models.operations.SetUserProfileImageRequestBody	✔️	N/A

Response

Optional<? extends com.clerk.backend_api.models.operations.SetUserProfileImageResponse>

Errors

Error Object	Status Code	Content Type
models/errors/ClerkErrors	400,401,404	application/json
models/errors/SDKError	4xx-5xx	/

deleteProfileImage

Delete a user's profile image

Example Usage

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

            DeleteUserProfileImageResponse res = sdk.users().deleteProfileImage()
                .userId("<value>")
                .call();

            if (res.user().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
`userId`	String	✔️	The ID of the user to delete the profile image for

Response

Optional<? extends com.clerk.backend_api.models.operations.DeleteUserProfileImageResponse>

Errors

Error Object	Status Code	Content Type
models/errors/ClerkErrors	404	application/json
models/errors/SDKError	4xx-5xx	/

updateMetadata

Update a user's metadata attributes by merging existing values with the provided parameters.

This endpoint behaves differently than the Update a user endpoint. Metadata values will not be replaced entirely. Instead, a deep merge will be performed. Deep means that any nested JSON objects will be merged as well.

You can remove metadata keys at any level by setting their value to null.

Example Usage

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

            UpdateUserMetadataResponse res = sdk.users().updateMetadata()
                .userId("<value>")
                .requestBody(UpdateUserMetadataRequestBody.builder()
                    .build())
                .call();

            if (res.user().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
`userId`	String	✔️	The ID of the user whose metadata will be updated and merged
`requestBody`	Optional<? extends com.clerk.backend_api.models.operations.UpdateUserMetadataRequestBody>	➖	N/A

Response

Optional<? extends com.clerk.backend_api.models.operations.UpdateUserMetadataResponse>

Errors

Error Object	Status Code	Content Type
models/errors/ClerkErrors	400,401,404,422	application/json
models/errors/SDKError	4xx-5xx	/

getOAuthAccessToken

Fetch the corresponding OAuth access token for a user that has previously authenticated with a particular OAuth provider. For OAuth 2.0, if the access token has expired and we have a corresponding refresh token, the access token will be refreshed transparently the new one will be returned.

Example Usage

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

            GetOAuthAccessTokenResponse res = sdk.users().getOAuthAccessToken()
                .userId("<value>")
                .provider("<value>")
                .call();

            if (res.responseBodies().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
`userId`	String	✔️	The ID of the user for which to retrieve the OAuth access token
`provider`	String	✔️	The ID of the OAuth provider (e.g. `oauth_google`)

Response

Optional<? extends com.clerk.backend_api.models.operations.GetOAuthAccessTokenResponse>

Errors

Error Object	Status Code	Content Type
models/errors/ClerkErrors	422	application/json
models/errors/SDKError	4xx-5xx	/

getOrganizationMemberships

Retrieve a paginated list of the user's organization memberships

Example Usage

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

            UsersGetOrganizationMembershipsResponse res = sdk.users().getOrganizationMemberships()
                .userId("<value>")
                .limit(10L)
                .offset(0L)
                .call();

            while (true) {
                if (res.organizationMemberships().isPresent()) {
                    // handle response
                    Optional<UsersGetOrganizationMembershipsResponse> nextRes = res.next();
                    if (nextRes.isPresent()) {
                        res = nextRes.get();
                    } else {
                        break;
                    }
                }
            }
        } 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
`userId`	String	✔️	The ID of the user whose organization memberships we want to retrieve
`limit`	Optional<? extends Long>	➖	Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
`offset`	Optional<? extends 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

Optional<? extends com.clerk.backend_api.models.operations.UsersGetOrganizationMembershipsResponse>

Errors

Error Object	Status Code	Content Type
models/errors/ClerkErrors	403	application/json
models/errors/SDKError	4xx-5xx	/

verifyPassword

Check that the user's password matches the supplied input. Useful for custom auth flows and re-verification.

Example Usage

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

            VerifyPasswordResponse res = sdk.users().verifyPassword()
                .userId("<value>")
                .requestBody(VerifyPasswordRequestBody.builder()
                    .password("<value>")
                    .build())
                .call();

            if (res.object().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
`userId`	String	✔️	The ID of the user for whom to verify the password
`requestBody`	Optional<? extends com.clerk.backend_api.models.operations.VerifyPasswordRequestBody>	➖	N/A

Response

Optional<? extends com.clerk.backend_api.models.operations.VerifyPasswordResponse>

Errors

Error Object	Status Code	Content Type
models/errors/ClerkErrors	500	application/json
models/errors/SDKError	4xx-5xx	/

verifyTOTP

Verify that the provided TOTP or backup code is valid for the user. Verifying a backup code will result it in being consumed (i.e. it will become invalid). Useful for custom auth flows and re-verification.

Example Usage

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

            VerifyTOTPResponse res = sdk.users().verifyTOTP()
                .userId("<value>")
                .requestBody(VerifyTOTPRequestBody.builder()
                    .code("<value>")
                    .build())
                .call();

            if (res.object().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
`userId`	String	✔️	The ID of the user for whom to verify the TOTP
`requestBody`	Optional<? extends com.clerk.backend_api.models.operations.VerifyTOTPRequestBody>	➖	N/A

Response

Optional<? extends com.clerk.backend_api.models.operations.VerifyTOTPResponse>

Errors

Error Object	Status Code	Content Type
models/errors/ClerkErrors	500	application/json
models/errors/SDKError	4xx-5xx	/

disableMFA

Disable all of a user's MFA methods (e.g. OTP sent via SMS, TOTP on their authenticator app) at once.

Example Usage

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

            DisableMFAResponse res = sdk.users().disableMFA()
                .userId("<value>")
                .call();

            if (res.object().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
`userId`	String	✔️	The ID of the user whose MFA methods are to be disabled

Response

Optional<? extends com.clerk.backend_api.models.operations.DisableMFAResponse>

Errors

Error Object	Status Code	Content Type
models/errors/ClerkErrors	404,500	application/json
models/errors/SDKError	4xx-5xx	/

Files

README.md

Latest commit

History

README.md

File metadata and controls

Users

Available Operations

list

Example Usage

Parameters

Response

Errors

create

Example Usage

Parameters

Response

Errors

count

Example Usage

Parameters

Response

Errors

get

Example Usage

Parameters

Response

Errors

update

Example Usage

Parameters

Response

Errors

delete

Example Usage

Parameters

Response

Errors

ban

Example Usage

Parameters

Response

Errors

unban

Example Usage

Parameters

Response

Errors

lock

Example Usage

Parameters

Response

Errors

unlock

Example Usage

Parameters

Response

Errors

setProfileImage

Example Usage

Parameters

Response

Errors

deleteProfileImage

Example Usage

Parameters

Response

Errors

updateMetadata

Example Usage

Parameters

Response

Errors

getOAuthAccessToken

Example Usage

Parameters

Response

Errors

getOrganizationMemberships

Example Usage