使用者設定檔
建立使用者設定檔
列出使用者設定檔
取得使用者設定檔
更新使用者設定檔
Delete User Profile
Models
DeletedUserProfile object{ type: "user_profile_deleted", id }
Object type. Always user_profile_deleted.
Identifier of the deleted user profile, prefixed uprof_.
UserProfile object{ type: "user_profile", id, access_type, 6 more }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 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.
UserProfileAccessType = "application" or "passthrough"How the platform uses the API on behalf of the entity this profile represents. application: the platform sells a product that uses the API behind the scenes, and the profile represents an individual end-user of that product. passthrough: the platform resells raw inference, and the profile identifies the resold-to company.
How the platform uses the API on behalf of the entity this profile represents. application: the platform sells a product that uses the API behind the scenes, and the profile represents an individual end-user of that product. passthrough: the platform resells raw inference, and the profile identifies the resold-to company.
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.
The user profile represents a company that the platform resells Claude access to.
UserProfileCyberProgram object{ requirements, status, tiers }A user profile's standing in the Cyber Verification Program, which relaxes cyber safeguards for requests that name the profile.
A user profile's standing in the Cyber Verification Program, which relaxes cyber safeguards for requests that name the profile.
UserProfileCyberRequirements object{ data_retention, human_review }What a request that names the profile must allow to get the relaxed safeguards of the profile's active tiers. A field reads true when at least one of those tiers has the requirement and Anthropic has not waived it on that tier for the profile. A request that does not meet a requirement is still served, without the relaxed safeguards of the tiers that have it. The values differ between profiles and can change, so read them rather than assuming them.
What a request that names the profile must allow to get the relaxed safeguards of the profile's active tiers. A field reads true when at least one of those tiers has the requirement and Anthropic has not waived it on that tier for the profile. A request that does not meet a requirement is still served, without the relaxed safeguards of the tiers that have it. The values differ between profiles and can change, so read them rather than assuming them.
Whether Anthropic must be able to retain the request's inference data.
Whether Anthropic personnel must be allowed to review the data retained from the request.
UserProfileCyberTier object{ status }One tier of the Cyber Verification Program.
One tier of the Cyber Verification Program.
status: "active" or "inactive"active when the tier applies to the profile, otherwise inactive. The response does not say why a tier is inactive: it can be in review, declined, withdrawn, never applied for, or approved but not applied to this profile.
active when the tier applies to the profile, otherwise inactive. The response does not say why a tier is inactive: it can be in review, declined, withdrawn, never applied for, or approved but not applied to this profile.
UserProfileEfsFeature object{ status }One feature of Enterprise Frontier Safeguards.
One feature of Enterprise Frontier Safeguards.
status: "active" or "inactive"active when Anthropic has approved the entity the profile represents to use the feature, otherwise inactive. active does not mean that the feature is set up or switched on, which is a separate step.
active when Anthropic has approved the entity the profile represents to use the feature, otherwise inactive. active does not mean that the feature is set up or switched on, which is a separate step.
UserProfileEfsProgram object{ features, status }A user profile's standing in Enterprise Frontier Safeguards, a program under which Anthropic approves the entity the profile represents and may approve any of the program's features.
A user profile's standing in Enterprise Frontier Safeguards, a program under which Anthropic approves the entity the profile represents and may approve any of the program's features.
features: map[UserProfileEfsFeature { status }]The program's features, keyed by feature: data_retention_exemption (use of models that normally require data retention, without the data being retained), cmek (customer-managed encryption keys) and storage (customer-owned storage). Every feature that the caller's organization may read has a key, whether or not it is approved; a missing key does not mean that the feature is inactive. Anthropic may add features; ignore a key you do not recognize.
The program's features, keyed by feature: data_retention_exemption (use of models that normally require data retention, without the data being retained), cmek (customer-managed encryption keys) and storage (customer-owned storage). Every feature that the caller's organization may read has a key, whether or not it is approved; a missing key does not mean that the feature is inactive. Anthropic may add features; ignore a key you do not recognize.
status: "active" or "inactive"active when Anthropic has approved the entity the profile represents to use the feature, otherwise inactive. active does not mean that the feature is set up or switched on, which is a separate step.
active when Anthropic has approved the entity the profile represents to use the feature, otherwise inactive. active does not mean that the feature is set up or switched on, which is a separate step.
status: UserProfileProgramStatusAnthropic's decision on the entity the profile represents: pending while it is awaited, active once Anthropic has approved the entity for the program, or rejected once Anthropic has declined or has removed the entity from the program. active does not mean that any one feature is approved: read the feature you need in features.
Anthropic's decision on the entity the profile represents: pending while it is awaited, active once Anthropic has approved the entity for the program, or rejected once Anthropic has declined or has removed the entity from the program. active does not mean that any one feature is approved: read the feature you need in features.
The profile is in the program.
The profile is not in the program yet, and something is still awaited.
The profile is not in the program and nothing is awaited: Anthropic has declined, or has withdrawn an earlier approval.
UserProfileExternalUserAccountStatus = "active" or "suspended" or "blocked"The status of the entity's account on the platform, as the platform states it: active; suspended, when the platform has restricted the account and may restore it; or blocked, when the platform has barred it. It records the platform's decision only. The statuses that Anthropic itself reports for the profile, such as its status in a program, are Anthropic's decisions and do not change with it.
The status of the entity's account on the platform, as the platform states it: active; suspended, when the platform has restricted the account and may restore it; or blocked, when the platform has barred it. It records the platform's decision only. The statuses that Anthropic itself reports for the profile, such as its status in a program, are Anthropic's decisions and do not change with it.
The platform has neither restricted nor barred the account of the entity that the user profile represents.
The platform has restricted the account of the entity that the user profile represents and may restore it.
The platform has barred the account of the entity that the user profile represents.
UserProfileExternalUserDetails object{ account_status, country, email_hash, 4 more }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.
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.
UserProfileExternalUserDetailsParams object{ account_status, country, email_hash, 4 more }
UserProfileExternalUserEntityType = "individual" or "business" or "non_profit" or "government"What kind of entity the profile represents, as the platform states it: individual, business, non_profit or government.
What kind of entity the profile represents, as the platform states it: individual, business, non_profit or government.
UserProfileListOrder = "asc" or "desc"The direction that a list of user profiles is sorted in.
The direction that a list of user profiles is sorted in.
Oldest first when order_by is created_at, or names in ascending order when order_by is name.
Newest first when order_by is created_at, or names in descending order when order_by is name. This is the default.
UserProfileListOrderBy = "created_at" or "name"Sort field for listing user profiles: created_at (default) or name (case-insensitive; profiles without a name sort last).
Sort field for listing user profiles: created_at (default) or name (case-insensitive; profiles without a name sort last).
Sort by when each user profile was created. This is the default.
Sort by name, ignoring the case of ASCII letters. Profiles without a name come last in either direction.
UserProfileProgramStatus = "active" or "pending" or "rejected"A user profile's status in a program. Each program's status field says what the values mean there.
A user profile's status in a program. Each program's status field says what the values mean there.
The profile is in the program.
The profile is not in the program yet, and something is still awaited.
The profile is not in the program and nothing is awaited: Anthropic has declined, or has withdrawn an earlier approval.
UserProfilePrograms object{ cyber, efs }A user profile's standing in each program. A program is a set of capabilities or exemptions that Anthropic approves for the entity the profile represents. A program reads null when the profile has no status in it, when the caller's organization is not entitled to read programs, or when the response does not report that program. Retrieving the profile reports every program. Anthropic may add programs; ignore a key you do not recognize.
A user profile's standing in each program. A program is a set of capabilities or exemptions that Anthropic approves for the entity the profile represents. A program reads null when the profile has no status in it, when the caller's organization is not entitled to read programs, or when the response does not report that program. Retrieving the profile reports every program. Anthropic may add programs; ignore a key you do not recognize.