MDAA TS Docs
    Preparing search index...

    Interface AuthProps

    Authentication configuration for GAIA GenAI platform user access. Supports email/password, Active Directory, or existing Cognito User Pool integration.

    Use cases: Email/password authentication; AD enterprise SSO; Existing Cognito pool integration; Branded auth domains

    AWS: Amazon Cognito User Pools with optional AD identity provider

    Validation: Required; authType must be a valid SupportedAuthTypes value

    interface AuthProps {
        authType: SupportedAuthTypes;
        cognitoDomain?: string;
        existingPoolClientId?: string;
        existingPoolDomain?: string;
        existingPoolId?: string;
        idpSamlEmailClaimParamPath?: string;
        idpSamlMetadataUrlOrFileParamPath?: string;
        oAuthRedirectUrl?: string;
    }
    Index

    Properties

    authType cognitoDomain? existingPoolClientId? existingPoolDomain? existingPoolId? idpSamlEmailClaimParamPath? idpSamlMetadataUrlOrFileParamPath? oAuthRedirectUrl?

    Properties

    authType: SupportedAuthTypes

    Authentication method for the GAIA platform. Determines identity provider: email/password (Cognito-managed), Active Directory (SAML), or existing Cognito pool.

    Use cases: Email/password signup; AD enterprise SSO; Reusing existing Cognito infrastructure

    AWS: Amazon Cognito User Pool authentication mode

    Validation: Required; Must be 'email_pass', 'ad', or 'existing' (SupportedAuthTypes enum)

    cognitoDomain?: string

    Custom Cognito User Pool domain for branded authentication URLs. Must be globally unique. Required when authType is 'ad'.

    Use cases: Branded sign-in experience; Custom authentication URLs; AD integration domain

    AWS: Amazon Cognito User Pool domain

    Validation: Optional; Must be globally unique domain name

    existingPoolClientId?: string

    Existing Cognito User Pool app client ID for integrating GAIA with a pre-existing app client. Used when authType is 'existing'.

    Use cases: Existing app client reuse; Shared client configuration; Multi-app authentication

    AWS: Amazon Cognito User Pool App Client ID

    Validation: Optional; Must be valid Cognito app client ID format

    existingPoolDomain?: string
    existingPoolId?: string

    Existing Cognito User Pool ID for integrating GAIA with a pre-existing user pool. Required when authType is 'existing'.

    Use cases: Existing user pool integration; Shared authentication infrastructure; Multi-app Cognito reuse

    AWS: Amazon Cognito User Pool ID

    Validation: Optional; Required when authType is 'existing'; Must be valid User Pool ID format

    idpSamlEmailClaimParamPath?: string
    idpSamlMetadataUrlOrFileParamPath?: string
    oAuthRedirectUrl?: string

    Settings

    Member Visibility

    On This Page

    Properties