Benutzerprofile
Benutzerprofil erstellen
$client->userProfiles->create(?UserProfileAccessType accessType, ?UserProfileExternalUserDetailsParams externalUserDetails, ?array<string,string> metadata, ?string name, ?string workspaceID): UserProfileBenutzerprofile auflisten
$client->userProfiles->list(?list<UserProfileEnforcementStatus> enforcementStatus, ?int limit, ?UserProfileListOrder order, ?UserProfileListOrderBy orderBy, ?string page, ?string workspaceID): PageCursor<UserProfile>Benutzerprofil abrufen
$client->userProfiles->retrieve(string userProfileID, ?string workspaceID): UserProfileBenutzerprofil aktualisieren
$client->userProfiles->update(string userProfileID, ?UserProfileAccessType accessType, ?UserProfileExternalUserDetailsParams externalUserDetails, ?array<string,string> metadata, ?string name, ?string workspaceID): UserProfileBenutzerprofil löschen
$client->userProfiles->delete(string userProfileID, ?string workspaceID): DeletedUserProfileModels
class DeletedUserProfile { $type = 'user_profile_deleted'; $id; }
Object type. Always user_profile_deleted.
Identifier of the deleted user profile, prefixed uprof_.
class UserProfile { $type = 'user_profile'; $id; $accessType; /* 8 more */ }
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.
class UserProfileCyberProgram { $requirements; $status; $tiers; }
What a request that names the profile must allow to get the relaxed safeguards of every active tier. null when no tier is active, and wherever tiers is {}.
active when at least one tier is active, or when the profile has the program's access to earlier models. That access is not a tier: a profile that has it alone reads active with every tier inactive, or with tiers {} on a response that does not report tiers. When nothing is active, pending means that an application or enrollment is under review, or that what Anthropic approved does not yet apply to this profile, and rejected means that the application or enrollment was declined.
The program's tiers, keyed by tier: a (Specialized Access), b (Red Team Access) and c (Defense Access). A response reports either every tier or none. When it reports them, as retrieving the profile normally does, every tier has a key, whether or not it applies to the profile. When it does not, as in the list of user profiles, tiers is {}, which does not mean that the tiers are inactive. No tier implies another, so read the tier you need. Anthropic may add tiers; ignore a key you do not recognize.
class UserProfileCyberRequirements { $dataRetention; $humanReview; }
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.
class UserProfileCyberTier { $status; }
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.
class UserProfileEfsFeature { $status; }
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.
class UserProfileEfsProgram { $features; $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.
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.
class UserProfileEnforcementActionBan { $type = 'ban'; $id; $action; /* 3 more */ }
The action's ID (enac_...), stable while the action is open.
Always null: the end user cannot clear a ban.
Always null: a ban has no end date.
When Anthropic opened the action, in RFC 3339 format.
Why Anthropic placed the limit: unsupported_region, fraud_or_abuse, high_harm, usage_policy_violation, account_compromise or unspecified.
class UserProfileEnforcementActionRestriction { $type = 'restriction'; $id; $action; /* 3 more */ }
The action's ID (enac_...), stable while the action is open.
The next step on the action: verify or null. verify: the end user can clear it now by passing an identity check. null: there is nothing the end user can do now to clear it, including while Anthropic reviews an identity check the end user submitted.
When the action ends on its own, in RFC 3339 format; it stops showing once this time has passed. null when it has no end date, and always null when reason is account_compromise.
When Anthropic opened the action, in RFC 3339 format.
Why Anthropic placed the limit: unsupported_region, fraud_or_abuse, high_harm, usage_policy_violation, account_compromise or unspecified.
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.
class UserProfileExternalUserDetails { $accountStatus; $country; $emailHash; /* 4 more */ }
The status of the entity's account on the platform: active, suspended or blocked. null until the platform supplies one.
The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. null until the platform supplies one.
The platform-computed hash of the entity's email address. null until the platform supplies one.
What kind of entity the profile represents: individual, business, non_profit or government. null until the platform supplies one.
The platform-computed hash of the entity's name. null until the platform supplies one.
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.
The platform's own reference for the entity. null until the platform supplies one.
class UserProfileExternalUserDetailsParams { $accountStatus; $country; $emailHash; /* 4 more */ }
The status of the entity's account on the platform: active, suspended or blocked.
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.
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.
What kind of entity the profile represents: individual, business, non_profit or government.
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.
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.
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.
enum UserProfileListOrder
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.
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.
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.
class UserProfilePrograms { $cyber; $efs; }
The profile's standing in the Cyber Verification Program. null when the profile has no status in it. Only retrieving the profile gives the full answer: a list or update response can show null, or a status other than active, for a profile that reads active when retrieved.
The profile's standing in Enterprise Frontier Safeguards. null unless the platform's attestation for the program is in place on this profile, or the entity it represents has applied to the program. A list of user profiles does not report this program: there it reads null for every profile, so retrieve the profile to read it.