Class UserProfileCreateParams.Body
-
- All Implemented Interfaces:
public final class UserProfileCreateParams.Body
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classUserProfileCreateParams.Body.BuilderA builder for Body.
-
Method Summary
Modifier and Type Method Description final Optional<String>externalId()Platform's own identifier for this user. final Optional<UserProfileCreateParams.Metadata>metadata()Free-form key-value data to attach to this user profile. final Optional<String>name()Display name of the entity this profile represents. final Optional<UserProfileCreateParams.Relationship>relationship()How the entity behind a user profile relates to the platform that owns the API key. final JsonField<String>_externalId()Returns the raw JSON value of externalId. final JsonField<UserProfileCreateParams.Metadata>_metadata()Returns the raw JSON value of metadata. final JsonField<String>_name()Returns the raw JSON value of name. final JsonField<UserProfileCreateParams.Relationship>_relationship()Returns the raw JSON value of relationship. final Map<String, JsonValue>_additionalProperties()final UserProfileCreateParams.Body.BuildertoBuilder()final UserProfileCreateParams.Bodyvalidate()Validates that the types of all values in this object match their expected types recursively. final BooleanisValid()Booleanequals(Object other)IntegerhashCode()StringtoString()final static UserProfileCreateParams.Body.Builderbuilder()Returns a mutable builder for constructing an instance of Body. -
-
Method Detail
-
externalId
final Optional<String> externalId()
Platform's own identifier for this user. Not enforced unique. Maximum 255 characters.
-
metadata
final Optional<UserProfileCreateParams.Metadata> metadata()
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
final Optional<String> name()
Display name of the entity this profile represents. Required when relationship is
resold(the resold-to company's name); optional otherwise. Maximum 255 characters.
-
relationship
final Optional<UserProfileCreateParams.Relationship> relationship()
How the entity behind a user profile relates to the platform that owns the API key.
external: an individual end-user of the platform.resold: a company the platform resells Claude access to.internal: the platform's own usage.
-
_externalId
final JsonField<String> _externalId()
Returns the raw JSON value of externalId.
Unlike externalId, this method doesn't throw if the JSON field has an unexpected type.
-
_metadata
final JsonField<UserProfileCreateParams.Metadata> _metadata()
Returns the raw JSON value of metadata.
Unlike metadata, this method doesn't throw if the JSON field has an unexpected type.
-
_name
final JsonField<String> _name()
Returns the raw JSON value of name.
Unlike name, this method doesn't throw if the JSON field has an unexpected type.
-
_relationship
final JsonField<UserProfileCreateParams.Relationship> _relationship()
Returns the raw JSON value of relationship.
Unlike relationship, this method doesn't throw if the JSON field has an unexpected type.
-
_additionalProperties
final Map<String, JsonValue> _additionalProperties()
-
toBuilder
final UserProfileCreateParams.Body.Builder toBuilder()
-
validate
final UserProfileCreateParams.Body validate()
Validates that the types of all values in this object match their expected types recursively.
This method is not forwards compatible with new types from the API for existing fields.
-
builder
final static UserProfileCreateParams.Body.Builder builder()
Returns a mutable builder for constructing an instance of Body.
-
-
-
-