Package ai.vectros.resources.auth.requests

Class CreateScopedKeyRequest

java.lang.Object
ai.vectros.resources.auth.requests.CreateScopedKeyRequest
public final class CreateScopedKeyRequest extends Object

  • Method Details

    • getKeyName

      public String getKeyName()
      Returns:
      A human-readable name for the key, used to identify and disambiguate multiple keys for the same user. Maximum 100 characters.

    • getTenantId

      public String getTenantId()
      Returns:
      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).

    • getContextId

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

    • getUserId

      public String getUserId()
      Returns:
      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. Naming your own principal needs nothing further; naming any OTHER principal additionally requires the delegate-mint capability on your credential, or a root API key.

    • getLabel

      public Optional<String> getLabel()
      Returns:
      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.

    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object

    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • builder

      public static CreateScopedKeyRequest.KeyNameStage builder()