Claude Platform Docs

用户配置文件

创建用户配置文件
BetaUserProfile beta().userProfiles().create(params = UserProfileCreateParams.none(), requestOptions = RequestOptions.none())
POST/v1/user_profiles
列出用户配置文件
UserProfileListPage beta().userProfiles().list(params = UserProfileListParams.none(), requestOptions = RequestOptions.none())
GET/v1/user_profiles
获取用户配置文件
BetaUserProfile beta().userProfiles().retrieve(params = UserProfileRetrieveParams.none(), requestOptions = RequestOptions.none())
GET/v1/user_profiles/{user_profile_id}
更新用户配置文件
BetaUserProfile beta().userProfiles().update(params = UserProfileUpdateParams.none(), requestOptions = RequestOptions.none())
POST/v1/user_profiles/{user_profile_id}
创建注册 URL
BetaUserProfileEnrollmentUrl beta().userProfiles().createEnrollmentUrl(params = UserProfileCreateEnrollmentUrlParams.none(), requestOptions = RequestOptions.none())
POST/v1/user_profiles/{user_profile_id}/enrollment_url
Models
class BetaUserProfile { type; id; createdAt; /* 8 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 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.

class BetaUserProfileEnrollmentUrl { type; expiresAt; url; }

A URL to give to the entity that a user profile represents, so that the entity can enroll for a trust grant.

Type type

Object type. Always enrollment_url.

LocalDateTime expiresAt

When this enrollment URL expires, in RFC 3339 format.

formatdate-time
String url

Enrollment URL to send to the end user. Valid until expires_at.

class BetaUserProfileExternalUserDetails { accountStatus; country; emailHash; /* 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.

class BetaUserProfileExternalUserDetailsParams { accountStatus; country; emailHash; /* 4 more */ }
class BetaUserProfileTrustGrant { status; }

The status of one trust grant on a user profile, listed in the profile's trust_grants map under the grant's name.

Status status

Status of the trust grant.

One of the following:
ACTIVE("active")
PENDING("pending")
REJECTED("rejected")