Interface AuthMechanismProperties

interface AuthMechanismProperties {
    ALLOWED_HOSTS?: string[];
    AWS_CREDENTIAL_PROVIDER?: AWSCredentialProvider;
    AWS_SESSION_TOKEN?: string;
    CANONICALIZE_HOST_NAME?: GSSAPICanonicalizationValue;
    ENVIRONMENT?:
        | "azure"
        | "gcp"
        | "test"
        | "k8s";
    OIDC_CALLBACK?: OIDCCallbackFunction;
    OIDC_HUMAN_CALLBACK?: OIDCCallbackFunction;
    SERVICE_HOST?: string;
    SERVICE_NAME?: string;
    SERVICE_REALM?: string;
    TOKEN_RESOURCE?: string;
}

Hierarchy (view full)

Properties

ALLOWED_HOSTS?: string[]

Allowed hosts that OIDC auth can connect to.

AWS_CREDENTIAL_PROVIDER?: AWSCredentialProvider

A custom AWS credential provider to use. An example using the AWS SDK default provider chain:

const client = new MongoClient(process.env.MONGODB_URI, {
authMechanismProperties: {
AWS_CREDENTIAL_PROVIDER: fromNodeProviderChain()
}
});

Using a custom function that returns AWS credentials:

const client = new MongoClient(process.env.MONGODB_URI, {
authMechanismProperties: {
AWS_CREDENTIAL_PROVIDER: async () => {
return {
accessKeyId: process.env.ACCESS_KEY_ID,
secretAccessKey: process.env.SECRET_ACCESS_KEY
}
}
}
});
AWS_SESSION_TOKEN?: string
CANONICALIZE_HOST_NAME?: GSSAPICanonicalizationValue
ENVIRONMENT?:
    | "azure"
    | "gcp"
    | "test"
    | "k8s"

The OIDC environment. Note that 'test' is for internal use only.

OIDC_CALLBACK?: OIDCCallbackFunction

A user provided OIDC machine callback function.

OIDC_HUMAN_CALLBACK?: OIDCCallbackFunction

A user provided OIDC human interacted callback function.

SERVICE_HOST?: string
SERVICE_NAME?: string
SERVICE_REALM?: string
TOKEN_RESOURCE?: string

The resource token for OIDC auth in Azure and GCP.

""