Struct AuthAccount 

#[non_exhaustive]
pub struct AuthAccount {
    pub label: String,
    pub active: Option<bool>,
    pub name: Option<String>,
    pub email: Option<String>,
    pub organization: Option<String>,
    pub meta: Option<Meta>,
}

Available on crate feature unstable_protocol_v2 only.

UNSTABLE

This capability is not part of the spec yet, and may be removed or changed at any point.

An account or credential the agent has configured, such as a signed-in user account or an API key.

All fields are display information only. Clients MUST NOT use them as stable account identifiers, and SHOULD NOT log them or send them elsewhere, such as to telemetry.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

label: String

Human-readable name for the account, suitable for display on its own, for example Claude Max, OpenAI API key, or Vertex AI.

active: Option<bool>

Whether the agent currently uses this account by default.

Several accounts MAY be active, for example one per provider.

Optional. Omitted and null are equivalent and mean the agent does not indicate whether this account is in effect.

name: Option<String>

Display name of the user, such as a username or full name.

Optional. Omitted and null are equivalent and mean no name is reported.

email: Option<String>

Email address of the user.

Optional. Omitted and null are equivalent and mean no email is reported.

organization: Option<String>

Display name of the organization, team, or workspace the account is using.

Optional. Omitted and null are equivalent and mean no organization is reported.

meta: Option<Meta>

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Omitted and null are equivalent and mean no metadata. Implementations MUST NOT assign meaning to keys they do not recognize.

See protocol docs: Extensibility

Implementations

impl AuthAccount

pub fn new(label: impl Into<String>) -> Self

Available on crate feature unstable_auth_status only.

Builds AuthAccount with the required fields set. Optional fields start unset or empty.

pub fn active(self, active: impl IntoOption<bool>) -> Self

Available on crate feature unstable_auth_status only.

Whether the agent currently uses this account by default.

pub fn name(self, name: impl IntoOption<String>) -> Self

Available on crate feature unstable_auth_status only.

Display name of the user, such as a username or full name.

pub fn email(self, email: impl IntoOption<String>) -> Self

Available on crate feature unstable_auth_status only.

Email address of the user.

pub fn organization(self, organization: impl IntoOption<String>) -> Self

Available on crate feature unstable_auth_status only.

Display name of the organization, team, or workspace the account is using.

pub fn meta(self, meta: impl IntoOption<Meta>) -> Self

Available on crate feature unstable_auth_status only.

The _meta property is reserved by ACP to allow clients and agents to attach additional metadata to their interactions. Implementations MUST NOT assign meaning to keys they do not recognize.

See protocol docs: Extensibility

Trait Implementations

impl Clone for AuthAccount

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for AuthAccount

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthAccount

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for AuthAccount

impl JsonSchema for AuthAccount

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for AuthAccount

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for AuthAccount

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for AuthAccount