clerk.update_api_key
ActiveTool of Vee3
declared in 1.27.1
Update an API key in a connected Clerk application. Call clerk.get_connected_accounts first. Pass clerk_instance_id to target a specific connection, or omit it to use the default account. Returns the updated API key summary. Cost = 8 tokens.
Parameters schema
{
"type": "object",
"title": "update_clerk_api_keyArguments",
"required": [
"api_key_id"
],
"properties": {
"claims": {
"anyOf": [
{
"type": "object",
"additionalProperties": true
},
{
"type": "null"
}
],
"title": "Claims",
"default": null,
"description": "Updated custom claims for tokens minted from this API key."
},
"scopes": {
"anyOf": [
{
"type": "array",
"items": {
"type": "string"
}
},
{
"type": "null"
}
],
"title": "Scopes",
"default": null,
"description": "Updated permission scopes for the API key."
},
"subject": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Subject",
"default": null,
"description": "Updated subject (user_... or org_...)."
},
"api_key_id": {
"type": "string",
"title": "Api Key Id",
"description": "Clerk API key id (ak_...) to retrieve, update, delete, or revoke."
},
"description": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Description",
"default": null,
"description": "Updated description for the API key."
},
"clerk_instance_id": {
"anyOf": [
{
"type": "string"
},
{
"type": "null"
}
],
"title": "Clerk Instance Id",
"default": null,
"description": "Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account."
},
"seconds_until_expiration": {
"anyOf": [
{
"type": "number"
},
{
"type": "null"
}
],
"title": "Seconds Until Expiration",
"default": null,
"description": "Updated seconds until expiration from now."
}
}
}Parent server
Vee3
https://github.com/Vee3io/Vee3
1/7 registries