Skip to content

Latest commit

 

History

History
531 lines (370 loc) · 17.4 KB

OrganizationApi.md

File metadata and controls

531 lines (370 loc) · 17.4 KB

FlatApi.OrganizationApi

All URIs are relative to https://api.flat.io/v2

Method HTTP request Description
createLtiCredentials POST /organizations/lti/credentials Create a new couple of LTI 1.x credentials
createOrganizationInvitation POST /organizations/invitations Create a new invitation to join the organization
createOrganizationUser POST /organizations/users Create a new user account
listLtiCredentials GET /organizations/lti/credentials List LTI 1.x credentials
listOrganizationInvitations GET /organizations/invitations List the organization invitations
listOrganizationUsers GET /organizations/users List the organization users
removeOrganizationInvitation DELETE /organizations/invitations/{invitation} Remove an organization invitation
removeOrganizationUser DELETE /organizations/users/{user} Remove an account from Flat
revokeLtiCredentials DELETE /organizations/lti/credentials/{credentials} Revoke LTI 1.x credentials
updateOrganizationUser PUT /organizations/users/{user} Update account information

createLtiCredentials

LtiCredentials createLtiCredentials(body)

Create a new couple of LTI 1.x credentials

Flat for Education is a Certified LTI Provider. You can use these API methods to automate the creation of LTI credentials. You can read more about our LTI implementation, supported components and LTI Endpoints in our Developer Documentation.

Example

var FlatApi = require('flat-api');
var defaultClient = FlatApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new FlatApi.OrganizationApi();

var body = new FlatApi.LtiCredentialsCreation(); // LtiCredentialsCreation | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createLtiCredentials(body, callback);

Parameters

Name Type Description Notes
body LtiCredentialsCreation

Return type

LtiCredentials

Authorization

OAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createOrganizationInvitation

OrganizationInvitation createOrganizationInvitation(opts)

Create a new invitation to join the organization

This method creates and sends invitation for teachers and admins. Invitations can only be used by new Flat users or users who are not part of the organization yet. If the email of the user is already associated to a user of your organization, the API will simply update the role of the existing user and won't send an invitation. In this case, the property `usedBy` will be directly filled with the uniquer identifier of the corresponding user.

Example

var FlatApi = require('flat-api');
var defaultClient = FlatApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new FlatApi.OrganizationApi();

