Request body for creating a Cognito user.

interface PostCognitoUserBody {
    appMetadata: {
        admin?: string;
        createdBy?: ProductKey;
        ctsAuthorized?: boolean;
        ctsUserId?: string;
        customerId?: string;
        districtId?: string;
        egrantsAuthorized?: boolean;
        egrantsUserId?: string;
        erpAuthorized?: boolean;
        erpNcAuthorized?: boolean;
        erpNcUserId?: string;
        erpTenants?: string;
        erpUserId?: string;
        fdpAuthorized?: boolean;
        fdpStateAgency?: string;
        fdpStateCode?: string;
        isiteAuthorized?: boolean;
        isiteMigration?: boolean;
        mcAuthorized?: boolean;
        mcUserId?: string;
        ooAuthorized?: boolean;
        passwordResetRequired?: boolean;
        role?: string;
        scriptAuthorized?: boolean;
        titanAuthorized?: boolean;
        titanUserId?: string;
    } & { isExternal?: boolean };
    blocked?: boolean;
    email: string;
    firstName: string;
    lastName: string;
    name?: string;
    nickname?: string;
    password?: string;
    picture?: string;
    userMetadata?: { homeroomId?: string; siteId?: string };
    username?: string;
    userPoolId: string;
    [key: string]: any;
}

Hierarchy (View Summary)

Indexable

  • [key: string]: any

Properties

appMetadata: {
    admin?: string;
    createdBy?: ProductKey;
    ctsAuthorized?: boolean;
    ctsUserId?: string;
    customerId?: string;
    districtId?: string;
    egrantsAuthorized?: boolean;
    egrantsUserId?: string;
    erpAuthorized?: boolean;
    erpNcAuthorized?: boolean;
    erpNcUserId?: string;
    erpTenants?: string;
    erpUserId?: string;
    fdpAuthorized?: boolean;
    fdpStateAgency?: string;
    fdpStateCode?: string;
    isiteAuthorized?: boolean;
    isiteMigration?: boolean;
    mcAuthorized?: boolean;
    mcUserId?: string;
    ooAuthorized?: boolean;
    passwordResetRequired?: boolean;
    role?: string;
    scriptAuthorized?: boolean;
    titanAuthorized?: boolean;
    titanUserId?: string;
} & { isExternal?: boolean }
blocked?: boolean
email: string
firstName: string
lastName: string
name?: string
nickname?: string
password?: string
picture?: string
userMetadata?: { homeroomId?: string; siteId?: string }
username?: string
userPoolId: string