archive_identity
Toggle the archive flag for an identity to manage its active state. Returns the updated identity with the new archive status.
Instructions
Toggle the archive flag for an identity. Returns the updated identity with the new archive state.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| identityId | Yes | The ID of the identity to toggle the archive flag for |
Implementation Reference
- src/tools/archiveIdentity.ts:10-13 (handler)The handler function that executes the 'archive_identity' tool logic. It calls the Admina API PUT /identity/{identityId}/archive to toggle the archive flag.
export async function archiveIdentity(params: ArchiveIdentityParams) { const client = getClient(); return client.makePutApiCall(`/identity/${params.identityId}/archive`, {}); } - src/tools/archiveIdentity.ts:4-6 (schema)Zod schema for the archive_identity tool input. Requires a single string field 'identityId'.
export const ArchiveIdentitySchema = z.object({ identityId: z.string().describe("The ID of the identity to toggle the archive flag for"), }); - src/index.ts:261-264 (registration)Tool registration in the server's tool list with name 'archive_identity', description, and input schema.
name: "archive_identity", description: "Toggle the archive flag for an identity. Returns the updated identity with the new archive state.", inputSchema: zodToJsonSchema(ArchiveIdentitySchema), - src/index.ts:326-326 (registration)Tool handler mapping in the toolHandlers record, linking 'archive_identity' name to the archiveIdentity function.
archive_identity: async (input) => archiveIdentity(ArchiveIdentitySchema.parse(input)), - src/tools/index.ts:30-31 (helper)Re-exports archiveIdentity from src/tools/archiveIdentity.js via barrel export.
export * from "./archiveIdentity.js"; export * from "./unregisterIdentity.js";