Class UserProfileCreateParams
-
- All Implemented Interfaces:
-
com.anthropic.core.Params
public final class UserProfileCreateParams implements Params
Create User Profile
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description public final classUserProfileCreateParams.BuilderA builder for UserProfileCreateParams.
public final classUserProfileCreateParams.Bodypublic final classUserProfileCreateParams.MetadataFree-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.
public final classUserProfileCreateParams.RelationshipHow 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.
-
Method Summary
Modifier and Type Method Description final Optional<List<AnthropicBeta>>betas()Optional header to specify the beta version(s) you want to use. 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>_additionalBodyProperties()final Headers_additionalHeaders()Additional headers to send with the request. final QueryParams_additionalQueryParams()Additional query param to send with the request. final UserProfileCreateParams.BuildertoBuilder()final UserProfileCreateParams.Body_body()Headers_headers()The full set of headers in the parameters, including both fixed and additional headers. QueryParams_queryParams()The full set of query params in the parameters, including both fixed and additional query params. Booleanequals(Object other)IntegerhashCode()StringtoString()final static UserProfileCreateParamsnone()final static UserProfileCreateParams.Builderbuilder()Returns a mutable builder for constructing an instance of UserProfileCreateParams. -
-
Method Detail
-
betas
final Optional<List<AnthropicBeta>> betas()
Optional header to specify the beta version(s) you want to use.
-
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.
-
_additionalBodyProperties
final Map<String, JsonValue> _additionalBodyProperties()
-
_additionalHeaders
final Headers _additionalHeaders()
Additional headers to send with the request.
-
_additionalQueryParams
final QueryParams _additionalQueryParams()
Additional query param to send with the request.
-
toBuilder
final UserProfileCreateParams.Builder toBuilder()
-
_body
final UserProfileCreateParams.Body _body()
-
_headers
Headers _headers()
The full set of headers in the parameters, including both fixed and additional headers.
-
_queryParams
QueryParams _queryParams()
The full set of query params in the parameters, including both fixed and additional query params.
-
none
final static UserProfileCreateParams none()
-
builder
final static UserProfileCreateParams.Builder builder()
Returns a mutable builder for constructing an instance of UserProfileCreateParams.
-
-
-
-