JSDoc: Class: GMEAuth

new GMEAuth(session, gmeConfig) → {Object}

Parameters:

Name	Type	Description
`session`
`gmeConfig`

Source:

server/middleware/auth/gmeauth.js, line 68

Returns:

Type: Object

Methods

(inner) addMongoOpsToPromize()

'_organizations' collection has these fields: _id: username projects: map from project name to object {read:, write:, delete: }

Source:

server/middleware/auth/gmeauth.js, line 109

(inner) addOrganization(orgId, callbackopt) → {*}

Parameters:

Name	Type	Attributes	Description
`orgId`	string
`callback`	function	<optional>

Source:

server/middleware/auth/gmeauth.js, line 1008

Returns:

Type: *

(inner) addUser(userId, email, password, canCreateopt, options, callbackopt) → {*}

Parameters:

Name	Type	Attributes	Default
`userId`	string
`email`	string
`password`	string
`canCreate`	boolean	<optional>	false
`options`	object
`callback`	function	<optional>

Source:

server/middleware/auth/gmeauth.js, line 883

Returns:

Type: *

(inner) addUserToOrganization(userId, orgId, callbackopt) → {*}

Parameters:

Name	Type	Attributes
`userId`	string
`orgId`	string
`callback`	function	<optional>

Source:

server/middleware/auth/gmeauth.js, line 1201

Returns:

Type: *

(inner) connect(callbackopt) → {*}

Parameters:

Name	Type	Attributes	Description
`callback`	function	<optional>

Source:

server/middleware/auth/gmeauth.js, line 273

Returns:

Type: *

(inner) deleteUser(userId, force, callbackopt) → {*}

Parameters:

Name	Type	Attributes	Description
`userId`	string
`force`	boolean		removes the user from the db completely
`callback`	function	<optional>

Source:

server/middleware/auth/gmeauth.js, line 528

Returns:

Type: *

(inner) getOrganization(orgId, queryopt, callbackopt) → {*}

Parameters:

Name	Type	Attributes
`orgId`	string
`query`	object	<optional>
`callback`	function	<optional>

Source:

server/middleware/auth/gmeauth.js, line 1080

Returns:

Type: *

(inner) getUser(userId, queryopt, callbackopt) → {*}

Parameters:

Name	Type	Attributes
`userId`	string
`query`	object	<optional>
`callback`	function	<optional>

Source:

server/middleware/auth/gmeauth.js, line 493

Returns:

Type: *

(inner) listOrganizations(queryopt, callbackopt) → {*}

Parameters:

Name	Type	Attributes	Description
`query`	object	<optional>
`callback`	function	<optional>

Source:

server/middleware/auth/gmeauth.js, line 1124

Returns:

Type: *

(inner) listUsers(queryopt, projectionopt, callbackopt) → {*}

Parameters:

Name	Type	Attributes
`query`	object	<optional>
`projection`	object	<optional>
`callback`	function	<optional>

Source:

server/middleware/auth/gmeauth.js, line 845

Returns:

Type: *

(inner) reEnableUser(userId, callbackopt) → {*}

Parameters:

Name	Type	Attributes	Description
`userId`	string
`callback`	function	<optional>

Source:

server/middleware/auth/gmeauth.js, line 986

Returns:

Type: *

(inner) removeOrganizationByOrgId(orgId, forceopt, callbackopt) → {*}

Parameters:

Name	Type	Attributes	Default	Description
`orgId`	string
`force`	boolean	<optional>	false	delete organization from db.
`callback`	function	<optional>

Source:

server/middleware/auth/gmeauth.js, line 1165

Returns:

Type: *

(inner) removeUserFromOrganization(userId, orgId, callbackopt) → {*}

Parameters:

Name	Type	Attributes
`userId`
`orgId`
`callback`	function	<optional>

Source:

server/middleware/auth/gmeauth.js, line 1232

Returns:

Type: *

(inner) setAdminForUserInOrganization(userId, orgId, makeAdmin, callbackopt) → {*}

Parameters:

Name	Type	Attributes
`userId`	string
`orgId`	string
`makeAdmin`	boolean
`callback`	function	<optional>

Source:

server/middleware/auth/gmeauth.js, line 1256

Returns:

Type: *

(inner) unload(callbackopt) → {*}

Parameters:

Name	Type	Attributes	Description
`callback`	function	<optional>

Source:

server/middleware/auth/gmeauth.js, line 329

Returns:

Type: *

(inner) updateOrganizationInfo(orgId, info, callbackopt) → {*}

Parameters:

Name	Type	Attributes
`orgId`	string
`info`	object
`callback`	function	<optional>

Source:

server/middleware/auth/gmeauth.js, line 1053

Returns:

Type: *

(inner) updateUser(userId, userData, callbackopt) → {*}

Updates/overwrites provided fields for the userData.

Parameters:

Name	Type	Attributes
`userId`	string
`userData`	object
`callback`	function	<optional>

Source:

server/middleware/auth/gmeauth.js, line 565

Returns:

Type: *

(inner) updateUserComponentSettings(userId, componentId, settings, overwriteopt, callbackopt) → {*}

Updates the provided fields in the settings stored at given componentId.

Parameters:

Name	Type	Attributes	Description
`userId`	string
`componentId`	string
`settings`	object
`overwrite`	boolean	<optional>	if true the settings for the key will be overwritten.
`callback`	function	<optional>

Source:

server/middleware/auth/gmeauth.js, line 808

Returns:

Type: *

(inner) updateUserDataField(userId, data, overwriteopt, callbackopt) → {*}

Updates the provided fields in data (recursively) within userData.data.

Parameters:

Name	Type	Attributes	Description
`userId`	string
`data`	object
`overwrite`	boolean	<optional>	if true the settings for the key will be overwritten.
`callback`	function	<optional>

Source:

server/middleware/auth/gmeauth.js, line 749

Returns:

Type: *

(inner) updateUserSettings(userId, settings, overwriteopt, callbackopt) → {*}

Updates the provided fields in the settings.

Parameters:

Name	Type	Attributes	Description
`userId`	string
`settings`	object
`overwrite`	boolean	<optional>	if true the settings for the key will be overwritten.
`callback`	function	<optional>

Source:

server/middleware/auth/gmeauth.js, line 827

Returns:

Type: *