Interface CreateNewUserOptions

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

Hierarchy (view full)

Properties

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

Properties

Optional containerPath

containerPath?: string

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

email

email: string

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

Optional failure

failure?: RequestFailure<any>

This will be called upon failure to complete a request.

Optional optionalMessage

optionalMessage?: string

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

Optional scope

scope?: any

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

Optional sendEmail

sendEmail?: boolean

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

Optional success

success?: RequestSuccess<CreateNewUserResponse>

This will be called upon successfully completing a request.

Settings

Member Visibility

Theme

On This Page

containerPathemailfailureoptionalMessagescopesendEmailsuccess

Generated using TypeDoc