Class: Anthropic::Resources::Beta::UserProfiles

Inherits:
Object
  • Object
show all
Defined in:
lib/anthropic/resources/beta/user_profiles.rb,
sig/anthropic/resources/beta/user_profiles.rbs

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ UserProfiles

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of UserProfiles.

Parameters:



195
196
197
 
# File 'lib/anthropic/resources/beta/user_profiles.rb', line 195

def initialize(client:)
  @client = client
end

Instance Method Details

#create(access_type: nil, external_id: nil, external_user_details: nil, external_user_onboarded_at: nil, metadata: nil, name: nil, betas: nil, workspace_id: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaUserProfile

Create User Profile

Some parameter documentations has been truncated, see Models::Beta::UserProfileCreateParams for more details.

Parameters:

  • access_type (Symbol, Anthropic::Models::Beta::UserProfileCreateParams::AccessType) —

    Body param: How the platform uses the API on behalf of the entity this profile r

  • external_id (String, nil) —

    Body param: Platform's own identifier for this user. Not enforced unique. Maximu

  • external_user_details (Anthropic::Models::Beta::BetaUserProfileExternalUserDetailsParams) —

    Body param: Details about the entity this profile represents, as the platform st

  • external_user_onboarded_at (Time) —

    Body param: A timestamp in RFC 3339 format

  • metadata (Hash{Symbol=>String}) —

    Body param: Free-form key-value data to attach to this user profile. Maximum 16

  • name (String, nil) —

    Body param: Optional for all profiles. Real-world name of the entity this profil

  • betas (Array<Symbol, String, Anthropic::Models::AnthropicBeta>) —

    Header param: Optional header to specify the beta version(s) you want to use.

  • workspace_id (String) —

    Header param: Optional header to select the Workspace for this request. The valu

  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



35
36
37
38
39
40
41
42
43
44
45
46
 
# File 'lib/anthropic/resources/beta/user_profiles.rb', line 35

def create(params = {})
  parsed, options = Anthropic::Beta::UserProfileCreateParams.dump_request(params)
  header_params = {betas: "anthropic-beta", workspace_id: "anthropic-workspace-id"}
  @client.request(
    method: :post,
    path: "v1/user_profiles?beta=true",
    headers: parsed.slice(*header_params.keys).transform_keys(header_params),
    body: parsed.except(*header_params.keys),
    model: Anthropic::Beta::BetaUserProfile,
    options: {extra_headers: {"anthropic-beta" => "user-profiles-2026-08-18"}, **options}
  )
end

#create_enrollment_url(user_profile_id, betas: nil, workspace_id: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaUserProfileEnrollmentURL

Create Enrollment URL

Some parameter documentations has been truncated, see Models::Beta::UserProfileCreateEnrollmentURLParams for more details.

Parameters:

  • user_profile_id (String) —

    The ID of the user profile to create an enrollment URL for (uprof_...).

  • betas (Array<Symbol, String, Anthropic::Models::AnthropicBeta>) —

    Optional header to specify the beta version(s) you want to use.

  • workspace_id (String) —

    Optional header to select the Workspace for this request. The value is a Workspa

  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



181
182
183
184
185
186
187
188
189
190
 
# File 'lib/anthropic/resources/beta/user_profiles.rb', line 181

def create_enrollment_url(, params = {})
  parsed, options = Anthropic::Beta::UserProfileCreateEnrollmentURLParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["v1/user_profiles/%1$s/enrollment_url?beta=true", ],
    headers: parsed.transform_keys(betas: "anthropic-beta", workspace_id: "anthropic-workspace-id"),
    model: Anthropic::Beta::BetaUserProfileEnrollmentURL,
    options: {extra_headers: {"anthropic-beta" => "user-profiles-2026-08-18"}, **options}
  )
end

#list(limit: nil, order: nil, order_by: nil, page: nil, betas: nil, workspace_id: nil, request_options: {}) ⇒ Anthropic::Internal::PageCursor<Anthropic::Models::Beta::BetaUserProfile>

List User Profiles

Some parameter documentations has been truncated, see Models::Beta::UserProfileListParams for more details.

Parameters:

  • limit (Integer) —

    Query param: The maximum number of user profiles to return, from 1 to 100. Defau

  • order (Symbol, Anthropic::Models::Beta::UserProfileListParams::Order) —

    Query param: The sort direction, applied to the field that order_by selects. D

  • order_by (Symbol, Anthropic::Models::Beta::UserProfileListParams::OrderBy) —

    Query param: The field to sort user profiles by, in the direction that order s

  • page (String) —

    Query param: The cursor for the page to return, taken from next_page in a prev

  • betas (Array<Symbol, String, Anthropic::Models::AnthropicBeta>) —

    Header param: Optional header to specify the beta version(s) you want to use.

  • workspace_id (String) —

    Header param: Optional header to select the Workspace for this request. The valu

  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/anthropic/resources/beta/user_profiles.rb', line 144

