KodingApi.JAccountApi

All URIs are relative to https://koding.com/remote.api

Method	HTTP request	Description
acceptInvitation	POST /JAccount.acceptInvitation/{id}
blockUser	POST /JAccount.blockUser/{id}
byRelevance	POST /JAccount.byRelevance
cancelRequest	POST /JAccount.cancelRequest/{id}
checkGroupMembership	POST /JAccount.checkGroupMembership/{id}
count	POST /JAccount.count
destroy	POST /JAccount.destroy/{id}
expireSubscription	POST /JAccount.expireSubscription/{id}
fetchAppStorage	POST /JAccount.fetchAppStorage/{id}
fetchBlockedUsers	POST /JAccount.fetchBlockedUsers
fetchEmail	POST /JAccount.fetchEmail/{id}
fetchEmailAndStatus	POST /JAccount.fetchEmailAndStatus/{id}
fetchEmailFrequency	POST /JAccount.fetchEmailFrequency/{id}
fetchEmailsByUsername	POST /JAccount.fetchEmailsByUsername
fetchFromUser	POST /JAccount.fetchFromUser/{id}
fetchGroups	POST /JAccount.fetchGroups/{id}
fetchKites	POST /JAccount.fetchKites/{id}
fetchMyPermissions	POST /JAccount.fetchMyPermissions/{id}
fetchMyPermissionsAndRoles	POST /JAccount.fetchMyPermissionsAndRoles/{id}
fetchMySessions	POST /JAccount.fetchMySessions/{id}
fetchOAuthInfo	POST /JAccount.fetchOAuthInfo/{id}
fetchOtaToken	POST /JAccount.fetchOtaToken/{id}
fetchPaymentMethods	POST /JAccount.fetchPaymentMethods/{id}
fetchRelativeGroups	POST /JAccount.fetchRelativeGroups/{id}
fetchRole	POST /JAccount.fetchRole/{id}
generate2FactorAuthKey	POST /JAccount.generate2FactorAuthKey/{id}
ignoreInvitation	POST /JAccount.ignoreInvitation/{id}
isEmailVerified	POST /JAccount.isEmailVerified/{id}
isFollowing	POST /JAccount.isFollowing/{id}
markUserAsExempt	POST /JAccount.markUserAsExempt/{id}
modify	POST /JAccount.modify/{id}
one	POST /JAccount.one
pushNotification	POST /JAccount.pushNotification/{id}
setEmailPreferences	POST /JAccount.setEmailPreferences/{id}
setup2FactorAuth	POST /JAccount.setup2FactorAuth/{id}
some	POST /JAccount.some
someWithRelationship	POST /JAccount.someWithRelationship
unblockUser	POST /JAccount.unblockUser/{id}
unlinkOauth	POST /JAccount.unlinkOauth/{id}
updateFlags	POST /JAccount.updateFlags/{id}
verifyEmailByUsername	POST /JAccount.verifyEmailByUsername

acceptInvitation

