--- title: User Profiles url: https://platform.claude.com/docs/en/api/csharp/beta/user_profiles --- # User Profiles ## Create User Profile `BetaUserProfile Beta.UserProfiles.Create(parameters, cancellationToken = default)` **POST** `/v1/user_profiles` Create User Profile ### Parameters - `UserProfileCreateParams parameters` - `AccessType accessType` How the platform uses the API for this entity. `application` (default): the profile represents an individual end-user of the platform's product. `passthrough`: the profile identifies a company the platform resells Claude access to. - `Application("application")` The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default. - `Passthrough("passthrough")` The user profile represents a company that the platform resells Claude access to. - `string? externalID` Platform's own identifier for this user. Not enforced unique. Maximum 255 characters. Legacy field, accepted only under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; without one of them, send `external_user_details.reference_id`. minLength: 1, maxLength: 255 - `BetaUserProfileExternalUserDetailsParams externalUserDetails` Details about the entity this profile represents, as the platform states them. Every field is optional. Not accepted under the legacy `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers, which take the top-level `external_id` (and, under `user-profiles-2026-08-18`, `external_user_onboarded_at`) instead. - `DateTimeOffset externalUserOnboardedAt` When the entity this profile represents opened its account with the platform, in RFC 3339 format: for an `application` profile, when the end-user signed up; for a `passthrough` profile, when the company became the platform's customer. Must be a complete timestamp no more than 1 minute in the future. Optional. Legacy field, accepted only under the `user-profiles-2026-08-18` beta header; without a legacy header, send `external_user_details.onboarded_at`. format: date-time - `IReadOnlyDictionary metadata` Free-form key-value data to attach to this user profile. Maximum 16 keys, with keys up to 64 characters and values up to 512 characters. Values must be non-empty strings. - `string? name` Optional for all profiles. Real-world name of the entity this profile represents (company or individual); for a company the platform resells Claude access to (`access_type` `passthrough`), that company's name where known. Maximum 255 characters. minLength: 1, maxLength: 255 - `IReadOnlyList betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MessageBatches2024_09_24("message-batches-2024-09-24")` - `PromptCaching2024_07_31("prompt-caching-2024-07-31")` - `ComputerUse2024_10_22("computer-use-2024-10-22")` - `ComputerUse2025_01_24("computer-use-2025-01-24")` - `Pdfs2024_09_25("pdfs-2024-09-25")` - `TokenCounting2024_11_01("token-counting-2024-11-01")` - `TokenEfficientTools2025_02_19("token-efficient-tools-2025-02-19")` - `Output128k2025_02_19("output-128k-2025-02-19")` - `FilesApi2025_04_14("files-api-2025-04-14")` - `McpClient2025_04_04("mcp-client-2025-04-04")` - `McpClient2025_11_20("mcp-client-2025-11-20")` - `DevFullThinking2025_05_14("dev-full-thinking-2025-05-14")` - `InterleavedThinking2025_05_14("interleaved-thinking-2025-05-14")` - `CodeExecution2025_05_22("code-execution-2025-05-22")` - `ExtendedCacheTtl2025_04_11("extended-cache-ttl-2025-04-11")` - `Context1m2025_08_07("context-1m-2025-08-07")` - `ContextManagement2025_06_27("context-management-2025-06-27")` - `ModelContextWindowExceeded2025_08_26("model-context-window-exceeded-2025-08-26")` - `Skills2025_10_02("skills-2025-10-02")` - `FastMode2026_02_01("fast-mode-2026-02-01")` - `Output300k2026_03_24("output-300k-2026-03-24")` - `UserProfiles2026_03_24("user-profiles-2026-03-24")` - `UserProfiles2026_08_18("user-profiles-2026-08-18")` - `UserProfiles2026_09_04("user-profiles-2026-09-04")` - `AdvisorTool2026_03_01("advisor-tool-2026-03-01")` - `ManagedAgents2026_04_01("managed-agents-2026-04-01")` - `CacheDiagnosis2026_04_07("cache-diagnosis-2026-04-07")` - `Dreaming2026_04_21("dreaming-2026-04-21")` - `ThinkingTokenCount2026_05_13("thinking-token-count-2026-05-13")` - `ServerSideFallback2026_06_01("server-side-fallback-2026-06-01")` - `ServerSideFallback2026_07_01("server-side-fallback-2026-07-01")` - `FallbackCredit2026_06_01("fallback-credit-2026-06-01")` - `FallbackCredit2026_07_01("fallback-credit-2026-07-01")` - `AgentMemory2026_07_22("agent-memory-2026-07-22")` - `MidConversationToolChanges2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `Compact2026_01_12("compact-2026-01-12")` - `ComputerUse2025_11_24("computer-use-2025-11-24")` - `McpTunnels2026_06_22("mcp-tunnels-2026-06-22")` - `StructuredOutputs2025_11_13("structured-outputs-2025-11-13")` - `TaskBudgets2026_03_13("task-budgets-2026-03-13")` - `ThinkingDisplayUpdates2026_08_18("thinking-display-updates-2026-08-18")` - `CEUserManagement2026_07_13("ce-user-management-2026-07-13")` - `MidConversationOutputConfig2026_07_01("mid-conversation-output-config-2026-07-01")` - `ThinkingBindingControls2026_08_01("thinking-binding-controls-2026-08-01")` - `MidConversationSystemClearAt2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `Compact2026_09_04("compact-2026-09-04")` - `InlineTools2026_09_15("inline-tools-2026-09-15")` - `McpClient2026_09_15("mcp-client-2026-09-15")` - `CEPlugins2026_09_01("ce-plugins-2026-09-01")` - `SpendLimitReads2026_09_26("spend-limit-reads-2026-09-26")` - `TelemetryDestinations2026_08_11("telemetry-destinations-2026-08-11")` - `Webhooks2026_10_07("webhooks-2026-10-07")` - `MessageThreads2026_08_12("message-threads-2026-08-12")` - `AnalyticsUsageCost2026_08_24("analytics-usage-cost-2026-08-24")` - `ExperimentalClaudeTag2026_10_21("experimental-claude-tag-2026-10-21")` - `string workspaceID` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ### Returns - `class BetaUserProfile` A record of an entity that the platform serves through the API, such as an end-user of the platform's product or a company that the platform resells Claude access to. A Messages, Message Batches or token counting request can send a profile's `id` in the `anthropic-user-profile-id` header to attribute the request to that entity. - `JsonElement Type = "user_profile"` Object type. Always `user_profile`. - `required string ID` Unique identifier for this user profile, prefixed `uprof_`. - `required DateTimeOffset CreatedAt` When this user profile was created, in RFC 3339 format. format: date-time - `required IReadOnlyDictionary Metadata` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `required string? Name` Real-world name of the entity this profile represents (company or individual). For a company the platform resells Claude access to (`access_type` `passthrough`) this is that company's name. `null` until the platform supplies one. - `required IReadOnlyDictionary TrustGrants` Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight. - `required Status Status` Status of the trust grant. - `Active("active")` - `Pending("pending")` - `Rejected("rejected")` - `required DateTimeOffset UpdatedAt` When this user profile was last modified, in RFC 3339 format. It normally also updates shortly after Anthropic gives the profile an approval or withdraws one. Other changes to the statuses that Anthropic reports do not always update it, so read the status itself rather than watching this timestamp. format: date-time - `AccessType AccessType` How the platform uses the API for this entity: `application` (default) or `passthrough`. Absent under the legacy `user-profiles-2026-03-24` beta header. - `Application("application")` The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default. - `Passthrough("passthrough")` The user profile represents a company that the platform resells Claude access to. - `string? ExternalID` Platform's own identifier for this user. Not enforced unique. Legacy field, present only under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; without one of them, the value is `external_user_details.reference_id`. - `BetaUserProfileExternalUserDetails ExternalUserDetails` Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Every field is present, `null` until the platform supplies a value. Absent under the legacy `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers, which serve `reference_id` as the top-level `external_id` and, under `user-profiles-2026-08-18`, `onboarded_at` as `external_user_onboarded_at`. - `required AccountStatus? AccountStatus` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. `null` until the platform supplies one. - `Active("active")` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `Suspended("suspended")` The platform has restricted the account of the entity that the user profile represents and may restore it. - `Blocked("blocked")` The platform has barred the account of the entity that the user profile represents. - `required string? Country` The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one. - `required string? EmailHash` The platform-computed hash of the entity's email address. `null` until the platform supplies one. - `required EntityType? EntityType` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. `null` until the platform supplies one. - `Individual("individual")` - `Business("business")` - `NonProfit("non_profit")` - `Government("government")` - `required string? NameHash` The platform-computed hash of the entity's name. `null` until the platform supplies one. - `required DateTimeOffset? OnboardedAt` When the entity opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. format: date-time - `required string? ReferenceID` The platform's own reference for the entity. `null` until the platform supplies one. - `DateTimeOffset? ExternalUserOnboardedAt` When the entity this profile represents opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. Legacy field, present only under the `user-profiles-2026-08-18` beta header; without a legacy header, the value is `external_user_details.onboarded_at`. format: date-time ### Example ```csharp using System; using Anthropic.Models.Beta.UserProfiles; UserProfileCreateParams parameters = new(); var betaUserProfile = await client.Beta.UserProfiles.Create(parameters); Console.WriteLine(betaUserProfile); ``` #### Response (200) ```json { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, "name": "Example User", "trust_grants": { "cyber": { "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", "access_type": "application", "external_id": "user_12345", "external_user_details": { "account_status": "active", "country": "US", "email_hash": null, "entity_type": "business", "name_hash": null, "onboarded_at": "2024-11-02T08:15:00Z", "reference_id": "user_12345" }, "external_user_onboarded_at": "2024-11-02T08:15:00Z" } ``` ## List User Profiles `UserProfileListPage Beta.UserProfiles.List(parameters, cancellationToken = default)` **GET** `/v1/user_profiles` List User Profiles ### Parameters - `UserProfileListParams parameters` - `int limit` (query parameter) The maximum number of user profiles to return, from 1 to 100. Defaults to 20. format: int32 - `Order order` (query parameter) The sort direction, applied to the field that `order_by` selects. Defaults to `desc`. - `Asc("asc")` Oldest first when `order_by` is `created_at`, or names in ascending order when `order_by` is `name`. - `Desc("desc")` Newest first when `order_by` is `created_at`, or names in descending order when `order_by` is `name`. This is the default. - `OrderBy orderBy` (query parameter) The field to sort user profiles by, in the direction that `order` sets. Defaults to `created_at`. - `CreatedAt("created_at")` Sort by when each user profile was created. This is the default. - `Name("name")` Sort by `name`, ignoring the case of ASCII letters. Profiles without a name come last in either direction. - `string page` (query parameter) The cursor for the page to return, taken from `next_page` in a previous response. Leave it out to get the first page. - `IReadOnlyList betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MessageBatches2024_09_24("message-batches-2024-09-24")` - `PromptCaching2024_07_31("prompt-caching-2024-07-31")` - `ComputerUse2024_10_22("computer-use-2024-10-22")` - `ComputerUse2025_01_24("computer-use-2025-01-24")` - `Pdfs2024_09_25("pdfs-2024-09-25")` - `TokenCounting2024_11_01("token-counting-2024-11-01")` - `TokenEfficientTools2025_02_19("token-efficient-tools-2025-02-19")` - `Output128k2025_02_19("output-128k-2025-02-19")` - `FilesApi2025_04_14("files-api-2025-04-14")` - `McpClient2025_04_04("mcp-client-2025-04-04")` - `McpClient2025_11_20("mcp-client-2025-11-20")` - `DevFullThinking2025_05_14("dev-full-thinking-2025-05-14")` - `InterleavedThinking2025_05_14("interleaved-thinking-2025-05-14")` - `CodeExecution2025_05_22("code-execution-2025-05-22")` - `ExtendedCacheTtl2025_04_11("extended-cache-ttl-2025-04-11")` - `Context1m2025_08_07("context-1m-2025-08-07")` - `ContextManagement2025_06_27("context-management-2025-06-27")` - `ModelContextWindowExceeded2025_08_26("model-context-window-exceeded-2025-08-26")` - `Skills2025_10_02("skills-2025-10-02")` - `FastMode2026_02_01("fast-mode-2026-02-01")` - `Output300k2026_03_24("output-300k-2026-03-24")` - `UserProfiles2026_03_24("user-profiles-2026-03-24")` - `UserProfiles2026_08_18("user-profiles-2026-08-18")` - `UserProfiles2026_09_04("user-profiles-2026-09-04")` - `AdvisorTool2026_03_01("advisor-tool-2026-03-01")` - `ManagedAgents2026_04_01("managed-agents-2026-04-01")` - `CacheDiagnosis2026_04_07("cache-diagnosis-2026-04-07")` - `Dreaming2026_04_21("dreaming-2026-04-21")` - `ThinkingTokenCount2026_05_13("thinking-token-count-2026-05-13")` - `ServerSideFallback2026_06_01("server-side-fallback-2026-06-01")` - `ServerSideFallback2026_07_01("server-side-fallback-2026-07-01")` - `FallbackCredit2026_06_01("fallback-credit-2026-06-01")` - `FallbackCredit2026_07_01("fallback-credit-2026-07-01")` - `AgentMemory2026_07_22("agent-memory-2026-07-22")` - `MidConversationToolChanges2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `Compact2026_01_12("compact-2026-01-12")` - `ComputerUse2025_11_24("computer-use-2025-11-24")` - `McpTunnels2026_06_22("mcp-tunnels-2026-06-22")` - `StructuredOutputs2025_11_13("structured-outputs-2025-11-13")` - `TaskBudgets2026_03_13("task-budgets-2026-03-13")` - `ThinkingDisplayUpdates2026_08_18("thinking-display-updates-2026-08-18")` - `CEUserManagement2026_07_13("ce-user-management-2026-07-13")` - `MidConversationOutputConfig2026_07_01("mid-conversation-output-config-2026-07-01")` - `ThinkingBindingControls2026_08_01("thinking-binding-controls-2026-08-01")` - `MidConversationSystemClearAt2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `Compact2026_09_04("compact-2026-09-04")` - `InlineTools2026_09_15("inline-tools-2026-09-15")` - `McpClient2026_09_15("mcp-client-2026-09-15")` - `CEPlugins2026_09_01("ce-plugins-2026-09-01")` - `SpendLimitReads2026_09_26("spend-limit-reads-2026-09-26")` - `TelemetryDestinations2026_08_11("telemetry-destinations-2026-08-11")` - `Webhooks2026_10_07("webhooks-2026-10-07")` - `MessageThreads2026_08_12("message-threads-2026-08-12")` - `AnalyticsUsageCost2026_08_24("analytics-usage-cost-2026-08-24")` - `ExperimentalClaudeTag2026_10_21("experimental-claude-tag-2026-10-21")` - `string workspaceID` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ### Returns - `class BetaUserProfile` A record of an entity that the platform serves through the API, such as an end-user of the platform's product or a company that the platform resells Claude access to. A Messages, Message Batches or token counting request can send a profile's `id` in the `anthropic-user-profile-id` header to attribute the request to that entity. - `JsonElement Type = "user_profile"` Object type. Always `user_profile`. - `required string ID` Unique identifier for this user profile, prefixed `uprof_`. - `required DateTimeOffset CreatedAt` When this user profile was created, in RFC 3339 format. format: date-time - `required IReadOnlyDictionary Metadata` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `required string? Name` Real-world name of the entity this profile represents (company or individual). For a company the platform resells Claude access to (`access_type` `passthrough`) this is that company's name. `null` until the platform supplies one. - `required IReadOnlyDictionary TrustGrants` Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight. - `required Status Status` Status of the trust grant. - `Active("active")` - `Pending("pending")` - `Rejected("rejected")` - `required DateTimeOffset UpdatedAt` When this user profile was last modified, in RFC 3339 format. It normally also updates shortly after Anthropic gives the profile an approval or withdraws one. Other changes to the statuses that Anthropic reports do not always update it, so read the status itself rather than watching this timestamp. format: date-time - `AccessType AccessType` How the platform uses the API for this entity: `application` (default) or `passthrough`. Absent under the legacy `user-profiles-2026-03-24` beta header. - `Application("application")` The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default. - `Passthrough("passthrough")` The user profile represents a company that the platform resells Claude access to. - `string? ExternalID` Platform's own identifier for this user. Not enforced unique. Legacy field, present only under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; without one of them, the value is `external_user_details.reference_id`. - `BetaUserProfileExternalUserDetails ExternalUserDetails` Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Every field is present, `null` until the platform supplies a value. Absent under the legacy `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers, which serve `reference_id` as the top-level `external_id` and, under `user-profiles-2026-08-18`, `onboarded_at` as `external_user_onboarded_at`. - `required AccountStatus? AccountStatus` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. `null` until the platform supplies one. - `Active("active")` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `Suspended("suspended")` The platform has restricted the account of the entity that the user profile represents and may restore it. - `Blocked("blocked")` The platform has barred the account of the entity that the user profile represents. - `required string? Country` The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one. - `required string? EmailHash` The platform-computed hash of the entity's email address. `null` until the platform supplies one. - `required EntityType? EntityType` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. `null` until the platform supplies one. - `Individual("individual")` - `Business("business")` - `NonProfit("non_profit")` - `Government("government")` - `required string? NameHash` The platform-computed hash of the entity's name. `null` until the platform supplies one. - `required DateTimeOffset? OnboardedAt` When the entity opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. format: date-time - `required string? ReferenceID` The platform's own reference for the entity. `null` until the platform supplies one. - `DateTimeOffset? ExternalUserOnboardedAt` When the entity this profile represents opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. Legacy field, present only under the `user-profiles-2026-08-18` beta header; without a legacy header, the value is `external_user_details.onboarded_at`. format: date-time ### Example ```csharp using System; using Anthropic.Models.Beta.UserProfiles; UserProfileListParams parameters = new(); var page = await client.Beta.UserProfiles.List(parameters); await foreach (var item in page.Paginate()) { Console.WriteLine(item); } ``` #### Response (200) ```json { "data": [ { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, "name": "Example User", "trust_grants": { "cyber": { "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", "access_type": "application", "external_id": "user_12345", "external_user_details": { "account_status": "active", "country": "US", "email_hash": null, "entity_type": "business", "name_hash": null, "onboarded_at": "2024-11-02T08:15:00Z", "reference_id": "user_12345" }, "external_user_onboarded_at": "2024-11-02T08:15:00Z" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Get User Profile `BetaUserProfile Beta.UserProfiles.Retrieve(parameters, cancellationToken = default)` **GET** `/v1/user_profiles/{user_profile_id}` Get User Profile ### Parameters - `UserProfileRetrieveParams parameters` - `required string userProfileID` (path parameter) The ID of the user profile to get (`uprof_...`). - `IReadOnlyList betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MessageBatches2024_09_24("message-batches-2024-09-24")` - `PromptCaching2024_07_31("prompt-caching-2024-07-31")` - `ComputerUse2024_10_22("computer-use-2024-10-22")` - `ComputerUse2025_01_24("computer-use-2025-01-24")` - `Pdfs2024_09_25("pdfs-2024-09-25")` - `TokenCounting2024_11_01("token-counting-2024-11-01")` - `TokenEfficientTools2025_02_19("token-efficient-tools-2025-02-19")` - `Output128k2025_02_19("output-128k-2025-02-19")` - `FilesApi2025_04_14("files-api-2025-04-14")` - `McpClient2025_04_04("mcp-client-2025-04-04")` - `McpClient2025_11_20("mcp-client-2025-11-20")` - `DevFullThinking2025_05_14("dev-full-thinking-2025-05-14")` - `InterleavedThinking2025_05_14("interleaved-thinking-2025-05-14")` - `CodeExecution2025_05_22("code-execution-2025-05-22")` - `ExtendedCacheTtl2025_04_11("extended-cache-ttl-2025-04-11")` - `Context1m2025_08_07("context-1m-2025-08-07")` - `ContextManagement2025_06_27("context-management-2025-06-27")` - `ModelContextWindowExceeded2025_08_26("model-context-window-exceeded-2025-08-26")` - `Skills2025_10_02("skills-2025-10-02")` - `FastMode2026_02_01("fast-mode-2026-02-01")` - `Output300k2026_03_24("output-300k-2026-03-24")` - `UserProfiles2026_03_24("user-profiles-2026-03-24")` - `UserProfiles2026_08_18("user-profiles-2026-08-18")` - `UserProfiles2026_09_04("user-profiles-2026-09-04")` - `AdvisorTool2026_03_01("advisor-tool-2026-03-01")` - `ManagedAgents2026_04_01("managed-agents-2026-04-01")` - `CacheDiagnosis2026_04_07("cache-diagnosis-2026-04-07")` - `Dreaming2026_04_21("dreaming-2026-04-21")` - `ThinkingTokenCount2026_05_13("thinking-token-count-2026-05-13")` - `ServerSideFallback2026_06_01("server-side-fallback-2026-06-01")` - `ServerSideFallback2026_07_01("server-side-fallback-2026-07-01")` - `FallbackCredit2026_06_01("fallback-credit-2026-06-01")` - `FallbackCredit2026_07_01("fallback-credit-2026-07-01")` - `AgentMemory2026_07_22("agent-memory-2026-07-22")` - `MidConversationToolChanges2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `Compact2026_01_12("compact-2026-01-12")` - `ComputerUse2025_11_24("computer-use-2025-11-24")` - `McpTunnels2026_06_22("mcp-tunnels-2026-06-22")` - `StructuredOutputs2025_11_13("structured-outputs-2025-11-13")` - `TaskBudgets2026_03_13("task-budgets-2026-03-13")` - `ThinkingDisplayUpdates2026_08_18("thinking-display-updates-2026-08-18")` - `CEUserManagement2026_07_13("ce-user-management-2026-07-13")` - `MidConversationOutputConfig2026_07_01("mid-conversation-output-config-2026-07-01")` - `ThinkingBindingControls2026_08_01("thinking-binding-controls-2026-08-01")` - `MidConversationSystemClearAt2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `Compact2026_09_04("compact-2026-09-04")` - `InlineTools2026_09_15("inline-tools-2026-09-15")` - `McpClient2026_09_15("mcp-client-2026-09-15")` - `CEPlugins2026_09_01("ce-plugins-2026-09-01")` - `SpendLimitReads2026_09_26("spend-limit-reads-2026-09-26")` - `TelemetryDestinations2026_08_11("telemetry-destinations-2026-08-11")` - `Webhooks2026_10_07("webhooks-2026-10-07")` - `MessageThreads2026_08_12("message-threads-2026-08-12")` - `AnalyticsUsageCost2026_08_24("analytics-usage-cost-2026-08-24")` - `ExperimentalClaudeTag2026_10_21("experimental-claude-tag-2026-10-21")` - `string workspaceID` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ### Returns - `class BetaUserProfile` A record of an entity that the platform serves through the API, such as an end-user of the platform's product or a company that the platform resells Claude access to. A Messages, Message Batches or token counting request can send a profile's `id` in the `anthropic-user-profile-id` header to attribute the request to that entity. - `JsonElement Type = "user_profile"` Object type. Always `user_profile`. - `required string ID` Unique identifier for this user profile, prefixed `uprof_`. - `required DateTimeOffset CreatedAt` When this user profile was created, in RFC 3339 format. format: date-time - `required IReadOnlyDictionary Metadata` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `required string? Name` Real-world name of the entity this profile represents (company or individual). For a company the platform resells Claude access to (`access_type` `passthrough`) this is that company's name. `null` until the platform supplies one. - `required IReadOnlyDictionary TrustGrants` Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight. - `required Status Status` Status of the trust grant. - `Active("active")` - `Pending("pending")` - `Rejected("rejected")` - `required DateTimeOffset UpdatedAt` When this user profile was last modified, in RFC 3339 format. It normally also updates shortly after Anthropic gives the profile an approval or withdraws one. Other changes to the statuses that Anthropic reports do not always update it, so read the status itself rather than watching this timestamp. format: date-time - `AccessType AccessType` How the platform uses the API for this entity: `application` (default) or `passthrough`. Absent under the legacy `user-profiles-2026-03-24` beta header. - `Application("application")` The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default. - `Passthrough("passthrough")` The user profile represents a company that the platform resells Claude access to. - `string? ExternalID` Platform's own identifier for this user. Not enforced unique. Legacy field, present only under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; without one of them, the value is `external_user_details.reference_id`. - `BetaUserProfileExternalUserDetails ExternalUserDetails` Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Every field is present, `null` until the platform supplies a value. Absent under the legacy `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers, which serve `reference_id` as the top-level `external_id` and, under `user-profiles-2026-08-18`, `onboarded_at` as `external_user_onboarded_at`. - `required AccountStatus? AccountStatus` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. `null` until the platform supplies one. - `Active("active")` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `Suspended("suspended")` The platform has restricted the account of the entity that the user profile represents and may restore it. - `Blocked("blocked")` The platform has barred the account of the entity that the user profile represents. - `required string? Country` The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one. - `required string? EmailHash` The platform-computed hash of the entity's email address. `null` until the platform supplies one. - `required EntityType? EntityType` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. `null` until the platform supplies one. - `Individual("individual")` - `Business("business")` - `NonProfit("non_profit")` - `Government("government")` - `required string? NameHash` The platform-computed hash of the entity's name. `null` until the platform supplies one. - `required DateTimeOffset? OnboardedAt` When the entity opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. format: date-time - `required string? ReferenceID` The platform's own reference for the entity. `null` until the platform supplies one. - `DateTimeOffset? ExternalUserOnboardedAt` When the entity this profile represents opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. Legacy field, present only under the `user-profiles-2026-08-18` beta header; without a legacy header, the value is `external_user_details.onboarded_at`. format: date-time ### Example ```csharp using System; using Anthropic.Models.Beta.UserProfiles; UserProfileRetrieveParams parameters = new() { UserProfileID = "uprof_011CZkZCu8hGbp5mYRQgUmz9" }; var betaUserProfile = await client.Beta.UserProfiles.Retrieve(parameters); Console.WriteLine(betaUserProfile); ``` #### Response (200) ```json { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, "name": "Example User", "trust_grants": { "cyber": { "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", "access_type": "application", "external_id": "user_12345", "external_user_details": { "account_status": "active", "country": "US", "email_hash": null, "entity_type": "business", "name_hash": null, "onboarded_at": "2024-11-02T08:15:00Z", "reference_id": "user_12345" }, "external_user_onboarded_at": "2024-11-02T08:15:00Z" } ``` ## Update User Profile `BetaUserProfile Beta.UserProfiles.Update(parameters, cancellationToken = default)` **POST** `/v1/user_profiles/{user_profile_id}` Update User Profile ### Parameters - `UserProfileUpdateParams parameters` - `required string userProfileID` (path parameter) The ID of the user profile to update (`uprof_...`). - `AccessType? accessType` If present, replaces the stored access type. Omit to leave unchanged. - `Application("application")` The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default. - `Passthrough("passthrough")` The user profile represents a company that the platform resells Claude access to. - `string? externalID` If present, replaces the stored external_id. Omit to leave unchanged. Maximum 255 characters. Legacy field, accepted only under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; without one of them, send `external_user_details.reference_id`. minLength: 1, maxLength: 255 - `BetaUserProfileExternalUserDetailsParams externalUserDetails` Details about the entity this profile represents, as the platform states them. Each field sent replaces the stored value; omit a field to leave it unchanged. Once set, a value cannot be cleared and `null` is rejected. Not accepted under the legacy `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers. - `DateTimeOffset externalUserOnboardedAt` If present, replaces the stored account creation time. Omit to leave unchanged; once set, the value cannot be cleared and `null` is rejected. Must be a complete RFC 3339 timestamp no more than 1 minute in the future. Legacy field, accepted only under the `user-profiles-2026-08-18` beta header; without a legacy header, send `external_user_details.onboarded_at`. format: date-time - `IReadOnlyDictionary metadata` Key-value pairs to merge into the stored metadata. Keys provided overwrite existing values. To remove a key, set its value to an empty string. Keys not provided are left unchanged. Maximum 16 keys, with keys up to 64 characters and values up to 512 characters. - `string? name` If present, replaces the stored name. Omit to leave unchanged. Maximum 255 characters. minLength: 1, maxLength: 255 - `IReadOnlyList betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MessageBatches2024_09_24("message-batches-2024-09-24")` - `PromptCaching2024_07_31("prompt-caching-2024-07-31")` - `ComputerUse2024_10_22("computer-use-2024-10-22")` - `ComputerUse2025_01_24("computer-use-2025-01-24")` - `Pdfs2024_09_25("pdfs-2024-09-25")` - `TokenCounting2024_11_01("token-counting-2024-11-01")` - `TokenEfficientTools2025_02_19("token-efficient-tools-2025-02-19")` - `Output128k2025_02_19("output-128k-2025-02-19")` - `FilesApi2025_04_14("files-api-2025-04-14")` - `McpClient2025_04_04("mcp-client-2025-04-04")` - `McpClient2025_11_20("mcp-client-2025-11-20")` - `DevFullThinking2025_05_14("dev-full-thinking-2025-05-14")` - `InterleavedThinking2025_05_14("interleaved-thinking-2025-05-14")` - `CodeExecution2025_05_22("code-execution-2025-05-22")` - `ExtendedCacheTtl2025_04_11("extended-cache-ttl-2025-04-11")` - `Context1m2025_08_07("context-1m-2025-08-07")` - `ContextManagement2025_06_27("context-management-2025-06-27")` - `ModelContextWindowExceeded2025_08_26("model-context-window-exceeded-2025-08-26")` - `Skills2025_10_02("skills-2025-10-02")` - `FastMode2026_02_01("fast-mode-2026-02-01")` - `Output300k2026_03_24("output-300k-2026-03-24")` - `UserProfiles2026_03_24("user-profiles-2026-03-24")` - `UserProfiles2026_08_18("user-profiles-2026-08-18")` - `UserProfiles2026_09_04("user-profiles-2026-09-04")` - `AdvisorTool2026_03_01("advisor-tool-2026-03-01")` - `ManagedAgents2026_04_01("managed-agents-2026-04-01")` - `CacheDiagnosis2026_04_07("cache-diagnosis-2026-04-07")` - `Dreaming2026_04_21("dreaming-2026-04-21")` - `ThinkingTokenCount2026_05_13("thinking-token-count-2026-05-13")` - `ServerSideFallback2026_06_01("server-side-fallback-2026-06-01")` - `ServerSideFallback2026_07_01("server-side-fallback-2026-07-01")` - `FallbackCredit2026_06_01("fallback-credit-2026-06-01")` - `FallbackCredit2026_07_01("fallback-credit-2026-07-01")` - `AgentMemory2026_07_22("agent-memory-2026-07-22")` - `MidConversationToolChanges2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `Compact2026_01_12("compact-2026-01-12")` - `ComputerUse2025_11_24("computer-use-2025-11-24")` - `McpTunnels2026_06_22("mcp-tunnels-2026-06-22")` - `StructuredOutputs2025_11_13("structured-outputs-2025-11-13")` - `TaskBudgets2026_03_13("task-budgets-2026-03-13")` - `ThinkingDisplayUpdates2026_08_18("thinking-display-updates-2026-08-18")` - `CEUserManagement2026_07_13("ce-user-management-2026-07-13")` - `MidConversationOutputConfig2026_07_01("mid-conversation-output-config-2026-07-01")` - `ThinkingBindingControls2026_08_01("thinking-binding-controls-2026-08-01")` - `MidConversationSystemClearAt2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `Compact2026_09_04("compact-2026-09-04")` - `InlineTools2026_09_15("inline-tools-2026-09-15")` - `McpClient2026_09_15("mcp-client-2026-09-15")` - `CEPlugins2026_09_01("ce-plugins-2026-09-01")` - `SpendLimitReads2026_09_26("spend-limit-reads-2026-09-26")` - `TelemetryDestinations2026_08_11("telemetry-destinations-2026-08-11")` - `Webhooks2026_10_07("webhooks-2026-10-07")` - `MessageThreads2026_08_12("message-threads-2026-08-12")` - `AnalyticsUsageCost2026_08_24("analytics-usage-cost-2026-08-24")` - `ExperimentalClaudeTag2026_10_21("experimental-claude-tag-2026-10-21")` - `string workspaceID` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ### Returns - `class BetaUserProfile` A record of an entity that the platform serves through the API, such as an end-user of the platform's product or a company that the platform resells Claude access to. A Messages, Message Batches or token counting request can send a profile's `id` in the `anthropic-user-profile-id` header to attribute the request to that entity. - `JsonElement Type = "user_profile"` Object type. Always `user_profile`. - `required string ID` Unique identifier for this user profile, prefixed `uprof_`. - `required DateTimeOffset CreatedAt` When this user profile was created, in RFC 3339 format. format: date-time - `required IReadOnlyDictionary Metadata` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `required string? Name` Real-world name of the entity this profile represents (company or individual). For a company the platform resells Claude access to (`access_type` `passthrough`) this is that company's name. `null` until the platform supplies one. - `required IReadOnlyDictionary TrustGrants` Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight. - `required Status Status` Status of the trust grant. - `Active("active")` - `Pending("pending")` - `Rejected("rejected")` - `required DateTimeOffset UpdatedAt` When this user profile was last modified, in RFC 3339 format. It normally also updates shortly after Anthropic gives the profile an approval or withdraws one. Other changes to the statuses that Anthropic reports do not always update it, so read the status itself rather than watching this timestamp. format: date-time - `AccessType AccessType` How the platform uses the API for this entity: `application` (default) or `passthrough`. Absent under the legacy `user-profiles-2026-03-24` beta header. - `Application("application")` The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default. - `Passthrough("passthrough")` The user profile represents a company that the platform resells Claude access to. - `string? ExternalID` Platform's own identifier for this user. Not enforced unique. Legacy field, present only under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; without one of them, the value is `external_user_details.reference_id`. - `BetaUserProfileExternalUserDetails ExternalUserDetails` Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Every field is present, `null` until the platform supplies a value. Absent under the legacy `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers, which serve `reference_id` as the top-level `external_id` and, under `user-profiles-2026-08-18`, `onboarded_at` as `external_user_onboarded_at`. - `required AccountStatus? AccountStatus` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. `null` until the platform supplies one. - `Active("active")` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `Suspended("suspended")` The platform has restricted the account of the entity that the user profile represents and may restore it. - `Blocked("blocked")` The platform has barred the account of the entity that the user profile represents. - `required string? Country` The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one. - `required string? EmailHash` The platform-computed hash of the entity's email address. `null` until the platform supplies one. - `required EntityType? EntityType` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. `null` until the platform supplies one. - `Individual("individual")` - `Business("business")` - `NonProfit("non_profit")` - `Government("government")` - `required string? NameHash` The platform-computed hash of the entity's name. `null` until the platform supplies one. - `required DateTimeOffset? OnboardedAt` When the entity opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. format: date-time - `required string? ReferenceID` The platform's own reference for the entity. `null` until the platform supplies one. - `DateTimeOffset? ExternalUserOnboardedAt` When the entity this profile represents opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. Legacy field, present only under the `user-profiles-2026-08-18` beta header; without a legacy header, the value is `external_user_details.onboarded_at`. format: date-time ### Example ```csharp using System; using Anthropic.Models.Beta.UserProfiles; UserProfileUpdateParams parameters = new() { UserProfileID = "uprof_011CZkZCu8hGbp5mYRQgUmz9" }; var betaUserProfile = await client.Beta.UserProfiles.Update(parameters); Console.WriteLine(betaUserProfile); ``` #### Response (200) ```json { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "created_at": "2026-03-15T10:00:00Z", "metadata": {}, "name": "Example User", "trust_grants": { "cyber": { "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z", "access_type": "application", "external_id": "user_12345", "external_user_details": { "account_status": "active", "country": "US", "email_hash": null, "entity_type": "business", "name_hash": null, "onboarded_at": "2024-11-02T08:15:00Z", "reference_id": "user_12345" }, "external_user_onboarded_at": "2024-11-02T08:15:00Z" } ``` ## Delete User Profile `BetaDeletedUserProfile Beta.UserProfiles.Delete(parameters, cancellationToken = default)` **DELETE** `/v1/user_profiles/{user_profile_id}` Delete User Profile ### Parameters - `UserProfileDeleteParams parameters` - `required string userProfileID` (path parameter) The ID of the user profile to delete (`uprof_...`). - `IReadOnlyList betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MessageBatches2024_09_24("message-batches-2024-09-24")` - `PromptCaching2024_07_31("prompt-caching-2024-07-31")` - `ComputerUse2024_10_22("computer-use-2024-10-22")` - `ComputerUse2025_01_24("computer-use-2025-01-24")` - `Pdfs2024_09_25("pdfs-2024-09-25")` - `TokenCounting2024_11_01("token-counting-2024-11-01")` - `TokenEfficientTools2025_02_19("token-efficient-tools-2025-02-19")` - `Output128k2025_02_19("output-128k-2025-02-19")` - `FilesApi2025_04_14("files-api-2025-04-14")` - `McpClient2025_04_04("mcp-client-2025-04-04")` - `McpClient2025_11_20("mcp-client-2025-11-20")` - `DevFullThinking2025_05_14("dev-full-thinking-2025-05-14")` - `InterleavedThinking2025_05_14("interleaved-thinking-2025-05-14")` - `CodeExecution2025_05_22("code-execution-2025-05-22")` - `ExtendedCacheTtl2025_04_11("extended-cache-ttl-2025-04-11")` - `Context1m2025_08_07("context-1m-2025-08-07")` - `ContextManagement2025_06_27("context-management-2025-06-27")` - `ModelContextWindowExceeded2025_08_26("model-context-window-exceeded-2025-08-26")` - `Skills2025_10_02("skills-2025-10-02")` - `FastMode2026_02_01("fast-mode-2026-02-01")` - `Output300k2026_03_24("output-300k-2026-03-24")` - `UserProfiles2026_03_24("user-profiles-2026-03-24")` - `UserProfiles2026_08_18("user-profiles-2026-08-18")` - `UserProfiles2026_09_04("user-profiles-2026-09-04")` - `AdvisorTool2026_03_01("advisor-tool-2026-03-01")` - `ManagedAgents2026_04_01("managed-agents-2026-04-01")` - `CacheDiagnosis2026_04_07("cache-diagnosis-2026-04-07")` - `Dreaming2026_04_21("dreaming-2026-04-21")` - `ThinkingTokenCount2026_05_13("thinking-token-count-2026-05-13")` - `ServerSideFallback2026_06_01("server-side-fallback-2026-06-01")` - `ServerSideFallback2026_07_01("server-side-fallback-2026-07-01")` - `FallbackCredit2026_06_01("fallback-credit-2026-06-01")` - `FallbackCredit2026_07_01("fallback-credit-2026-07-01")` - `AgentMemory2026_07_22("agent-memory-2026-07-22")` - `MidConversationToolChanges2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `Compact2026_01_12("compact-2026-01-12")` - `ComputerUse2025_11_24("computer-use-2025-11-24")` - `McpTunnels2026_06_22("mcp-tunnels-2026-06-22")` - `StructuredOutputs2025_11_13("structured-outputs-2025-11-13")` - `TaskBudgets2026_03_13("task-budgets-2026-03-13")` - `ThinkingDisplayUpdates2026_08_18("thinking-display-updates-2026-08-18")` - `CEUserManagement2026_07_13("ce-user-management-2026-07-13")` - `MidConversationOutputConfig2026_07_01("mid-conversation-output-config-2026-07-01")` - `ThinkingBindingControls2026_08_01("thinking-binding-controls-2026-08-01")` - `MidConversationSystemClearAt2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `Compact2026_09_04("compact-2026-09-04")` - `InlineTools2026_09_15("inline-tools-2026-09-15")` - `McpClient2026_09_15("mcp-client-2026-09-15")` - `CEPlugins2026_09_01("ce-plugins-2026-09-01")` - `SpendLimitReads2026_09_26("spend-limit-reads-2026-09-26")` - `TelemetryDestinations2026_08_11("telemetry-destinations-2026-08-11")` - `Webhooks2026_10_07("webhooks-2026-10-07")` - `MessageThreads2026_08_12("message-threads-2026-08-12")` - `AnalyticsUsageCost2026_08_24("analytics-usage-cost-2026-08-24")` - `ExperimentalClaudeTag2026_10_21("experimental-claude-tag-2026-10-21")` - `string workspaceID` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ### Returns - `class BetaDeletedUserProfile` - `JsonElement Type = "user_profile_deleted"` Object type. Always `user_profile_deleted`. - `required string ID` Identifier of the deleted user profile, prefixed `uprof_`. ### Example ```csharp using System; using Anthropic.Models.Beta.UserProfiles; UserProfileDeleteParams parameters = new() { UserProfileID = "uprof_011CZkZCu8hGbp5mYRQgUmz9" }; var betaDeletedUserProfile = await client.Beta.UserProfiles.Delete(parameters); Console.WriteLine(betaDeletedUserProfile); ``` #### Response (200) ```json { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "type": "user_profile_deleted" } ``` ## Create Enrollment URL `BetaUserProfileEnrollmentUrl Beta.UserProfiles.CreateEnrollmentUrl(parameters, cancellationToken = default)` **POST** `/v1/user_profiles/{user_profile_id}/enrollment_url` Create Enrollment URL ### Parameters - `UserProfileCreateEnrollmentUrlParams parameters` - `required string userProfileID` (path parameter) The ID of the user profile to create an enrollment URL for (`uprof_...`). - `IReadOnlyList betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MessageBatches2024_09_24("message-batches-2024-09-24")` - `PromptCaching2024_07_31("prompt-caching-2024-07-31")` - `ComputerUse2024_10_22("computer-use-2024-10-22")` - `ComputerUse2025_01_24("computer-use-2025-01-24")` - `Pdfs2024_09_25("pdfs-2024-09-25")` - `TokenCounting2024_11_01("token-counting-2024-11-01")` - `TokenEfficientTools2025_02_19("token-efficient-tools-2025-02-19")` - `Output128k2025_02_19("output-128k-2025-02-19")` - `FilesApi2025_04_14("files-api-2025-04-14")` - `McpClient2025_04_04("mcp-client-2025-04-04")` - `McpClient2025_11_20("mcp-client-2025-11-20")` - `DevFullThinking2025_05_14("dev-full-thinking-2025-05-14")` - `InterleavedThinking2025_05_14("interleaved-thinking-2025-05-14")` - `CodeExecution2025_05_22("code-execution-2025-05-22")` - `ExtendedCacheTtl2025_04_11("extended-cache-ttl-2025-04-11")` - `Context1m2025_08_07("context-1m-2025-08-07")` - `ContextManagement2025_06_27("context-management-2025-06-27")` - `ModelContextWindowExceeded2025_08_26("model-context-window-exceeded-2025-08-26")` - `Skills2025_10_02("skills-2025-10-02")` - `FastMode2026_02_01("fast-mode-2026-02-01")` - `Output300k2026_03_24("output-300k-2026-03-24")` - `UserProfiles2026_03_24("user-profiles-2026-03-24")` - `UserProfiles2026_08_18("user-profiles-2026-08-18")` - `UserProfiles2026_09_04("user-profiles-2026-09-04")` - `AdvisorTool2026_03_01("advisor-tool-2026-03-01")` - `ManagedAgents2026_04_01("managed-agents-2026-04-01")` - `CacheDiagnosis2026_04_07("cache-diagnosis-2026-04-07")` - `Dreaming2026_04_21("dreaming-2026-04-21")` - `ThinkingTokenCount2026_05_13("thinking-token-count-2026-05-13")` - `ServerSideFallback2026_06_01("server-side-fallback-2026-06-01")` - `ServerSideFallback2026_07_01("server-side-fallback-2026-07-01")` - `FallbackCredit2026_06_01("fallback-credit-2026-06-01")` - `FallbackCredit2026_07_01("fallback-credit-2026-07-01")` - `AgentMemory2026_07_22("agent-memory-2026-07-22")` - `MidConversationToolChanges2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `Compact2026_01_12("compact-2026-01-12")` - `ComputerUse2025_11_24("computer-use-2025-11-24")` - `McpTunnels2026_06_22("mcp-tunnels-2026-06-22")` - `StructuredOutputs2025_11_13("structured-outputs-2025-11-13")` - `TaskBudgets2026_03_13("task-budgets-2026-03-13")` - `ThinkingDisplayUpdates2026_08_18("thinking-display-updates-2026-08-18")` - `CEUserManagement2026_07_13("ce-user-management-2026-07-13")` - `MidConversationOutputConfig2026_07_01("mid-conversation-output-config-2026-07-01")` - `ThinkingBindingControls2026_08_01("thinking-binding-controls-2026-08-01")` - `MidConversationSystemClearAt2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `Compact2026_09_04("compact-2026-09-04")` - `InlineTools2026_09_15("inline-tools-2026-09-15")` - `McpClient2026_09_15("mcp-client-2026-09-15")` - `CEPlugins2026_09_01("ce-plugins-2026-09-01")` - `SpendLimitReads2026_09_26("spend-limit-reads-2026-09-26")` - `TelemetryDestinations2026_08_11("telemetry-destinations-2026-08-11")` - `Webhooks2026_10_07("webhooks-2026-10-07")` - `MessageThreads2026_08_12("message-threads-2026-08-12")` - `AnalyticsUsageCost2026_08_24("analytics-usage-cost-2026-08-24")` - `ExperimentalClaudeTag2026_10_21("experimental-claude-tag-2026-10-21")` - `string workspaceID` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ### Returns - `class BetaUserProfileEnrollmentUrl` A URL to give to the entity that a user profile represents, so that the entity can enroll in a program. - `JsonElement Type = "enrollment_url"` Object type. Always `enrollment_url`. - `required DateTimeOffset ExpiresAt` When this enrollment URL expires, in RFC 3339 format. format: date-time - `required string Url` Enrollment URL to send to the end user. Valid until `expires_at`. ### Example ```csharp using System; using Anthropic.Models.Beta.UserProfiles; UserProfileCreateEnrollmentUrlParams parameters = new() { UserProfileID = "uprof_011CZkZCu8hGbp5mYRQgUmz9" }; var betaUserProfileEnrollmentUrl = await client.Beta.UserProfiles.CreateEnrollmentUrl(parameters); Console.WriteLine(betaUserProfileEnrollmentUrl); ``` #### Response (200) ```json { "expires_at": "2026-03-15T10:15:00Z", "type": "enrollment_url", "url": "https://platform.claude.com/user-profiles/enrollment/M3J0bGJxZ2ppMnptbnB1" } ``` ## Domain types ### Beta Deleted User Profile - `class BetaDeletedUserProfile` - `JsonElement Type = "user_profile_deleted"` Object type. Always `user_profile_deleted`. - `required string ID` Identifier of the deleted user profile, prefixed `uprof_`. ### Beta User Profile - `class BetaUserProfile` A record of an entity that the platform serves through the API, such as an end-user of the platform's product or a company that the platform resells Claude access to. A Messages, Message Batches or token counting request can send a profile's `id` in the `anthropic-user-profile-id` header to attribute the request to that entity. - `JsonElement Type = "user_profile"` Object type. Always `user_profile`. - `required string ID` Unique identifier for this user profile, prefixed `uprof_`. - `required DateTimeOffset CreatedAt` When this user profile was created, in RFC 3339 format. format: date-time - `required IReadOnlyDictionary Metadata` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `required string? Name` Real-world name of the entity this profile represents (company or individual). For a company the platform resells Claude access to (`access_type` `passthrough`) this is that company's name. `null` until the platform supplies one. - `required IReadOnlyDictionary TrustGrants` Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight. - `required Status Status` Status of the trust grant. - `Active("active")` - `Pending("pending")` - `Rejected("rejected")` - `required DateTimeOffset UpdatedAt` When this user profile was last modified, in RFC 3339 format. It normally also updates shortly after Anthropic gives the profile an approval or withdraws one. Other changes to the statuses that Anthropic reports do not always update it, so read the status itself rather than watching this timestamp. format: date-time - `AccessType AccessType` How the platform uses the API for this entity: `application` (default) or `passthrough`. Absent under the legacy `user-profiles-2026-03-24` beta header. - `Application("application")` The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default. - `Passthrough("passthrough")` The user profile represents a company that the platform resells Claude access to. - `string? ExternalID` Platform's own identifier for this user. Not enforced unique. Legacy field, present only under the `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers; without one of them, the value is `external_user_details.reference_id`. - `BetaUserProfileExternalUserDetails ExternalUserDetails` Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Every field is present, `null` until the platform supplies a value. Absent under the legacy `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers, which serve `reference_id` as the top-level `external_id` and, under `user-profiles-2026-08-18`, `onboarded_at` as `external_user_onboarded_at`. - `required AccountStatus? AccountStatus` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. `null` until the platform supplies one. - `Active("active")` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `Suspended("suspended")` The platform has restricted the account of the entity that the user profile represents and may restore it. - `Blocked("blocked")` The platform has barred the account of the entity that the user profile represents. - `required string? Country` The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one. - `required string? EmailHash` The platform-computed hash of the entity's email address. `null` until the platform supplies one. - `required EntityType? EntityType` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. `null` until the platform supplies one. - `Individual("individual")` - `Business("business")` - `NonProfit("non_profit")` - `Government("government")` - `required string? NameHash` The platform-computed hash of the entity's name. `null` until the platform supplies one. - `required DateTimeOffset? OnboardedAt` When the entity opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. format: date-time - `required string? ReferenceID` The platform's own reference for the entity. `null` until the platform supplies one. - `DateTimeOffset? ExternalUserOnboardedAt` When the entity this profile represents opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. Legacy field, present only under the `user-profiles-2026-08-18` beta header; without a legacy header, the value is `external_user_details.onboarded_at`. format: date-time ### Beta User Profile Enrollment URL - `class BetaUserProfileEnrollmentUrl` A URL to give to the entity that a user profile represents, so that the entity can enroll in a program. - `JsonElement Type = "enrollment_url"` Object type. Always `enrollment_url`. - `required DateTimeOffset ExpiresAt` When this enrollment URL expires, in RFC 3339 format. format: date-time - `required string Url` Enrollment URL to send to the end user. Valid until `expires_at`. ### Beta User Profile External User Details - `class BetaUserProfileExternalUserDetails` Details about the entity this profile represents, as the platform states them. Anthropic does not verify them. Every field is present, `null` until the platform supplies a value. - `required AccountStatus? AccountStatus` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. `null` until the platform supplies one. - `Active("active")` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `Suspended("suspended")` The platform has restricted the account of the entity that the user profile represents and may restore it. - `Blocked("blocked")` The platform has barred the account of the entity that the user profile represents. - `required string? Country` The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. `null` until the platform supplies one. - `required string? EmailHash` The platform-computed hash of the entity's email address. `null` until the platform supplies one. - `required EntityType? EntityType` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. `null` until the platform supplies one. - `Individual("individual")` - `Business("business")` - `NonProfit("non_profit")` - `Government("government")` - `required string? NameHash` The platform-computed hash of the entity's name. `null` until the platform supplies one. - `required DateTimeOffset? OnboardedAt` When the entity opened its account with the platform, as stated by the platform, in RFC 3339 format (UTC). `null` until the platform supplies one. format: date-time - `required string? ReferenceID` The platform's own reference for the entity. `null` until the platform supplies one. ### Beta User Profile External User Details Params - `class BetaUserProfileExternalUserDetailsParams` - `AccountStatus? AccountStatus` The status of the entity's account on the platform: `active`, `suspended` or `blocked`. - `Active("active")` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `Suspended("suspended")` The platform has restricted the account of the entity that the user profile represents and may restore it. - `Blocked("blocked")` The platform has barred the account of the entity that the user profile represents. - `string? Country` The country of the entity (not of the platform), as the platform determines it: an ISO 3166-1 alpha-2 code in upper case, for example `US`. Only the form, two uppercase ASCII letters, is checked. - `string? EmailHash` A hash of the entity's email address, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters. minLength: 1, maxLength: 255 - `EntityType? EntityType` What kind of entity the profile represents: `individual`, `business`, `non_profit` or `government`. - `Individual("individual")` - `Business("business")` - `NonProfit("non_profit")` - `Government("government")` - `string? NameHash` A hash of the entity's name, computed by the platform. Anthropic treats it as an opaque string and does not prescribe the hash function. 1 to 255 characters. minLength: 1, maxLength: 255 - `DateTimeOffset OnboardedAt` When the entity opened its account with the platform, in RFC 3339 format: for an `application` profile, when the end-user signed up; for a `passthrough` profile, when the company became the platform's customer. Must be a complete timestamp no more than 1 minute in the future. format: date-time - `string? ReferenceID` The platform's own reference for the entity, for example the key of the end-user's row in the platform's database. Not interpreted by Anthropic and not enforced unique. 1 to 255 characters. minLength: 1, maxLength: 255 ### Beta User Profile Trust Grant - `class BetaUserProfileTrustGrant` The status of one trust grant on a user profile, listed in the profile's `trust_grants` map under the grant's name. - `required Status Status` Status of the trust grant. - `Active("active")` - `Pending("pending")` - `Rejected("rejected")` ## User Profiles › Action URLs ### Create Action URL `BetaUserProfileActionUrl Beta.UserProfiles.ActionUrls.Create(parameters, cancellationToken = default)` **POST** `/v1/user_profiles/{user_profile_id}/action_urls` Create Action URL #### Parameters - `ActionUrlCreateParams parameters` - `required string userProfileID` (path parameter) The ID of the user profile the action is for (`uprof_...`). - `required BetaUserProfileEnrollEndUserAction action` The action that the person who opens the URL takes. - `IReadOnlyList betas` (header parameter) Optional header to specify the beta version(s) you want to use. - `MessageBatches2024_09_24("message-batches-2024-09-24")` - `PromptCaching2024_07_31("prompt-caching-2024-07-31")` - `ComputerUse2024_10_22("computer-use-2024-10-22")` - `ComputerUse2025_01_24("computer-use-2025-01-24")` - `Pdfs2024_09_25("pdfs-2024-09-25")` - `TokenCounting2024_11_01("token-counting-2024-11-01")` - `TokenEfficientTools2025_02_19("token-efficient-tools-2025-02-19")` - `Output128k2025_02_19("output-128k-2025-02-19")` - `FilesApi2025_04_14("files-api-2025-04-14")` - `McpClient2025_04_04("mcp-client-2025-04-04")` - `McpClient2025_11_20("mcp-client-2025-11-20")` - `DevFullThinking2025_05_14("dev-full-thinking-2025-05-14")` - `InterleavedThinking2025_05_14("interleaved-thinking-2025-05-14")` - `CodeExecution2025_05_22("code-execution-2025-05-22")` - `ExtendedCacheTtl2025_04_11("extended-cache-ttl-2025-04-11")` - `Context1m2025_08_07("context-1m-2025-08-07")` - `ContextManagement2025_06_27("context-management-2025-06-27")` - `ModelContextWindowExceeded2025_08_26("model-context-window-exceeded-2025-08-26")` - `Skills2025_10_02("skills-2025-10-02")` - `FastMode2026_02_01("fast-mode-2026-02-01")` - `Output300k2026_03_24("output-300k-2026-03-24")` - `UserProfiles2026_03_24("user-profiles-2026-03-24")` - `UserProfiles2026_08_18("user-profiles-2026-08-18")` - `UserProfiles2026_09_04("user-profiles-2026-09-04")` - `AdvisorTool2026_03_01("advisor-tool-2026-03-01")` - `ManagedAgents2026_04_01("managed-agents-2026-04-01")` - `CacheDiagnosis2026_04_07("cache-diagnosis-2026-04-07")` - `Dreaming2026_04_21("dreaming-2026-04-21")` - `ThinkingTokenCount2026_05_13("thinking-token-count-2026-05-13")` - `ServerSideFallback2026_06_01("server-side-fallback-2026-06-01")` - `ServerSideFallback2026_07_01("server-side-fallback-2026-07-01")` - `FallbackCredit2026_06_01("fallback-credit-2026-06-01")` - `FallbackCredit2026_07_01("fallback-credit-2026-07-01")` - `AgentMemory2026_07_22("agent-memory-2026-07-22")` - `MidConversationToolChanges2026_07_01("mid-conversation-tool-changes-2026-07-01")` - `Compact2026_01_12("compact-2026-01-12")` - `ComputerUse2025_11_24("computer-use-2025-11-24")` - `McpTunnels2026_06_22("mcp-tunnels-2026-06-22")` - `StructuredOutputs2025_11_13("structured-outputs-2025-11-13")` - `TaskBudgets2026_03_13("task-budgets-2026-03-13")` - `ThinkingDisplayUpdates2026_08_18("thinking-display-updates-2026-08-18")` - `CEUserManagement2026_07_13("ce-user-management-2026-07-13")` - `MidConversationOutputConfig2026_07_01("mid-conversation-output-config-2026-07-01")` - `ThinkingBindingControls2026_08_01("thinking-binding-controls-2026-08-01")` - `MidConversationSystemClearAt2026_08_21("mid-conversation-system-clear-at-2026-08-21")` - `Compact2026_09_04("compact-2026-09-04")` - `InlineTools2026_09_15("inline-tools-2026-09-15")` - `McpClient2026_09_15("mcp-client-2026-09-15")` - `CEPlugins2026_09_01("ce-plugins-2026-09-01")` - `SpendLimitReads2026_09_26("spend-limit-reads-2026-09-26")` - `TelemetryDestinations2026_08_11("telemetry-destinations-2026-08-11")` - `Webhooks2026_10_07("webhooks-2026-10-07")` - `MessageThreads2026_08_12("message-threads-2026-08-12")` - `AnalyticsUsageCost2026_08_24("analytics-usage-cost-2026-08-24")` - `ExperimentalClaudeTag2026_10_21("experimental-claude-tag-2026-10-21")` - `string workspaceID` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `class BetaUserProfileActionUrl` A URL to give to the person who takes the requested action. - `JsonElement Type = "user_profile_action_url"` Object type. Always `user_profile_action_url`. - `required DateTimeOffset ExpiresAt` When the URL stops working, in RFC 3339 format. format: date-time - `required string Url` The URL to give to the person who takes the action. Anyone who holds it can open it until `expires_at`. #### Example ```csharp using System; using Anthropic.Models.Beta.UserProfiles.ActionUrls; ActionUrlCreateParams parameters = new() { UserProfileID = "uprof_011CZkZCu8hGbp5mYRQgUmz9", Action = new(), }; var betaUserProfileActionUrl = await client.Beta.UserProfiles.ActionUrls.Create(parameters); Console.WriteLine(betaUserProfileActionUrl); ``` ##### Response (200) ```json { "expires_at": "2026-03-15T10:15:00Z", "type": "user_profile_action_url", "url": "https://platform.claude.com/user-profiles/enrollment/M3J0bGJxZ2ppMnptbnB1" } ```