Package ai.vectros.resources.auth.requests

Class CreateScopedKeyRequest.Builder

java.lang.Object

ai.vectros.resources.auth.requests.CreateScopedKeyRequest.Builder

All Implemented Interfaces:

CreateScopedKeyRequest._FinalStage, CreateScopedKeyRequest.ContextIdStage, CreateScopedKeyRequest.KeyNameStage, CreateScopedKeyRequest.TenantIdStage, CreateScopedKeyRequest.UserIdStage

Enclosing class:

CreateScopedKeyRequest

public static final class CreateScopedKeyRequest.Builder
extends Object
implements CreateScopedKeyRequest.KeyNameStage, CreateScopedKeyRequest.TenantIdStage, CreateScopedKeyRequest.ContextIdStage, CreateScopedKeyRequest.UserIdStage, CreateScopedKeyRequest._FinalStage

Method Summary

Modifier and Type	Method	Description
CreateScopedKeyRequest.Builder	additionalProperties(Map<String,Object> additionalProperties)
CreateScopedKeyRequest.Builder	additionalProperty(String key, Object value)
CreateScopedKeyRequest	build()
CreateScopedKeyRequest.UserIdStage	contextId(@NotNull String contextId)	The app context within the tenant.
CreateScopedKeyRequest.Builder	from(CreateScopedKeyRequest other)
CreateScopedKeyRequest.TenantIdStage	keyName(@NotNull String keyName)	A human-readable name for the key, used to identify and disambiguate multiple keys for the same user.
CreateScopedKeyRequest._FinalStage	label(String label)	Optional display label surfaced through /v1/ping as principalLabel.
CreateScopedKeyRequest._FinalStage	label(Optional<String> label)	Optional display label surfaced through /v1/ping as principalLabel.
CreateScopedKeyRequest.ContextIdStage	tenantId(@NotNull String tenantId)	The tenant the key will operate on.
CreateScopedKeyRequest._FinalStage	userId(@NotNull String userId)	The user the key binds to.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

from

public CreateScopedKeyRequest.Builder from(CreateScopedKeyRequest other)

Specified by:

from in interface CreateScopedKeyRequest.KeyNameStage

keyName

public CreateScopedKeyRequest.TenantIdStage keyName(@NotNull
 @NotNull String keyName)

A human-readable name for the key, used to identify and disambiguate multiple keys for the same user. Maximum 100 characters.

A human-readable name for the key, used to identify and disambiguate multiple keys for the same user. Maximum 100 characters.

Specified by:

keyName in interface CreateScopedKeyRequest.KeyNameStage

Returns:

Reference to this so that method calls can be chained together.

tenantId

public CreateScopedKeyRequest.ContextIdStage tenantId(@NotNull
 @NotNull String tenantId)

The tenant the key will operate on. Must be your live tenant ID or your test tenant ID; an ID outside your account returns a uniform 404 not found (no distinction is made between a missing and an out-of-account tenant).

The tenant the key will operate on. Must be your live tenant ID or your test tenant ID; an ID outside your account returns a uniform 404 not found (no distinction is made between a missing and an out-of-account tenant).

Specified by:

tenantId in interface CreateScopedKeyRequest.TenantIdStage

Returns:

Reference to this so that method calls can be chained together.

contextId

public CreateScopedKeyRequest.UserIdStage contextId(@NotNull
 @NotNull String contextId)

The app context within the tenant. Must reference an app context that already exists (create one via POST /v1/app-contexts).

The app context within the tenant. Must reference an app context that already exists (create one via POST /v1/app-contexts).

Specified by:

contextId in interface CreateScopedKeyRequest.ContextIdStage

Returns:

Reference to this so that method calls can be chained together.

userId

public CreateScopedKeyRequest._FinalStage userId(@NotNull
 @NotNull String userId)

The user the key binds to. May be a HUMAN or a SERVICE user (a service user is the typical agent or bot case). An access profile must already exist for this context and user — the key references that profile; it does not create one.

The user the key binds to. May be a HUMAN or a SERVICE user (a service user is the typical agent or bot case). An access profile must already exist for this context and user — the key references that profile; it does not create one.

Specified by:

userId in interface CreateScopedKeyRequest.UserIdStage

Returns:

Reference to this so that method calls can be chained together.

label

public CreateScopedKeyRequest._FinalStage label(String label)

Optional display label surfaced through /v1/ping as principalLabel. The MCP current_identity tool uses it to show "signed in as ..." hints to end users (e.g. "Claude Desktop — clinical-notes RO"). Distinct from keyName, which is your own identifier for the key. Maximum 80 characters; if present, it must not have leading or trailing whitespace.

Specified by:

label in interface CreateScopedKeyRequest._FinalStage

Returns:

Reference to this so that method calls can be chained together.

label

public CreateScopedKeyRequest._FinalStage label(Optional<String> label)

Optional display label surfaced through /v1/ping as principalLabel. The MCP current_identity tool uses it to show "signed in as ..." hints to end users (e.g. "Claude Desktop — clinical-notes RO"). Distinct from keyName, which is your own identifier for the key. Maximum 80 characters; if present, it must not have leading or trailing whitespace.

Specified by:

label in interface CreateScopedKeyRequest._FinalStage

build

public CreateScopedKeyRequest build()

Specified by:

build in interface CreateScopedKeyRequest._FinalStage

additionalProperty

public CreateScopedKeyRequest.Builder additionalProperty(String key,
 Object value)

Specified by:

additionalProperty in interface CreateScopedKeyRequest._FinalStage

additionalProperties

public CreateScopedKeyRequest.Builder additionalProperties(Map<String,Object> additionalProperties)

Specified by:

additionalProperties in interface CreateScopedKeyRequest._FinalStage