Struct ClerkClient 

pub struct ClerkClient { /* private fields */ }

Entrypoint for interacting with the Clerk Backend API

Implementations

impl ClerkClient

pub fn new<K>(secret_key: K) -> Result<Self>

where K: ToString,

Create a new Clerk client struct. It takes a secret key (starts with sk_)

pub fn new_from_env() -> Result<Self>

Create a new Clerk client struct from environment variables

pub fn get_key(&self) -> &str

Get the currently set secret key

pub async fn list_users(&self, params: ListUsersParams) -> Result<Vec<User>>

List users GET /users

pub async fn get_user(&self, user_id: &str) -> Result<User>

Get a user by ID GET /users/{user_id}

pub async fn create_user(&self, req: CreateUserRequest) -> Result<User>

Create a new user POST /users

pub async fn update_user( &self, user_id: &str, req: UpdateUserRequest, ) -> Result<User>

Update a user PATCH /users/{user_id}

pub async fn delete_user(&self, user_id: &str) -> Result<DeletedObject>

Delete a user DELETE /users/{user_id}

pub async fn list_sessions( &self, params: ListSessionsParams, ) -> Result<Vec<Session>>

List sessions GET /sessions

pub async fn get_session(&self, session_id: &str) -> Result<Session>

Get a session by ID GET /sessions/{session_id}

pub async fn verify_session(&self, session_id: &str) -> Result<Session>

Verify a session token POST /sessions/{session_id}/verify

pub async fn revoke_session(&self, session_id: &str) -> Result<Session>

Revoke a session POST /sessions/{session_id}/revoke

pub async fn list_organizations( &self, params: ListOrganizationsParams, ) -> Result<Vec<Organization>>

List organizations GET /organizations

pub async fn get_organization( &self, organization_id: &str, ) -> Result<Organization>

Get an organization by ID GET /organizations/{organization_id}

pub async fn create_organization( &self, req: CreateOrganizationRequest, ) -> Result<Organization>

Create an organization POST /organizations

pub async fn update_organization( &self, organization_id: &str, req: UpdateOrganizationRequest, ) -> Result<Organization>

Update an organization PATCH /organizations/{organization_id}

pub async fn delete_organization( &self, organization_id: &str, ) -> Result<DeletedObject>

Delete an organization DELETE /organizations/{organization_id}