Enum CodexAuth 

pub enum CodexAuth {
    ApiKey(ApiKeyAuth),
    Chatgpt(ChatgptAuth),
    ChatgptAuthTokens(ChatgptAuthTokens),
    Headers(AuthHeaders),
    AgentIdentity(AgentIdentityAuth),
    PersonalAccessToken(PersonalAccessTokenAuth),
    BedrockApiKey(BedrockApiKeyAuth),
}

Authentication mechanism used by the current user.

Variants

ApiKey(ApiKeyAuth)

Chatgpt(ChatgptAuth)

ChatgptAuthTokens(ChatgptAuthTokens)

Headers(AuthHeaders)

AgentIdentity(AgentIdentityAuth)

PersonalAccessToken(PersonalAccessTokenAuth)

BedrockApiKey(BedrockApiKeyAuth)

Implementations

impl CodexAuth

pub async fn from_auth_storage( codex_home: &Path, auth_credentials_store_mode: AuthCredentialsStoreMode, chatgpt_base_url: Option<&str>, keyring_backend_kind: AuthKeyringBackendKind, auth_route_config: Option<&AuthRouteConfig>, ) -> Result<Option<Self>>

pub async fn from_agent_identity_jwt( jwt: &str, chatgpt_base_url: Option<&str>, auth_route_config: Option<&AuthRouteConfig>, ) -> Result<Self>

pub async fn from_personal_access_token( access_token: &str, auth_route_config: Option<&AuthRouteConfig>, ) -> Result<Self>

pub fn auth_mode(&self) -> AuthMode

Returns the effective backend auth mode.

Externally managed ChatGPT tokens are normalized to AuthMode::Chatgpt.

pub fn api_auth_mode(&self) -> AuthMode

Returns the precise kind of credentials backing this authentication.

pub fn is_api_key_auth(&self) -> bool

pub fn is_personal_access_token_auth(&self) -> bool

pub fn is_chatgpt_auth(&self) -> bool

pub fn uses_codex_backend(&self) -> bool

pub fn is_external_chatgpt_tokens(&self) -> bool

pub fn api_key(&self) -> Option<&str>

Returns None if auth_mode() != AuthMode::ApiKey.

pub fn get_token_data(&self) -> Result<TokenData, Error>

Returns Err if token-backed ChatGPT auth is unavailable.

pub fn get_token(&self) -> Result<String, Error>

Returns the token string used for bearer authentication.

pub fn get_account_id(&self) -> Option<String>

Returns None if Codex backend auth does not expose an account id.

pub fn is_fedramp_account(&self) -> bool

Returns false if Codex backend auth omits the FedRAMP claim.

pub fn get_account_email(&self) -> Option<String>

Returns None if Codex backend auth does not expose an account email.

pub fn get_chatgpt_user_id(&self) -> Option<String>

Returns None if Codex backend auth does not expose a ChatGPT user id.

pub fn account_plan_type(&self) -> Option<AccountPlanType>

Account-facing plan classification derived from the current auth. Returns a high-level AccountPlanType (e.g., Free/Plus/Pro/Team/…) for UI or product decisions based on the user’s subscription.

pub fn is_workspace_account(&self) -> bool

pub fn create_dummy_chatgpt_auth_for_testing() -> Self

Consider this private to integration tests.

pub fn from_external_chatgpt_tokens( access_token: &str, chatgpt_account_id: &str, chatgpt_plan_type: Option<&str>, ) -> Result<Self>

Constructs in-memory ChatGPT auth from externally managed tokens.

pub fn from_api_key(api_key: &str) -> Self

Trait Implementations

impl Clone for CodexAuth

fn clone(&self) -> CodexAuth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for CodexAuth

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

Formats the value using the given formatter.

impl PartialEq for CodexAuth

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

Equality operator ==.

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

Inequality operator !=.