Class: Anthropic::Models::Beta::BetaUserProfile

Inherits:
Internal::Type::BaseModel show all
Defined in:
lib/anthropic/models/beta/beta_user_profile.rb,
sig/anthropic/models/beta/beta_user_profile.rbs

Overview

See Also:

  • Anthropic::Resources::Beta::UserProfiles#create

Defined Under Namespace

Modules: AccessType, Type

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(id:, created_at:, metadata:, trust_grants:, type:, updated_at:, access_type: nil, external_id: nil, external_user_details: nil, external_user_onboarded_at: nil, name: nil) ⇒ Object

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

Parameters:

  • id (String) —

    Unique identifier for this user profile, prefixed uprof_.

  • created_at (Time) —

    A timestamp in RFC 3339 format

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

    Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up t

  • trust_grants (Hash{Symbol=>Anthropic::Models::Beta::BetaUserProfileTrustGrant}) —

    Trust grants for this profile, keyed by grant name. Key omitted when no grant is

  • type (Symbol, Anthropic::Models::Beta::BetaUserProfile::Type) —

    Object type. Always user_profile.

  • updated_at (Time) —

    A timestamp in RFC 3339 format

  • access_type (Symbol, Anthropic::Models::Beta::BetaUserProfile::AccessType) (defaults to: nil) —

    How the platform uses the API on behalf of the entity this profile represents. `

  • external_id (String, nil) (defaults to: nil) —

    Platform's own identifier for this user. Not enforced unique. Present under the

  • external_user_details (Anthropic::Models::Beta::BetaUserProfileExternalUserDetails) (defaults to: nil) —

    Details about the entity this profile represents, as the platform states them. A

  • external_user_onboarded_at (Time, nil) (defaults to: nil) —

    A timestamp in RFC 3339 format

  • name (String, nil) (defaults to: nil) —

    Real-world name of the entity this profile represents (company or individual). F




# File 'lib/anthropic/models/beta/beta_user_profile.rb', line 87

Instance Attribute Details

#access_type ⇒ Symbol, ...

How the platform uses the API on behalf of the entity this profile represents. application: the platform sells a product that uses the API behind the scenes, and the profile represents an individual end-user of that product. passthrough: the platform resells raw inference, and the profile identifies the resold-to company.

Returns:



55
 
# File 'lib/anthropic/models/beta/beta_user_profile.rb', line 55

optional :access_type, enum: -> { Anthropic::Beta::BetaUserProfile::AccessType }

#created_at ⇒ Time

A timestamp in RFC 3339 format

Parameters:

  • value (Time)

Returns:

  • (Time) 


18
 
# File 'lib/anthropic/models/beta/beta_user_profile.rb', line 18

required :created_at, Time

#external_id ⇒ String?

Platform's own identifier for this user. Not enforced unique. Present under the user-profiles-2026-03-24 and user-profiles-2026-08-18 beta headers; under user-profiles-2026-09-04 the value is external_user_details.reference_id.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


63
 
# File 'lib/anthropic/models/beta/beta_user_profile.rb', line 63

optional :external_id, String, nil?: true

#external_user_details ⇒ Anthropic::Models::Beta::BetaUserProfileExternalUserDetails?

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.

Returns:



71
 
# File 'lib/anthropic/models/beta/beta_user_profile.rb', line 71

optional :external_user_details, -> { Anthropic::Beta::BetaUserProfileExternalUserDetails }

#external_user_onboarded_at ⇒ Time?

A timestamp in RFC 3339 format

Parameters:

  • value (Time, nil)

Returns:

  • (Time, nil) 


77
 
# File 'lib/anthropic/models/beta/beta_user_profile.rb', line 77

optional :external_user_onboarded_at, Time, nil?: true

#id ⇒ String

Unique identifier for this user profile, prefixed uprof_.

Parameters:

  • value (String)

Returns:

  • (String) 


12
 
# File 'lib/anthropic/models/beta/beta_user_profile.rb', line 12

required :id, String

#metadata ⇒ Hash{Symbol=>String}

Arbitrary key-value metadata. Maximum 16 pairs, keys up to 64 chars, values up to 512 chars.

Parameters:

  • value (::Hash[Symbol, String])

Returns:

  • (Hash{Symbol=>String}) 


25
 
# File 'lib/anthropic/models/beta/beta_user_profile.rb', line 25

required :metadata, Anthropic::Internal::Type::HashOf[String]

#name ⇒ String?

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.

Parameters:

  • value (String, nil)

Returns:

  • (String, nil) 


85
 
# File 'lib/anthropic/models/beta/beta_user_profile.rb', line 85

optional :name, String, nil?: true

#trust_grants ⇒ Hash{Symbol=>Anthropic::Models::Beta::BetaUserProfileTrustGrant}

Trust grants for this profile, keyed by grant name. Key omitted when no grant is active or in flight.

Parameters:

  • value (::Hash[Symbol, Anthropic::Beta::BetaUserProfileTrustGrant])

Returns:



32
33
 
# File 'lib/anthropic/models/beta/beta_user_profile.rb', line 32

required :trust_grants,
-> { Anthropic::Internal::Type::HashOf[Anthropic::Beta::BetaUserProfileTrustGrant] }

#type ⇒ Symbol, Anthropic::Models::Beta::BetaUserProfile::Type

Object type. Always user_profile.

Parameters:

  • value (Anthropic::Models::Beta::BetaUserProfile::type_)

Returns:



39
 
# File 'lib/anthropic/models/beta/beta_user_profile.rb', line 39

required :type, enum: -> { Anthropic::Beta::BetaUserProfile::Type }

#updated_at ⇒ Time

A timestamp in RFC 3339 format

Parameters:

  • value (Time)

Returns:

  • (Time) 


45
 
# File 'lib/anthropic/models/beta/beta_user_profile.rb', line 45

required :updated_at, Time

Class Method Details

.values ⇒ Array<Symbol>

Returns:

  • (Array<Symbol>) 



# File 'lib/anthropic/models/beta/beta_user_profile.rb', line 121

Instance Method Details

#to_hash ⇒ {

Returns:

  • ({) 


66
 
# File 'sig/anthropic/models/beta/beta_user_profile.rbs', line 66

def to_hash: -> {