Skip to main content

​
Definition

Assembly: Mintlify.Core.dll Namespace: Mintlify.Core.Models Inheritance: System.Object

​
Syntax

Mintlify.Core.Models.MdxAuthConfig

​
Summary

Represents the authentication configuration for MDX-based API documentation.

​
Remarks

Specifies how API requests should be authenticated when using the interactive playground in MDX-generated API documentation pages.

​
Constructors

​
.ctor

​
Syntax

public MdxAuthConfig()

​
.ctor Inherited

Inherited from object

​
Syntax

public Object()

​
Properties

​
Method

Gets or sets the authentication method.

​
Syntax

public string Method { get; set; }

​
Property Value

Type: string?

​
Examples

"auth": {
  "method": "bearer"
}

​
Remarks

Valid values are: “bearer”, “basic”, “key”, “cobo”.
  • bearer: Bearer token authentication (Authorization: Bearer TOKEN)
  • basic: Basic authentication (Authorization: Basic BASE64)
  • key: API key authentication (custom header)
  • cobo: Cobo-specific authentication

​
Name

Gets or sets the name of the authentication header or parameter.

​
Syntax

public string Name { get; set; }

​
Property Value

Type: string?

​
Examples

"auth": {
  "method": "key",
  "name": "x-api-key"
}

​
Remarks

For “key” authentication method, this specifies the header name (e.g., “x-api-key”). For other methods, this may specify additional configuration parameters.

​
Methods

​
Equals Inherited Virtual

Inherited from object

​
Syntax

public virtual bool Equals(object obj)

​
Parameters

NameTypeDescription
objobject?-

​
Returns

Type: bool

​
Equals Inherited

Inherited from object

​
Syntax

public static bool Equals(object objA, object objB)

​
Parameters

NameTypeDescription
objAobject?-
objBobject?-

​
Returns

Type: bool

​
GetHashCode Inherited Virtual

Inherited from object

​
Syntax

public virtual int GetHashCode()

​
Returns

Type: int

​
GetType Inherited

Inherited from object

​
Syntax

public System.Type GetType()

​
Returns

Type: System.Type

​
MemberwiseClone Inherited

Inherited from object

​
Syntax

protected internal object MemberwiseClone()

​
Returns

Type: object

​
ReferenceEquals Inherited

Inherited from object

​
Syntax

public static bool ReferenceEquals(object objA, object objB)

​
Parameters

NameTypeDescription
objAobject?-
objBobject?-

​
Returns

Type: bool

​
ToString Inherited Virtual

Inherited from object

​
Syntax

public virtual string ToString()

​
Returns

Type: string?