사용자 프로필

사용자 프로필 생성

$client->beta->userProfiles->create(?AccessType accessType, ?string externalID, ?BetaUserProfileExternalUserDetailsParams externalUserDetails, ?\Datetime externalUserOnboardedAt, ?array<string,string> metadata, ?string name, ?list<AnthropicBeta> betas, ?string workspaceID): BetaUserProfile

POST/v1/user_profiles

사용자 프로필 목록 조회

$client->beta->userProfiles->list(?int limit, ?Order order, ?OrderBy orderBy, ?string page, ?list<AnthropicBeta> betas, ?string workspaceID): PageCursor<BetaUserProfile>

GET/v1/user_profiles

사용자 프로필 조회

$client->beta->userProfiles->retrieve(string userProfileID, ?list<AnthropicBeta> betas, ?string workspaceID): BetaUserProfile

GET/v1/user_profiles/{user_profile_id}

사용자 프로필 업데이트

$client->beta->userProfiles->update(string userProfileID, ?AccessType accessType, ?string externalID, ?BetaUserProfileExternalUserDetailsParams externalUserDetails, ?\Datetime externalUserOnboardedAt, ?array<string,string> metadata, ?string name, ?list<AnthropicBeta> betas, ?string workspaceID): BetaUserProfile

POST/v1/user_profiles/{user_profile_id}

사용자 프로필 삭제

$client->beta->userProfiles->delete(string userProfileID, ?list<AnthropicBeta> betas, ?string workspaceID): BetaDeletedUserProfile

DELETE/v1/user_profiles/{user_profile_id}

등록 URL 생성

$client->beta->userProfiles->createEnrollmentURL(string userProfileID, ?list<AnthropicBeta> betas, ?string workspaceID): BetaUserProfileEnrollmentURL

POST/v1/user_profiles/{user_profile_id}/enrollment_url

Models

class BetaDeletedUserProfile { $type = 'user_profile_deleted'; $id; }

"user_profile_deleted" type

Object type. Always user_profile_deleted.

string id

Identifier of the deleted user profile, prefixed uprof_.

class BetaUserProfile { $type = 'user_profile'; $id; $createdAt; /* 8 more */ }

class BetaUserProfileEnrollmentURL { $type = 'enrollment_url'; $expiresAt; $url; }

"enrollment_url" type

Object type. Always enrollment_url.

\Datetime expiresAt

When this enrollment URL expires, in RFC 3339 format.

string url

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

class BetaUserProfileExternalUserDetails { $accountStatus; $country; $emailHash; /* 4 more */ }

?AccountStatus accountStatus

The status of the entity's account on the platform: active, suspended or blocked. null until the platform supplies one.

?string country

The country the platform associates with the entity, as an ISO 3166-1 alpha-2 code. null until the platform supplies one.

?string emailHash

The platform-computed hash of the entity's email address. null until the platform supplies one.

?EntityType entityType

What kind of entity the profile represents: individual, business, non_profit or government. null until the platform supplies one.

?string nameHash

The platform-computed hash of the entity's name. null until the platform supplies one.

?\Datetime onboardedAt

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.

?string referenceID

The platform's own reference for the entity. null until the platform supplies one.

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

?AccountStatus accountStatus

The status of the entity's account on the platform: active, suspended or blocked.

?string country

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.

?string emailHash

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.

?EntityType entityType

What kind of entity the profile represents: individual, business, non_profit or government.

?string nameHash

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.

?\Datetime onboardedAt

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.

?string referenceID

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.

class BetaUserProfileTrustGrant { $status; }

Status status

Status of the trust grant.

사용자 프로필작업 URL

작업 URL 생성

$client->beta->userProfiles->actionURLs->create(string userProfileID, UserProfileEnrollEndUserAction action, ?list<AnthropicBeta> betas, ?string workspaceID): UserProfileActionURL

POST/v1/user_profiles/{user_profile_id}/action_urls