Enum AuthMode 

pub enum AuthMode {
    Apikey,
    Chatgpt,
    ChatgptAuthTokens,
    Headers,
    AgentIdentity,
    PersonalAccessToken,
    BedrockApiKey,
}

Authentication mode for OpenAI-backed providers.

JSON schema

{
 "description": "Authentication mode for OpenAI-backed providers.",
 "oneOf": [
   {
     "description": "OpenAI API key provided by the caller and stored by Codex.",
     "type": "string",
     "enum": [
       "apikey"
     ]
   },
   {
     "description": "ChatGPT OAuth managed by Codex (tokens persisted and refreshed by Codex).",
     "type": "string",
     "enum": [
       "chatgpt"
     ]
   },
   {
     "description": "[UNSTABLE] FOR OPENAI INTERNAL USE ONLY - DO NOT USE.\n\nChatGPT auth tokens are supplied by an external host app and are only stored in memory. Token refresh must be handled by the external host app.",
     "type": "string",
     "enum": [
       "chatgptAuthTokens"
     ]
   },
   {
     "description": "Backend auth supplied as request headers.",
     "type": "string",
     "enum": [
       "headers"
     ]
   },
   {
     "description": "Programmatic Codex auth backed by a registered Agent Identity.",
     "type": "string",
     "enum": [
       "agentIdentity"
     ]
   },
   {
     "description": "Programmatic Codex auth backed by a personal access token.",
     "type": "string",
     "enum": [
       "personalAccessToken"
     ]
   },
   {
     "description": "Amazon Bedrock bearer token managed by Codex.",
     "type": "string",
     "enum": [
       "bedrockApiKey"
     ]
   }
 ]
}

Variants

Apikey

OpenAI API key provided by the caller and stored by Codex.

Chatgpt

ChatGPT OAuth managed by Codex (tokens persisted and refreshed by Codex).

ChatgptAuthTokens

[UNSTABLE] FOR OPENAI INTERNAL USE ONLY - DO NOT USE.

ChatGPT auth tokens are supplied by an external host app and are only stored in memory. Token refresh must be handled by the external host app.

Headers

Backend auth supplied as request headers.

AgentIdentity

Programmatic Codex auth backed by a registered Agent Identity.

PersonalAccessToken

Programmatic Codex auth backed by a personal access token.

BedrockApiKey

Amazon Bedrock bearer token managed by Codex.

Trait Implementations

impl Clone for AuthMode

fn clone(&self) -> AuthMode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthMode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthMode

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for AuthMode

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

Formats the value using the given formatter.

impl FromStr for AuthMode

type Err = ConversionError

The associated error which can be returned from parsing.

fn from_str(value: &str) -> Result<Self, ConversionError>

Parses a string s to return a value of this type.

impl Hash for AuthMode

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for AuthMode

fn cmp(&self, other: &AuthMode) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for AuthMode

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for AuthMode

fn partial_cmp(&self, other: &AuthMode) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for AuthMode

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&String> for AuthMode

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &String) -> Result<Self, ConversionError>

Performs the conversion.

impl TryFrom<&str> for AuthMode

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, ConversionError>

Performs the conversion.

impl TryFrom<String> for AuthMode

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, ConversionError>

Performs the conversion.

impl Copy for AuthMode

impl Eq for AuthMode

impl StructuralPartialEq for AuthMode