delete_identity_custom_field
Delete an identity custom field from your organization by providing its ID. Removes the custom field definition permanently.
Instructions
Delete an identity custom field for an organization. Removes a custom field definition from the organization.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| customFieldId | Yes | The ID of the custom field to delete. Make sure user wants to delete an identity custom field and not a device custom field |
Implementation Reference
- The handler function that executes the tool logic. It calls the Admina API DELETE endpoint `/identity/fields/custom/{customFieldId}` to delete an identity custom field.
export async function deleteIdentityCustomField(params: DeleteIdentityCustomFieldParams) { const client = getClient(); return client.makeDeleteApiCall(`/identity/fields/custom/${params.customFieldId}`); } - Zod schema defining the input: a required `customFieldId` (number) with a description clarifying it's for identity (not device) custom fields.
export const DeleteIdentityCustomFieldSchema = z.object({ customFieldId: z .number() .describe( "The ID of the custom field to delete. Make sure user wants to delete an identity custom field and not a device custom field", ), }); - src/tools/index.ts:22-22 (helper)Re-export from the tools barrel index file, making the module publicly accessible.
export * from "./deleteIdentityCustomField.js";