@labkey/api
    Preparing search index...

    Interface CreateNewUserOptions

    interface CreateNewUserOptions {
        containerPath?: string;
        email: string;
        failure?: RequestFailure<any>;
        optionalMessage?: string;
        scope?: any;
        sendEmail?: boolean;
        success?: RequestSuccess<CreateNewUserResponse>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    containerPath? email failure? optionalMessage? scope? sendEmail? success?

    Properties

    containerPath?: string

    An alternate container path to get permissions from. If not specified, the current container path will be used.

    email: string

    The new user's email address, or a semicolon separated list of email addresses.

    failure?: RequestFailure<any>

    This will be called upon failure to complete a request.

    optionalMessage?: string

    An optional message to include in the new user registration email.

    scope?: any

    A scoping object for the success and failure callback functions (default to this).

    sendEmail?: boolean

    Set to false to stop the server from sending a welcome email to the user.

    success?: RequestSuccess<CreateNewUserResponse>

    This will be called upon successfully completing a request.

    Settings

    Member Visibility

    On This Page

    Properties