DefaultResponse acceptInvitation(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.acceptInvitation(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

blockUser

DefaultResponse blockUser(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.blockUser(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

byRelevance

DefaultResponse byRelevance(body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.byRelevance(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

cancelRequest

DefaultResponse cancelRequest(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.cancelRequest(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

checkGroupMembership

DefaultResponse checkGroupMembership(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.checkGroupMembership(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

count

DefaultResponse count(body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.count(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

destroy

DefaultResponse destroy(id, body)

Method JAccount.destroy

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.destroy(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

expireSubscription

DefaultResponse expireSubscription(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.expireSubscription(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

fetchAppStorage

DefaultResponse fetchAppStorage(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.fetchAppStorage(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

fetchBlockedUsers

DefaultResponse fetchBlockedUsers(body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.fetchBlockedUsers(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

fetchEmail

DefaultResponse fetchEmail(id, body)

Method JAccount.fetchEmail

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.fetchEmail(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

fetchEmailAndStatus

DefaultResponse fetchEmailAndStatus(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.fetchEmailAndStatus(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

fetchEmailFrequency

DefaultResponse fetchEmailFrequency(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.fetchEmailFrequency(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

fetchEmailsByUsername

DefaultResponse fetchEmailsByUsername(body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.fetchEmailsByUsername(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

fetchFromUser

DefaultResponse fetchFromUser(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.fetchFromUser(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

fetchGroups

DefaultResponse fetchGroups(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.fetchGroups(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

fetchKites

DefaultResponse fetchKites(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.fetchKites(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

fetchMyPermissions

DefaultResponse fetchMyPermissions(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.fetchMyPermissions(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

fetchMyPermissionsAndRoles

DefaultResponse fetchMyPermissionsAndRoles(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.fetchMyPermissionsAndRoles(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

fetchMySessions

DefaultResponse fetchMySessions(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.fetchMySessions(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

fetchOAuthInfo

DefaultResponse fetchOAuthInfo(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.fetchOAuthInfo(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

fetchOtaToken

DefaultResponse fetchOtaToken(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.fetchOtaToken(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

fetchPaymentMethods

DefaultResponse fetchPaymentMethods(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.fetchPaymentMethods(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

fetchRelativeGroups

DefaultResponse fetchRelativeGroups(id, body)

Method JAccount.fetchRelativeGroups

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.fetchRelativeGroups(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

fetchRole

DefaultResponse fetchRole(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.fetchRole(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

generate2FactorAuthKey

DefaultResponse generate2FactorAuthKey(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.generate2FactorAuthKey(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

ignoreInvitation

DefaultResponse ignoreInvitation(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.ignoreInvitation(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

isEmailVerified

DefaultResponse isEmailVerified(id, body)

Method JAccount.isEmailVerified

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.isEmailVerified(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

isFollowing

DefaultResponse isFollowing(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.isFollowing(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

markUserAsExempt

DefaultResponse markUserAsExempt(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.markUserAsExempt(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

modify

DefaultResponse modify(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.modify(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

one

DefaultResponse one(body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.one(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

pushNotification

DefaultResponse pushNotification(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.pushNotification(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

setEmailPreferences

DefaultResponse setEmailPreferences(id, body)

Method JAccount.setEmailPreferences

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.setEmailPreferences(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

setup2FactorAuth

DefaultResponse setup2FactorAuth(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.setup2FactorAuth(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

some

DefaultResponse some(body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.some(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

someWithRelationship

DefaultResponse someWithRelationship(body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.someWithRelationship(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

unblockUser

DefaultResponse unblockUser(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.unblockUser(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

unlinkOauth

DefaultResponse unlinkOauth(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.unlinkOauth(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

updateFlags

DefaultResponse updateFlags(id, body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var id = "id_example"; // String | Mongo ID of target instance

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.updateFlags(id, body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
id	String	Mongo ID of target instance
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

verifyEmailByUsername

DefaultResponse verifyEmailByUsername(body)

Example

var KodingApi = require('koding-api');
var defaultClient = KodingApi.ApiClient.default;

// Configure API key authorization: Bearer
var Bearer = defaultClient.authentications['Bearer'];
Bearer.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//Bearer.apiKeyPrefix = 'Token';

var apiInstance = new KodingApi.JAccountApi();

var body = new KodingApi.DefaultSelector(); // DefaultSelector | body of the request

apiInstance.verifyEmailByUsername(body).then(function(data) {
  console.log('API called successfully. Returned data: ' + data);
}, function(error) {
  console.error(error);
});

Parameters

Name	Type	Description	Notes
body	DefaultSelector	body of the request

Return type

DefaultResponse

Authorization

Bearer

HTTP request headers

Content-Type: application/json
Accept: Not defined

Files

JAccountApi.md

Latest commit

History

JAccountApi.md

File metadata and controls

KodingApi.JAccountApi

acceptInvitation

Example

Parameters

Return type

Authorization

HTTP request headers

blockUser

Example

Parameters

Return type

Authorization

HTTP request headers

byRelevance

Example

Parameters

Return type

Authorization

HTTP request headers

cancelRequest

Example

Parameters

Return type

Authorization

HTTP request headers

checkGroupMembership

Example

Parameters

Return type

Authorization

HTTP request headers

count

Example

Parameters

Return type

Authorization

HTTP request headers

destroy

Example

Parameters

Return type

Authorization

HTTP request headers

expireSubscription

Example

Parameters

Return type

Authorization

HTTP request headers

fetchAppStorage

Example

Parameters

Return type

Authorization

HTTP request headers

fetchBlockedUsers

Example

Parameters

Return type

Authorization

HTTP request headers

fetchEmail

Example

Parameters

Return type

Authorization

HTTP request headers

fetchEmailAndStatus

Example

Parameters

Return type

Authorization

HTTP request headers

fetchEmailFrequency