def list(params = {})
  query_params = [:limit, :order, :order_by, :page]
  parsed, options = Anthropic::Beta::UserProfileListParams.dump_request(params)
  query = Anthropic::Internal::Util.encode_query_params(parsed.slice(*query_params))
  @client.request(
    method: :get,
    path: "v1/user_profiles?beta=true",
    query: query,
    headers: parsed.except(*query_params).transform_keys(
      betas: "anthropic-beta",
      workspace_id: "anthropic-workspace-id"
    ),
    page: Anthropic::Internal::PageCursor,
    model: Anthropic::Beta::BetaUserProfile,
    options: {extra_headers: {"anthropic-beta" => "user-profiles-2026-08-18"}, **options}
  )
end

#retrieve(user_profile_id, betas: nil, workspace_id: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaUserProfile

Get User Profile

Some parameter documentations has been truncated, see Models::Beta::UserProfileRetrieveParams for more details.

Parameters:

  • user_profile_id (String) —

    The ID of the user profile to get (uprof_...).

  • betas (Array<Symbol, String, Anthropic::Models::AnthropicBeta>) —

    Optional header to specify the beta version(s) you want to use.

  • workspace_id (String) —

    Optional header to select the Workspace for this request. The value is a Workspa

  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



66
67
68
69
70
71
72
73
74
75
 
# File 'lib/anthropic/resources/beta/user_profiles.rb', line 66

def retrieve(, params = {})
  parsed, options = Anthropic::Beta::UserProfileRetrieveParams.dump_request(params)
  @client.request(
    method: :get,
    path: ["v1/user_profiles/%1$s?beta=true", ],
    headers: parsed.transform_keys(betas: "anthropic-beta", workspace_id: "anthropic-workspace-id"),
    model: Anthropic::Beta::BetaUserProfile,
    options: {extra_headers: {"anthropic-beta" => "user-profiles-2026-08-18"}, **options}
  )
end

#update(user_profile_id, access_type: nil, external_id: nil, external_user_details: nil, external_user_onboarded_at: nil, metadata: nil, name: nil, betas: nil, workspace_id: nil, request_options: {}) ⇒ Anthropic::Models::Beta::BetaUserProfile

Update User Profile

Some parameter documentations has been truncated, see Models::Beta::UserProfileUpdateParams for more details.

Parameters:

  • user_profile_id (String) —

    Path param: The ID of the user profile to update (uprof_...).

  • access_type (Symbol, Anthropic::Models::Beta::UserProfileUpdateParams::AccessType, nil) —

    Body param: How the platform uses the API on behalf of the entity this profile r

  • external_id (String, nil) —

    Body param: If present, replaces the stored external_id. Omit to leave unchanged

  • external_user_details (Anthropic::Models::Beta::BetaUserProfileExternalUserDetailsParams) —

    Body param: Details about the entity this profile represents, as the platform st

  • external_user_onboarded_at (Time) —

    Body param: A timestamp in RFC 3339 format

  • metadata (Hash{Symbol=>String}) —

    Body param: Key-value pairs to merge into the stored metadata. Keys provided ove

  • name (String, nil) —

    Body param: If present, replaces the stored name. Omit to leave unchanged. Maxim

  • betas (Array<Symbol, String, Anthropic::Models::AnthropicBeta>) —

    Header param: Optional header to specify the beta version(s) you want to use.

  • workspace_id (String) —

    Header param: Optional header to select the Workspace for this request. The valu

  • request_options (Anthropic::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

See Also:



107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/anthropic/resources/beta/user_profiles.rb', line 107

def update(, params = {})
  parsed, options = Anthropic::Beta::UserProfileUpdateParams.dump_request(params)
  header_params = {betas: "anthropic-beta", workspace_id: "anthropic-workspace-id"}
  @client.request(
    method: :post,
    path: ["v1/user_profiles/%1$s?beta=true", ],
    headers: parsed.slice(*header_params.keys).transform_keys(header_params),
    body: parsed.except(*header_params.keys),
    model: Anthropic::Beta::BetaUserProfile,
    options: {extra_headers: {"anthropic-beta" => "user-profiles-2026-08-18"}, **options}
  )
end