Clerk docs

User

Used to interact with the properties of the current user.

Get User

Returns all attributes of the current user.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
query Parameters
_clerk_session_id
string

The session_id associated with the requesting user.

Responses
200

Returns the response for Session wrapped User object.

401

Request was not successful

403

Request was not successful

404

Request was not successful

get/v1/me
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Update User

Update the current user with the given attributes.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
query Parameters
_clerk_session_id
string
Request Body schema: application/x-www-form-urlencoded
first_name
string or null
last_name
string or null
username
string or null
password
string or null
primary_email_address_id
string or null
primary_phone_number_id
string or null
primary_web3_wallet_id
string or null
public_metadata
string or null

A stringified JSON containing the public metadata of the current user.

private_metadata
string or null

A stringified JSON containing the private metadata of the current user.

unsafe_metadata
string or null

A stringified JSON containing the unsafe metadata of the current user.

profile_image_id
string or null

The profile image ID of the current user.

Responses
200

Returns the response for Session wrapped User object.

400

Request was not successful

401

Request was not successful

403

Request was not successful

404

Request was not successful

422

Request was not successful

patch/v1/me
Request samples
application/x-www-form-urlencoded
first_name=string&last_name=string&username=string&password=string&primary_email_address_id=string&primary_phone_number_id=string&primary_web3_wallet_id=string&public_metadata=string&private_metadata=string&unsafe_metadata=string&profile_image_id=string
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Delete User

Delete the current user.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
query Parameters
_clerk_session_id
string
Responses
200

Returns a deleted generic object.

401

Request was not successful

403

Request was not successful

404

Request was not successful

500

Request was not successful

delete/v1/me
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

createServiceToken

create a jwt for the requested user.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
query Parameters
_clerk_session_id
string

The session_id associated with the requesting user.

Request Body schema: application/x-www-form-urlencoded
service
required
string
Responses
200

Success

403

Request was not successful

404

Request was not successful

422

Request was not successful

post/v1/me/tokens
Request samples
application/x-www-form-urlencoded
service=string
Response samples
application/json
{
  • "object": "token",
  • "jwt": "string"
}

Update Profile Image

Update the current user's profile image.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
query Parameters
_clerk_session_id
string

The session_id associated with the requesting user.

Request Body schema:
required
file
string <binary>
Responses
200

Returns an Image object.

400

Request was not successful

401

Request was not successful

422

Request was not successful

post/v1/me/profile_image
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Delete Profile Image

Remove the current user's profile image.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
query Parameters
_clerk_session_id
string

The session_id associated with the requesting user.

Responses
200

Returns a deleted generic object.

401

Request was not successful

404

Request was not successful

delete/v1/me/profile_image
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Update Password

Update the current user's password.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
query Parameters
_clerk_session_id
string

The session_id associated with the requesting user.

Request Body schema: application/x-www-form-urlencoded
current_password
string or null
new_password
required
string
sign_out_of_other_sessions
boolean or null
Responses
200

Returns the response for Session wrapped User object.

400

Request was not successful

403

Request was not successful

422

Request was not successful

post/v1/me/change_password
Request samples
application/x-www-form-urlencoded
current_password=string&new_password=string&sign_out_of_other_sessions=true
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}

Delete Password

Removes the current user's password.

SecurityNone or DevBrowser or ProductionBrowser or ProductionNativeApp and ProductionNativeFlag)
Request
query Parameters
_clerk_session_id
string

The session_id associated with the requesting user.

Request Body schema: application/x-www-form-urlencoded
required
current_password
required
string
Responses
200

Returns the response for Session wrapped User object.

400

Request was not successful

422

Request was not successful

post/v1/me/remove_password
Request samples
application/x-www-form-urlencoded
current_password=string
Response samples
application/json
{
  • "response": {
    },
  • "client": {
    }
}
➔ Next to Active Sessions