var opts = { 
  'body': new FlatApi.OrganizationInvitationCreation() // OrganizationInvitationCreation | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createOrganizationInvitation(opts, callback);

Parameters

Name Type Description Notes
body OrganizationInvitationCreation [optional]

Return type

OrganizationInvitation

Authorization

OAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createOrganizationUser

UserDetailsAdmin createOrganizationUser(opts)

Create a new user account

Example

var FlatApi = require('flat-api');
var defaultClient = FlatApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new FlatApi.OrganizationApi();

var opts = { 
  'body': new FlatApi.UserCreation() // UserCreation | 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.createOrganizationUser(opts, callback);

Parameters

Name Type Description Notes
body UserCreation [optional]

Return type

UserDetailsAdmin

Authorization

OAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

listLtiCredentials

[LtiCredentials] listLtiCredentials()

List LTI 1.x credentials

Example

var FlatApi = require('flat-api');
var defaultClient = FlatApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new FlatApi.OrganizationApi();

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.listLtiCredentials(callback);

Parameters

This endpoint does not need any parameter.

Return type

[LtiCredentials]

Authorization

OAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

listOrganizationInvitations

[OrganizationInvitation] listOrganizationInvitations(opts)

List the organization invitations

Example

var FlatApi = require('flat-api');
var defaultClient = FlatApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new FlatApi.OrganizationApi();

var opts = { 
  'role': "role_example", // String | Filter users by role
  'limit': 50, // Number | This is the maximum number of objects that may be returned
  'next': "next_example", // String | An opaque string cursor to fetch the next page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data. 
  'previous': "previous_example" // String | An opaque string cursor to fetch the previous page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data. 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.listOrganizationInvitations(opts, callback);

Parameters

Name Type Description Notes
role String Filter users by role [optional]
limit Number This is the maximum number of objects that may be returned [optional] [default to 50]
next String An opaque string cursor to fetch the next page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data. [optional]
previous String An opaque string cursor to fetch the previous page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data. [optional]

Return type

[OrganizationInvitation]

Authorization

OAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

listOrganizationUsers

[UserDetailsAdmin] listOrganizationUsers(opts)

List the organization users

Example

var FlatApi = require('flat-api');
var defaultClient = FlatApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new FlatApi.OrganizationApi();

var opts = { 
  'role': "role_example", // String | Filter users by role
  'limit': 50, // Number | This is the maximum number of objects that may be returned
  'next': "next_example", // String | An opaque string cursor to fetch the next page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data. 
  'previous': "previous_example" // String | An opaque string cursor to fetch the previous page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data. 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.listOrganizationUsers(opts, callback);

Parameters

Name Type Description Notes
role String Filter users by role [optional]
limit Number This is the maximum number of objects that may be returned [optional] [default to 50]
next String An opaque string cursor to fetch the next page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data. [optional]
previous String An opaque string cursor to fetch the previous page of data. The paginated API URLs are returned in the `Link` header when requesting the API. These URLs will contain a `next` and `previous` cursor based on the available data. [optional]

Return type

[UserDetailsAdmin]

Authorization

OAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

removeOrganizationInvitation

removeOrganizationInvitation(invitation)

Remove an organization invitation

Example

var FlatApi = require('flat-api');
var defaultClient = FlatApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new FlatApi.OrganizationApi();

var invitation = "invitation_example"; // String | Unique identifier of the invitation


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.removeOrganizationInvitation(invitation, callback);

Parameters

Name Type Description Notes
invitation String Unique identifier of the invitation

Return type

null (empty response body)

Authorization

OAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

removeOrganizationUser

removeOrganizationUser(user, opts)

Remove an account from Flat

This operation removes an account from Flat and its data, including: * The music scores created by this user (documents, history, comments, collaboration information) * Education related data (assignments and classroom information)

Example

var FlatApi = require('flat-api');
var defaultClient = FlatApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new FlatApi.OrganizationApi();

var user = "user_example"; // String | Unique identifier of the Flat account 

var opts = { 
  'convertToIndividual': true // Boolean | If `true`, the account will be only removed from the organization and converted into an individual account on our public website, https://flat.io. This operation will remove the education-related data from the account. Before realizing this operation, you need to be sure that the user is at least 13 years old and that this one has read and agreed to the Individual Terms of Services of Flat available on https://flat.io/legal. 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.removeOrganizationUser(user, opts, callback);

Parameters

Name Type Description Notes
user String Unique identifier of the Flat account
convertToIndividual Boolean If `true`, the account will be only removed from the organization and converted into an individual account on our public website, https://flat.io. This operation will remove the education-related data from the account. Before realizing this operation, you need to be sure that the user is at least 13 years old and that this one has read and agreed to the Individual Terms of Services of Flat available on https://flat.io/legal. [optional]

Return type

null (empty response body)

Authorization

OAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

revokeLtiCredentials

revokeLtiCredentials(credentials)

Revoke LTI 1.x credentials

Example

var FlatApi = require('flat-api');
var defaultClient = FlatApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new FlatApi.OrganizationApi();

var credentials = "credentials_example"; // String | Credentials unique identifier 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.revokeLtiCredentials(credentials, callback);

Parameters

Name Type Description Notes
credentials String Credentials unique identifier

Return type

null (empty response body)

Authorization

OAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

updateOrganizationUser

UserDetailsAdmin updateOrganizationUser(userbody)

Update account information

Example

var FlatApi = require('flat-api');
var defaultClient = FlatApi.ApiClient.instance;

// Configure OAuth2 access token for authorization: OAuth2
var OAuth2 = defaultClient.authentications['OAuth2'];
OAuth2.accessToken = 'YOUR ACCESS TOKEN';

var apiInstance = new FlatApi.OrganizationApi();

var user = "user_example"; // String | Unique identifier of the Flat account 

var body = new FlatApi.UserAdminUpdate(); // UserAdminUpdate | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updateOrganizationUser(userbody, callback);

Parameters

Name Type Description Notes
user String Unique identifier of the Flat account
body UserAdminUpdate

Return type

UserDetailsAdmin

Authorization

OAuth2

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json