Claude Platform Docs

User Profiles

Create User Profile
BetaUserProfile Beta.UserProfiles.Create(parameters, cancellationToken = default)
POST/v1/user_profiles
List User Profiles
UserProfileListPage Beta.UserProfiles.List(parameters, cancellationToken = default)
GET/v1/user_profiles
Get User Profile
BetaUserProfile Beta.UserProfiles.Retrieve(parameters, cancellationToken = default)
GET/v1/user_profiles/{user_profile_id}
Update User Profile
BetaUserProfile Beta.UserProfiles.Update(parameters, cancellationToken = default)
POST/v1/user_profiles/{user_profile_id}
Delete User Profile
BetaDeletedUserProfile Beta.UserProfiles.Delete(parameters, cancellationToken = default)
DELETE/v1/user_profiles/{user_profile_id}
Create Enrollment URL
BetaUserProfileEnrollmentUrl Beta.UserProfiles.CreateEnrollmentUrl(parameters, cancellationToken = default)
POST/v1/user_profiles/{user_profile_id}/enrollment_url
Models
class BetaDeletedUserProfile { Type = "user_profile_deleted"; ID; }
JsonElement Type = "user_profile_deleted"

Object type. Always user_profile_deleted.

required string ID

Identifier of the deleted user profile, prefixed uprof_.

class BetaUserProfile { Type = "user_profile"; 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 = "enrollment_url"; ExpiresAt; Url; }

A URL to give to the entity that a user profile represents, so that the entity can enroll in a program.

JsonElement Type = "enrollment_url"

Object type. Always enrollment_url.

required DateTimeOffset ExpiresAt

When this enrollment URL expires, in RFC 3339 format.

formatdate-time
required 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.

required Status Status

Status of the trust grant.

One of the following:
Active("active")
Pending("pending")
Rejected("rejected")

User ProfilesAction URLs

Create Action URL
BetaUserProfileActionUrl Beta.UserProfiles.ActionUrls.Create(parameters, cancellationToken = default)
POST/v1/user_profiles/{user_profile_id}/action_urls