Claude Platform Docs

使用者設定檔

建立使用者設定檔
beta.user_profiles.create(**kwargs) -> BetaUserProfile
POST/v1/user_profiles
列出使用者設定檔
beta.user_profiles.list(**kwargs) -> SyncPageCursor[BetaUserProfile]
GET/v1/user_profiles
取得使用者設定檔
beta.user_profiles.retrieve(user_profile_id, **kwargs) -> BetaUserProfile
GET/v1/user_profiles/{user_profile_id}
更新使用者設定檔
beta.user_profiles.update(user_profile_id, **kwargs) -> BetaUserProfile
POST/v1/user_profiles/{user_profile_id}
建立註冊 URL
beta.user_profiles.create_enrollment_url(user_profile_id, **kwargs) -> BetaUserProfileEnrollmentURL
POST/v1/user_profiles/{user_profile_id}/enrollment_url
Models
class BetaUserProfile: type: "user_profile"; id; created_at; ... # 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: "enrollment_url"; expires_at; url

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

type: Literal["enrollment_url"]

Object type. Always enrollment_url.

expires_at: datetime

When this enrollment URL expires, in RFC 3339 format.

formatdate-time
url: str

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

class BetaUserProfileExternalUserDetails: 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.

class BetaUserProfileExternalUserDetailsParams: account_status; country; email_hash; ... # 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: Literal["active", "pending", "rejected"]

Status of the trust grant.

One of the following:
"active"
"pending"
"rejected"