Claude Platform Docs

User Profiles

Create User Profile
client.beta.userProfiles.create(UserProfileCreateParamsparams, RequestOptionsoptions?): BetaUserProfile
POST/v1/user_profiles
List User Profiles
client.beta.userProfiles.list(UserProfileListParamsparams?, RequestOptionsoptions?): PageCursor<BetaUserProfile>
GET/v1/user_profiles
Get User Profile
client.beta.userProfiles.retrieve(stringuserProfileID, UserProfileRetrieveParamsparams?, RequestOptionsoptions?): BetaUserProfile
GET/v1/user_profiles/{user_profile_id}
Update User Profile
client.beta.userProfiles.update(stringuserProfileID, UserProfileUpdateParamsparams, RequestOptionsoptions?): BetaUserProfile
POST/v1/user_profiles/{user_profile_id}
Create Enrollment URL
client.beta.userProfiles.createEnrollmentURL(stringuserProfileID, UserProfileCreateEnrollmentURLParamsparams?, RequestOptionsoptions?): BetaUserProfileEnrollmentURL
POST/v1/user_profiles/{user_profile_id}/enrollment_url
Models
BetaUserProfile { id, created_at, metadata, 7 more }
BetaUserProfileEnrollmentURL { expires_at, type, url }
expires_at: string

A timestamp in RFC 3339 format

formatdate-time
type: "enrollment_url"

Object type. Always enrollment_url.

url: string

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

BetaUserProfileTrustGrant { status }
status: "active" | "pending" | "rejected"

Status of the trust grant.

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