--- title: User Profiles url: https://platform.claude.com/docs/en/api/php/user_profiles --- # User Profiles ## Create User Profile `$client->userProfiles->create(?UserProfileAccessType accessType, ?UserProfileExternalUserDetailsParams externalUserDetails, ?array metadata, ?string name, ?string workspaceID): UserProfile` **POST** `/v1/user_profiles` Create User Profile ### Parameters - `accessType?: optional UserProfileAccessType` How the platform uses the API for this entity. `application` (default): the profile represents an individual end-user of the platform's product. `passthrough`: the profile identifies a company the platform resells Claude access to. - `externalUserDetails?: optional UserProfileExternalUserDetailsParams` Details about the entity this profile represents, as the platform states them. Every field is optional. Not accepted under the legacy `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers, which take the top-level `external_id` (and, under `user-profiles-2026-08-18`, `external_user_onboarded_at`) instead. - `metadata?: optional array` Free-form key-value data to attach to this user profile. Maximum 16 keys, with keys up to 64 characters and values up to 512 characters. Values must be non-empty strings. - `name?: optional string` Optional for all profiles. Real-world name of the entity this profile represents (company or individual); for a company the platform resells Claude access to (`access_type` `passthrough`), that company's name where known. Maximum 255 characters. - `workspaceID?: optional string` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ### Returns - `class UserProfile` - `"user_profile" type` Object type. Always `user_profile`. - `string id` Unique identifier for this user profile, prefixed `uprof_`. - `UserProfileAccessType accessType` How the platform uses the API for this entity: `application` (default) or `passthrough`. Absent under the legacy `user-profiles-2026-03-24` beta header. - `\Datetime createdAt` When this user profile was created, in RFC 3339 format. - `list enforcementActions` The enforcement actions open on this profile; empty when none is open. Absent under the `user-profiles-2026-09-04` and earlier beta headers. - `UserProfileEnforcementStatus enforcementStatus` Anthropic's enforcement status of this profile, from its open enforcement actions and any identity check under review, by the first rule that applies: `banned` while any open action is a `ban`; `pending` while a restriction that an identity check can clear is open, the end user has submitted that check, Anthropic's review of it has not ended, and no open action's `reason` is `account_compromise`; `restricted` while any action is open; `unrestricted` while none is. Absent under the `user-profiles-2026-09-04` and earlier beta headers. - `UserProfileExternalUserDetails externalUserDetails` Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Every field is present, `null` until the platform supplies a value. Absent under the legacy `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers, which serve `reference_id` as the top-level `external_id` and, under `user-profiles-2026-08-18`, `onboarded_at` as `external_user_onboarded_at`. - `array metadata` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `?string name` Real-world name of the entity this profile represents (company or individual). For a company the platform resells Claude access to (`access_type` `passthrough`) this is that company's name. `null` until the platform supplies one. - `UserProfilePrograms programs` The profile's standing in each Anthropic program, such as the Cyber Verification Program. Present when the request sends no user-profiles beta header; absent under the `user-profiles-2026-09-04` and earlier beta headers, which serve `trust_grants` instead. - `\Datetime updatedAt` When this user profile was last modified, in RFC 3339 format. It normally also updates shortly after Anthropic gives the profile an approval or withdraws one. Other changes to the statuses that Anthropic reports do not always update it, so read the status itself rather than watching this timestamp. ### Example ```php userProfiles->create( accessType: UserProfileAccessType::APPLICATION, externalUserDetails: [ 'accountStatus' => UserProfileExternalUserAccountStatus::ACTIVE, 'country' => 'US', 'emailHash' => 'x', 'entityType' => UserProfileExternalUserEntityType::BUSINESS, 'nameHash' => 'x', 'onboardedAt' => new \DateTimeImmutable('2024-11-02T08:15:00Z'), 'referenceID' => 'user_12345', ], metadata: [], name: 'Example User', workspaceID: 'wrkspc_011CZkZaBF1tNoB5wlCeusgy', ); var_dump($userProfile); ``` #### Response (200) ```json { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "access_type": "application", "created_at": "2026-03-15T10:00:00Z", "enforcement_actions": [ { "id": "enac_011CZkZCu8hGbp5mYRQgUmz9", "action": "verify", "expires_at": null, "opened_at": "2026-10-02T19:30:00Z", "reason": "fraud_or_abuse", "type": "restriction" } ], "enforcement_status": "unrestricted", "external_user_details": { "account_status": "active", "country": "US", "email_hash": null, "entity_type": "business", "name_hash": null, "onboarded_at": "2024-11-02T08:15:00Z", "reference_id": "user_12345" }, "metadata": {}, "name": "Example User", "programs": { "cyber": { "requirements": { "data_retention": true, "human_review": true }, "status": "active", "tiers": { "a": { "status": "inactive" }, "b": { "status": "inactive" }, "c": { "status": "inactive" } } }, "efs": { "features": { "data_retention_exemption": { "status": "inactive" }, "cmek": { "status": "active" }, "storage": { "status": "inactive" } }, "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z" } ``` ## List User Profiles `$client->userProfiles->list(?list enforcementStatus, ?int limit, ?UserProfileListOrder order, ?UserProfileListOrderBy orderBy, ?string page, ?string workspaceID): PageCursor` **GET** `/v1/user_profiles` List User Profiles ### Parameters - `enforcementStatus?: optional list` (query parameter) Return only the user profiles whose `enforcement_status` is one of these values: `unrestricted`, `pending`, `restricted` or `banned`. Repeat the parameter to match any of several. With it set, a page may hold fewer than `limit` profiles, or none, and still carry a `next_page`: the service examines a bounded number of profiles per request, and only a null `next_page` means the listing is complete. Rejected with `invalid_request_error` under the `user-profiles-2026-09-04` and earlier beta headers. Fails with `overloaded_error` when a profile's enforcement actions cannot be read for the moment. - `limit?: optional int` (query parameter) The maximum number of user profiles to return, from 1 to 100. Defaults to 20. - `order?: optional UserProfileListOrder` (query parameter) The sort direction, applied to the field that `order_by` selects. Defaults to `desc`. - `orderBy?: optional UserProfileListOrderBy` (query parameter) The field to sort user profiles by, in the direction that `order` sets. Defaults to `created_at`. - `page?: optional string` (query parameter) The cursor for the page to return, taken from `next_page` in a previous response. Leave it out to get the first page. - `workspaceID?: optional string` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ### Returns - `class UserProfile` - `"user_profile" type` Object type. Always `user_profile`. - `string id` Unique identifier for this user profile, prefixed `uprof_`. - `UserProfileAccessType accessType` How the platform uses the API for this entity: `application` (default) or `passthrough`. Absent under the legacy `user-profiles-2026-03-24` beta header. - `\Datetime createdAt` When this user profile was created, in RFC 3339 format. - `list enforcementActions` The enforcement actions open on this profile; empty when none is open. Absent under the `user-profiles-2026-09-04` and earlier beta headers. - `UserProfileEnforcementStatus enforcementStatus` Anthropic's enforcement status of this profile, from its open enforcement actions and any identity check under review, by the first rule that applies: `banned` while any open action is a `ban`; `pending` while a restriction that an identity check can clear is open, the end user has submitted that check, Anthropic's review of it has not ended, and no open action's `reason` is `account_compromise`; `restricted` while any action is open; `unrestricted` while none is. Absent under the `user-profiles-2026-09-04` and earlier beta headers. - `UserProfileExternalUserDetails externalUserDetails` Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Every field is present, `null` until the platform supplies a value. Absent under the legacy `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers, which serve `reference_id` as the top-level `external_id` and, under `user-profiles-2026-08-18`, `onboarded_at` as `external_user_onboarded_at`. - `array metadata` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `?string name` Real-world name of the entity this profile represents (company or individual). For a company the platform resells Claude access to (`access_type` `passthrough`) this is that company's name. `null` until the platform supplies one. - `UserProfilePrograms programs` The profile's standing in each Anthropic program, such as the Cyber Verification Program. Present when the request sends no user-profiles beta header; absent under the `user-profiles-2026-09-04` and earlier beta headers, which serve `trust_grants` instead. - `\Datetime updatedAt` When this user profile was last modified, in RFC 3339 format. It normally also updates shortly after Anthropic gives the profile an approval or withdraws one. Other changes to the statuses that Anthropic reports do not always update it, so read the status itself rather than watching this timestamp. ### Example ```php userProfiles->list( enforcementStatus: [UserProfileEnforcementStatus::UNRESTRICTED], limit: 0, order: UserProfileListOrder::ASC, orderBy: UserProfileListOrderBy::CREATED_AT, page: 'page', workspaceID: 'wrkspc_011CZkZaBF1tNoB5wlCeusgy', ); var_dump($page); ``` #### Response (200) ```json { "data": [ { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "access_type": "application", "created_at": "2026-03-15T10:00:00Z", "enforcement_actions": [ { "id": "enac_011CZkZCu8hGbp5mYRQgUmz9", "action": "verify", "expires_at": null, "opened_at": "2026-10-02T19:30:00Z", "reason": "fraud_or_abuse", "type": "restriction" } ], "enforcement_status": "unrestricted", "external_user_details": { "account_status": "active", "country": "US", "email_hash": null, "entity_type": "business", "name_hash": null, "onboarded_at": "2024-11-02T08:15:00Z", "reference_id": "user_12345" }, "metadata": {}, "name": "Example User", "programs": { "cyber": { "requirements": { "data_retention": true, "human_review": true }, "status": "active", "tiers": {} }, "efs": { "features": { "data_retention_exemption": { "status": "inactive" }, "cmek": { "status": "active" }, "storage": { "status": "inactive" } }, "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z" } ], "next_page": "page_MjAyNS0wNS0xNFQwMDowMDowMFo=" } ``` ## Get User Profile `$client->userProfiles->retrieve(string userProfileID, ?string workspaceID): UserProfile` **GET** `/v1/user_profiles/{user_profile_id}` Get User Profile ### Parameters - `userProfileID: string` (path parameter) The ID of the user profile to get (`uprof_...`). - `workspaceID?: optional string` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ### Returns - `class UserProfile` - `"user_profile" type` Object type. Always `user_profile`. - `string id` Unique identifier for this user profile, prefixed `uprof_`. - `UserProfileAccessType accessType` How the platform uses the API for this entity: `application` (default) or `passthrough`. Absent under the legacy `user-profiles-2026-03-24` beta header. - `\Datetime createdAt` When this user profile was created, in RFC 3339 format. - `list enforcementActions` The enforcement actions open on this profile; empty when none is open. Absent under the `user-profiles-2026-09-04` and earlier beta headers. - `UserProfileEnforcementStatus enforcementStatus` Anthropic's enforcement status of this profile, from its open enforcement actions and any identity check under review, by the first rule that applies: `banned` while any open action is a `ban`; `pending` while a restriction that an identity check can clear is open, the end user has submitted that check, Anthropic's review of it has not ended, and no open action's `reason` is `account_compromise`; `restricted` while any action is open; `unrestricted` while none is. Absent under the `user-profiles-2026-09-04` and earlier beta headers. - `UserProfileExternalUserDetails externalUserDetails` Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Every field is present, `null` until the platform supplies a value. Absent under the legacy `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers, which serve `reference_id` as the top-level `external_id` and, under `user-profiles-2026-08-18`, `onboarded_at` as `external_user_onboarded_at`. - `array metadata` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `?string name` Real-world name of the entity this profile represents (company or individual). For a company the platform resells Claude access to (`access_type` `passthrough`) this is that company's name. `null` until the platform supplies one. - `UserProfilePrograms programs` The profile's standing in each Anthropic program, such as the Cyber Verification Program. Present when the request sends no user-profiles beta header; absent under the `user-profiles-2026-09-04` and earlier beta headers, which serve `trust_grants` instead. - `\Datetime updatedAt` When this user profile was last modified, in RFC 3339 format. It normally also updates shortly after Anthropic gives the profile an approval or withdraws one. Other changes to the statuses that Anthropic reports do not always update it, so read the status itself rather than watching this timestamp. ### Example ```php userProfiles->retrieve( 'uprof_011CZkZCu8hGbp5mYRQgUmz9', workspaceID: 'wrkspc_011CZkZaBF1tNoB5wlCeusgy', ); var_dump($userProfile); ``` #### Response (200) ```json { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "access_type": "application", "created_at": "2026-03-15T10:00:00Z", "enforcement_actions": [ { "id": "enac_011CZkZCu8hGbp5mYRQgUmz9", "action": "verify", "expires_at": null, "opened_at": "2026-10-02T19:30:00Z", "reason": "fraud_or_abuse", "type": "restriction" } ], "enforcement_status": "unrestricted", "external_user_details": { "account_status": "active", "country": "US", "email_hash": null, "entity_type": "business", "name_hash": null, "onboarded_at": "2024-11-02T08:15:00Z", "reference_id": "user_12345" }, "metadata": {}, "name": "Example User", "programs": { "cyber": { "requirements": { "data_retention": true, "human_review": true }, "status": "active", "tiers": { "a": { "status": "inactive" }, "b": { "status": "inactive" }, "c": { "status": "inactive" } } }, "efs": { "features": { "data_retention_exemption": { "status": "inactive" }, "cmek": { "status": "active" }, "storage": { "status": "inactive" } }, "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z" } ``` ## Update User Profile `$client->userProfiles->update(string userProfileID, ?UserProfileAccessType accessType, ?UserProfileExternalUserDetailsParams externalUserDetails, ?array metadata, ?string name, ?string workspaceID): UserProfile` **POST** `/v1/user_profiles/{user_profile_id}` Update User Profile ### Parameters - `userProfileID: string` (path parameter) The ID of the user profile to update (`uprof_...`). - `accessType?: optional UserProfileAccessType` If present, replaces the stored access type. Omit to leave unchanged. - `externalUserDetails?: optional UserProfileExternalUserDetailsParams` Details about the entity this profile represents, as the platform states them. Each field sent replaces the stored value; omit a field to leave it unchanged. Once set, a value cannot be cleared and `null` is rejected. Not accepted under the legacy `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers. - `metadata?: optional array` Key-value pairs to merge into the stored metadata. Keys provided overwrite existing values. To remove a key, set its value to an empty string. Keys not provided are left unchanged. Maximum 16 keys, with keys up to 64 characters and values up to 512 characters. - `name?: optional string` If present, replaces the stored name. Omit to leave unchanged. Maximum 255 characters. - `workspaceID?: optional string` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ### Returns - `class UserProfile` - `"user_profile" type` Object type. Always `user_profile`. - `string id` Unique identifier for this user profile, prefixed `uprof_`. - `UserProfileAccessType accessType` How the platform uses the API for this entity: `application` (default) or `passthrough`. Absent under the legacy `user-profiles-2026-03-24` beta header. - `\Datetime createdAt` When this user profile was created, in RFC 3339 format. - `list enforcementActions` The enforcement actions open on this profile; empty when none is open. Absent under the `user-profiles-2026-09-04` and earlier beta headers. - `UserProfileEnforcementStatus enforcementStatus` Anthropic's enforcement status of this profile, from its open enforcement actions and any identity check under review, by the first rule that applies: `banned` while any open action is a `ban`; `pending` while a restriction that an identity check can clear is open, the end user has submitted that check, Anthropic's review of it has not ended, and no open action's `reason` is `account_compromise`; `restricted` while any action is open; `unrestricted` while none is. Absent under the `user-profiles-2026-09-04` and earlier beta headers. - `UserProfileExternalUserDetails externalUserDetails` Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Every field is present, `null` until the platform supplies a value. Absent under the legacy `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers, which serve `reference_id` as the top-level `external_id` and, under `user-profiles-2026-08-18`, `onboarded_at` as `external_user_onboarded_at`. - `array metadata` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `?string name` Real-world name of the entity this profile represents (company or individual). For a company the platform resells Claude access to (`access_type` `passthrough`) this is that company's name. `null` until the platform supplies one. - `UserProfilePrograms programs` The profile's standing in each Anthropic program, such as the Cyber Verification Program. Present when the request sends no user-profiles beta header; absent under the `user-profiles-2026-09-04` and earlier beta headers, which serve `trust_grants` instead. - `\Datetime updatedAt` When this user profile was last modified, in RFC 3339 format. It normally also updates shortly after Anthropic gives the profile an approval or withdraws one. Other changes to the statuses that Anthropic reports do not always update it, so read the status itself rather than watching this timestamp. ### Example ```php userProfiles->update( 'uprof_011CZkZCu8hGbp5mYRQgUmz9', accessType: UserProfileAccessType::APPLICATION, externalUserDetails: [ 'accountStatus' => UserProfileExternalUserAccountStatus::SUSPENDED, 'country' => 'SE', 'emailHash' => 'x', 'entityType' => UserProfileExternalUserEntityType::INDIVIDUAL, 'nameHash' => 'x', 'onboardedAt' => new \DateTimeImmutable('2019-12-27T18:11:19.117Z'), 'referenceID' => 'x', ], metadata: ['foo' => 'string'], name: 'x', workspaceID: 'wrkspc_011CZkZaBF1tNoB5wlCeusgy', ); var_dump($userProfile); ``` #### Response (200) ```json { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "access_type": "application", "created_at": "2026-03-15T10:00:00Z", "enforcement_actions": [ { "id": "enac_011CZkZCu8hGbp5mYRQgUmz9", "action": "verify", "expires_at": null, "opened_at": "2026-10-02T19:30:00Z", "reason": "fraud_or_abuse", "type": "restriction" } ], "enforcement_status": "unrestricted", "external_user_details": { "account_status": "active", "country": "US", "email_hash": null, "entity_type": "business", "name_hash": null, "onboarded_at": "2024-11-02T08:15:00Z", "reference_id": "user_12345" }, "metadata": {}, "name": "Example User", "programs": { "cyber": { "requirements": { "data_retention": true, "human_review": true }, "status": "active", "tiers": { "a": { "status": "inactive" }, "b": { "status": "inactive" }, "c": { "status": "inactive" } } }, "efs": { "features": { "data_retention_exemption": { "status": "inactive" }, "cmek": { "status": "active" }, "storage": { "status": "inactive" } }, "status": "active" } }, "type": "user_profile", "updated_at": "2026-03-15T10:00:00Z" } ``` ## Delete User Profile `$client->userProfiles->delete(string userProfileID, ?string workspaceID): DeletedUserProfile` **DELETE** `/v1/user_profiles/{user_profile_id}` Delete User Profile ### Parameters - `userProfileID: string` (path parameter) The ID of the user profile to delete (`uprof_...`). - `workspaceID?: optional string` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. ### Returns - `class DeletedUserProfile` - `"user_profile_deleted" type` Object type. Always `user_profile_deleted`. - `string id` Identifier of the deleted user profile, prefixed `uprof_`. ### Example ```php userProfiles->delete( 'uprof_011CZkZCu8hGbp5mYRQgUmz9', workspaceID: 'wrkspc_011CZkZaBF1tNoB5wlCeusgy', ); var_dump($deletedUserProfile); ``` #### Response (200) ```json { "id": "uprof_011CZkZCu8hGbp5mYRQgUmz9", "type": "user_profile_deleted" } ``` ## Domain types ### Deleted User Profile - `class DeletedUserProfile` - `"user_profile_deleted" type` Object type. Always `user_profile_deleted`. - `string id` Identifier of the deleted user profile, prefixed `uprof_`. ### User Profile - `class UserProfile` - `"user_profile" type` Object type. Always `user_profile`. - `string id` Unique identifier for this user profile, prefixed `uprof_`. - `UserProfileAccessType accessType` How the platform uses the API for this entity: `application` (default) or `passthrough`. Absent under the legacy `user-profiles-2026-03-24` beta header. - `\Datetime createdAt` When this user profile was created, in RFC 3339 format. - `list enforcementActions` The enforcement actions open on this profile; empty when none is open. Absent under the `user-profiles-2026-09-04` and earlier beta headers. - `UserProfileEnforcementStatus enforcementStatus` Anthropic's enforcement status of this profile, from its open enforcement actions and any identity check under review, by the first rule that applies: `banned` while any open action is a `ban`; `pending` while a restriction that an identity check can clear is open, the end user has submitted that check, Anthropic's review of it has not ended, and no open action's `reason` is `account_compromise`; `restricted` while any action is open; `unrestricted` while none is. Absent under the `user-profiles-2026-09-04` and earlier beta headers. - `UserProfileExternalUserDetails externalUserDetails` Details about the entity this profile represents, as the platform states them; not verified by Anthropic. Every field is present, `null` until the platform supplies a value. Absent under the legacy `user-profiles-2026-03-24` and `user-profiles-2026-08-18` beta headers, which serve `reference_id` as the top-level `external_id` and, under `user-profiles-2026-08-18`, `onboarded_at` as `external_user_onboarded_at`. - `array metadata` Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars. - `?string name` Real-world name of the entity this profile represents (company or individual). For a company the platform resells Claude access to (`access_type` `passthrough`) this is that company's name. `null` until the platform supplies one. - `UserProfilePrograms programs` The profile's standing in each Anthropic program, such as the Cyber Verification Program. Present when the request sends no user-profiles beta header; absent under the `user-profiles-2026-09-04` and earlier beta headers, which serve `trust_grants` instead. - `\Datetime updatedAt` When this user profile was last modified, in RFC 3339 format. It normally also updates shortly after Anthropic gives the profile an approval or withdraws one. Other changes to the statuses that Anthropic reports do not always update it, so read the status itself rather than watching this timestamp. ### User Profile Access Type - `enum UserProfileAccessType` - `"application"` The user profile represents an individual end-user of a product that the platform builds on the API. New profiles get this value by default. - `"passthrough"` The user profile represents a company that the platform resells Claude access to. ### User Profile Cyber Program - `class UserProfileCyberProgram` - `?UserProfileCyberRequirements requirements` What a request that names the profile must allow to get the relaxed safeguards of every `active` tier. `null` when no tier is `active`, and wherever `tiers` is `{}`. - `UserProfileProgramStatus status` `active` when at least one tier is `active`, or when the profile has the program's access to earlier models. That access is not a tier: a profile that has it alone reads `active` with every tier `inactive`, or with `tiers` `{}` on a response that does not report tiers. When nothing is `active`, `pending` means that an application or enrollment is under review, or that what Anthropic approved does not yet apply to this profile, and `rejected` means that the application or enrollment was declined. - `array tiers` The program's tiers, keyed by tier: `a` (Specialized Access), `b` (Red Team Access) and `c` (Defense Access). A response reports either every tier or none. When it reports them, as retrieving the profile normally does, every tier has a key, whether or not it applies to the profile. When it does not, as in the list of user profiles, `tiers` is `{}`, which does not mean that the tiers are inactive. No tier implies another, so read the tier you need. Anthropic may add tiers; ignore a key you do not recognize. ### User Profile Cyber Requirements - `class UserProfileCyberRequirements` - `bool dataRetention` Whether Anthropic must be able to retain the request's inference data. - `bool humanReview` Whether Anthropic personnel must be allowed to review the data retained from the request. ### User Profile Cyber Tier - `class UserProfileCyberTier` - `Status status` `active` when the tier applies to the profile, otherwise `inactive`. The response does not say why a tier is `inactive`: it can be in review, declined, withdrawn, never applied for, or approved but not applied to this profile. ### User Profile Efs Feature - `class UserProfileEfsFeature` - `Status status` `active` when Anthropic has approved the entity the profile represents to use the feature, otherwise `inactive`. `active` does not mean that the feature is set up or switched on, which is a separate step. ### User Profile Efs Program - `class UserProfileEfsProgram` - `array features` The program's features, keyed by feature: `data_retention_exemption` (use of models that normally require data retention, without the data being retained), `cmek` (customer-managed encryption keys) and `storage` (customer-owned storage). Every feature that the caller's organization may read has a key, whether or not it is approved; a missing key does not mean that the feature is inactive. Anthropic may add features; ignore a key you do not recognize. - `UserProfileProgramStatus status` Anthropic's decision on the entity the profile represents: `pending` while it is awaited, `active` once Anthropic has approved the entity for the program, or `rejected` once Anthropic has declined or has removed the entity from the program. `active` does not mean that any one feature is approved: read the feature you need in `features`. ### User Profile Enforcement Action - `class UserProfileEnforcementAction` - `class UserProfileEnforcementActionRestriction` - `"restriction" type` - `string id` The action's ID (`enac_...`), stable while the action is open. - `?UserProfileEnforcementActionNextStep action` The next step on the action: `verify` or `null`. `verify`: the end user can clear it now by passing an identity check. `null`: there is nothing the end user can do now to clear it, including while Anthropic reviews an identity check the end user submitted. - `?\Datetime expiresAt` When the action ends on its own, in RFC 3339 format; it stops showing once this time has passed. `null` when it has no end date, and always `null` when `reason` is `account_compromise`. - `\Datetime openedAt` When Anthropic opened the action, in RFC 3339 format. - `UserProfileEnforcementActionReason reason` Why Anthropic placed the limit: `unsupported_region`, `fraud_or_abuse`, `high_harm`, `usage_policy_violation`, `account_compromise` or `unspecified`. - `class UserProfileEnforcementActionBan` - `"ban" type` - `string id` The action's ID (`enac_...`), stable while the action is open. - `?UserProfileEnforcementActionNextStep action` Always `null`: the end user cannot clear a ban. - `?\Datetime expiresAt` Always `null`: a ban has no end date. - `\Datetime openedAt` When Anthropic opened the action, in RFC 3339 format. - `UserProfileEnforcementActionReason reason` Why Anthropic placed the limit: `unsupported_region`, `fraud_or_abuse`, `high_harm`, `usage_policy_violation`, `account_compromise` or `unspecified`. ### User Profile Enforcement Action Ban - `class UserProfileEnforcementActionBan` - `"ban" type` - `string id` The action's ID (`enac_...`), stable while the action is open. - `?UserProfileEnforcementActionNextStep action` Always `null`: the end user cannot clear a ban. - `?\Datetime expiresAt` Always `null`: a ban has no end date. - `\Datetime openedAt` When Anthropic opened the action, in RFC 3339 format. - `UserProfileEnforcementActionReason reason` Why Anthropic placed the limit: `unsupported_region`, `fraud_or_abuse`, `high_harm`, `usage_policy_violation`, `account_compromise` or `unspecified`. ### User Profile Enforcement Action Next Step - `enum UserProfileEnforcementActionNextStep` ### User Profile Enforcement Action Reason - `enum UserProfileEnforcementActionReason` - `"unsupported_region"` - `"fraud_or_abuse"` - `"high_harm"` - `"usage_policy_violation"` - `"account_compromise"` - `"unspecified"` ### User Profile Enforcement Action Restriction - `class UserProfileEnforcementActionRestriction` - `"restriction" type` - `string id` The action's ID (`enac_...`), stable while the action is open. - `?UserProfileEnforcementActionNextStep action` The next step on the action: `verify` or `null`. `verify`: the end user can clear it now by passing an identity check. `null`: there is nothing the end user can do now to clear it, including while Anthropic reviews an identity check the end user submitted. - `?\Datetime expiresAt` When the action ends on its own, in RFC 3339 format; it stops showing once this time has passed. `null` when it has no end date, and always `null` when `reason` is `account_compromise`. - `\Datetime openedAt` When Anthropic opened the action, in RFC 3339 format. - `UserProfileEnforcementActionReason reason` Why Anthropic placed the limit: `unsupported_region`, `fraud_or_abuse`, `high_harm`, `usage_policy_violation`, `account_compromise` or `unspecified`. ### User Profile Enforcement Status - `enum UserProfileEnforcementStatus` - `"unrestricted"` - `"pending"` - `"restricted"` - `"banned"` ### User Profile External User Account Status - `enum UserProfileExternalUserAccountStatus` - `"active"` The platform has neither restricted nor barred the account of the entity that the user profile represents. - `"suspended"` The platform has restricted the account of the entity that the user profile represents and may restore it. - `"blocked"` The platform has barred the account of the entity that the user profile represents. ### User Profile External User Details - `class UserProfileExternalUserDetails` - `?UserProfileExternalUserAccountStatus 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. - `?UserProfileExternalUserEntityType 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. ### User Profile External User Details Params - `class UserProfileExternalUserDetailsParams` - `?UserProfileExternalUserAccountStatus 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. - `?UserProfileExternalUserEntityType 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. ### User Profile External User Entity Type - `enum UserProfileExternalUserEntityType` - `"individual"` - `"business"` - `"non_profit"` - `"government"` ### User Profile List Order - `enum UserProfileListOrder` - `"asc"` Oldest first when `order_by` is `created_at`, or names in ascending order when `order_by` is `name`. - `"desc"` Newest first when `order_by` is `created_at`, or names in descending order when `order_by` is `name`. This is the default. ### User Profile List Order By - `enum UserProfileListOrderBy` - `"created_at"` Sort by when each user profile was created. This is the default. - `"name"` Sort by `name`, ignoring the case of ASCII letters. Profiles without a name come last in either direction. ### User Profile Program Status - `enum UserProfileProgramStatus` - `"active"` The profile is in the program. - `"pending"` The profile is not in the program yet, and something is still awaited. - `"rejected"` The profile is not in the program and nothing is awaited: Anthropic has declined, or has withdrawn an earlier approval. ### User Profile Programs - `class UserProfilePrograms` - `?UserProfileCyberProgram cyber` The profile's standing in the Cyber Verification Program. `null` when the profile has no status in it. Only retrieving the profile gives the full answer: a list or update response can show `null`, or a status other than `active`, for a profile that reads `active` when retrieved. - `?UserProfileEfsProgram efs` The profile's standing in Enterprise Frontier Safeguards. `null` unless the platform's attestation for the program is in place on this profile, or the entity it represents has applied to the program. A list of user profiles does not report this program: there it reads `null` for every profile, so retrieve the profile to read it. ## User Profiles › Action URLs ### Create Action URL `$client->userProfiles->actionURLs->create(string userProfileID, UserProfileEnrollEndUserAction action, ?string workspaceID): UserProfileActionURL` **POST** `/v1/user_profiles/{user_profile_id}/action_urls` Create Action URL #### Parameters - `userProfileID: string` (path parameter) The ID of the user profile the action is for (`uprof_...`). - `action: UserProfileEnrollEndUserAction` The action that the person who opens the URL takes. - `workspaceID?: optional string` (header parameter) Optional header to select the Workspace for this request. The value is a Workspace ID (for example, `wrkspc_011CZkZaBF1tNoB5wlCeusgy`). Only needed for credentials that can act on more than one Workspace. A credential that belongs to a specific Workspace may omit it; if sent, it must match that Workspace. #### Returns - `class UserProfileActionURL` - `"user_profile_action_url" type` Object type. Always `user_profile_action_url`. - `\Datetime expiresAt` When the URL stops working, in RFC 3339 format. - `string url` The URL to give to the person who takes the action. Anyone who holds it can open it until `expires_at`. #### Example ```php userProfiles->actionURLs->create( 'uprof_011CZkZCu8hGbp5mYRQgUmz9', action: ['type' => 'enroll_end_user'], workspaceID: 'wrkspc_011CZkZaBF1tNoB5wlCeusgy', ); var_dump($userProfileActionURL); ``` ##### Response (200) ```json { "expires_at": "2026-03-15T10:15:00Z", "type": "user_profile_action_url", "url": "https://platform.claude.com/user-profiles/enrollment/M3J0bGJxZ2ppMnptbnB1" } ```