get_identity_custom_fields
Retrieve all custom fields configured for organizational identities, including field definitions, types (text, date, number, dropdown), and configurations.
Instructions
Get all identity custom fields configured for an organization. Returns field definitions, types (text, date, number, dropdown), and configurations.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||
Implementation Reference
- src/tools/getIdentityCustomField.ts:9-12 (handler)The getIdentityCustomFields async function that executes the tool logic. It calls the API endpoint '/identity/fields/custom' to retrieve all identity custom field configurations for an organization.
export async function getIdentityCustomFields() { const client = getClient(); return client.makeApiCall("/identity/fields/custom", new URLSearchParams()); } - Input schema for the tool - an empty Zod object since no input parameters are needed.
export const IdentityCustomFieldsFiltersSchema = z.object({}); - src/index.ts:218-222 (registration)Tool registration in the ListToolsRequestSchema handler - defines the tool name 'get_identity_custom_fields' and its description and input schema.
{ name: "get_identity_custom_fields", description: "Get all identity custom fields configured for an organization. Returns field definitions, types (text, date, number, dropdown), and configurations.", inputSchema: zodToJsonSchema(IdentityCustomFieldsFiltersSchema), - src/index.ts:318-318 (registration)Tool handler mapping in toolHandlers map - wires 'get_identity_custom_fields' to the getIdentityCustomFields() function.
get_identity_custom_fields: async () => getIdentityCustomFields(), - Imports: zod for schema validation, and getClient from the admina-api helper module.
import { z } from "zod"; import { getClient } from "../admina-api.js"; // No input parameters needed export const IdentityCustomFieldsFiltersSchema = z.object({}); export type IdentityCustomFieldsFilters = z.infer<typeof IdentityCustomFieldsFiltersSchema>; export async function getIdentityCustomFields() { const client = getClient(); return client.makeApiCall("/identity/fields/custom", new URLSearchParams()); }