Struct CodexAuthManager 

pub struct CodexAuthManager { /* private fields */ }

A manager rooted at one Codex home directory.

Implementations

impl CodexAuthManager

pub fn from_env() -> Result<Self, Error>

Create a manager from $CODEX_HOME, or $HOME/.codex when $CODEX_HOME is unset.

The stored path is absolute. The directory is not created by this method.

Errors

Returns an error when neither environment variable can be read or the current directory cannot be determined while absolutizing a relative path.

pub fn new(codex_home: impl AsRef<Path>) -> Result<Self, Error>

Create a manager for codex_home.

The stored path is absolute. The directory is not created by this method.

Errors

Returns an error when the current directory cannot be determined while absolutizing a relative path.

pub fn codex_home(&self) -> &Path

The Codex home directory this manager uses.

pub fn status(&self) -> Result<AuthStatus, Error>

Return the current auth status.

Errors

Returns an error when CAM cannot inspect auth.json or read its symlink target.

pub fn list(&self) -> Result<Vec<Identity>, Error>

List identities from the manager directory.

Broken identity entries are included. Missing manager directories produce an empty list.

Errors

Returns an error when the manager directory or one of its entries cannot be inspected.

pub fn capture( &self, identity: &IdentityName, options: CaptureOptions, ) -> Result<(), Error>

Capture the native auth file into an identity and make it active.

Errors

Returns an error when there is no native auth file, the destination identity already exists without force, the destination is broken, or a filesystem operation fails.

pub fn use_identity( &self, identity: &IdentityName, options: UseOptions, ) -> Result<(), Error>

Make an existing identity active.

Errors

Returns an error when the identity is missing or broken, a native auth file would be discarded without force, the auth state is unknown, or a filesystem operation fails.

pub fn detach(&self, options: DetachOptions) -> Result<(), Error>

Detach Codex from the active managed identity.

Errors

Returns an error when detaching would discard a native auth file or broken managed link without force, the auth state is unknown, or a filesystem operation fails.

Trait Implementations

impl Clone for CodexAuthManager

fn clone(&self) -> CodexAuthManager

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodexAuthManager

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

Formats the value using the given formatter.