Id4iApi.OrganizationsApi

All URIs are relative to https://backend.id4i.de

Method	HTTP request	Description
addPartnerOrganization	PUT /api/v1/organizations/{organizationId}/partner	Add partner
addUserRoles	POST /api/v1/organizations/{organizationId}/users/{username}/roles	Add role(s) to user
createOrganization	POST /api/v1/organizations	Create organization
deleteOrganization	DELETE /api/v1/organizations/{organizationId}	Delete organization
deleteOrganizationBillingAddress	DELETE /api/v1/organizations/{organizationId}/addresses/billing	Remove billing address
deleteOrganizationLogo	DELETE /api/v1/organizations/{organizationId}/logo	Delete organization logo
findOrganization	GET /api/v1/organizations/{organizationId}	Find organization by id/namespace
findOrganizationAddress	GET /api/v1/organizations/{organizationId}/addresses/default	Retrieve address
findOrganizationBillingAddress	GET /api/v1/organizations/{organizationId}/addresses/billing	Retrieve billing address
getAllCollectionsOfOrganization	GET /api/v1/organizations/{organizationId}/collections	Get collections of organization
getAllOrganizationRoles	GET /api/v1/organizations/{organizationId}/roles	List users and their roles
getOrganizationPrivileges	GET /api/v1/organizations/{organizationId}/privileges	List my privileges
getOrganizationsOfUser	GET /api/v1/user/organizations	Retrieve organizations of user
getPartnerOrganizations	GET /api/v1/organizations/{organizationId}/partner	Get partners of an organization
getUserRoles	GET /api/v1/organizations/{organizationId}/users/{username}/roles	Get user roles by username
getUsersOfOrganization	GET /api/v1/organizations/{organizationId}/users	Find users in organization
inviteUsers	POST /api/v1/organizations/{organizationId}/users/invite	Invite Users
listCountries	GET /api/v1/countries	List countries
removePartnerOrganization	DELETE /api/v1/organizations/{organizationId}/partner	Remove partner
removeUserRoles	DELETE /api/v1/organizations/{organizationId}/users/{username}/roles	Remove role(s) from user
setOrganizationLogo	POST /api/v1/organizations/{organizationId}/logo	Update organization logo
updateOrganization	PUT /api/v1/organizations/{organizationId}	Update organization
updateOrganizationAddress	PUT /api/v1/organizations/{organizationId}/addresses/default	Store address
updateOrganizationBillingAddress	PUT /api/v1/organizations/{organizationId}/addresses/billing	Store billing address

addPartnerOrganization

addPartnerOrganization(organizationId, request)

Add partner

Adding a partner organization. If the given organization is already a partner the result will be state 200 too.

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

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

var apiInstance = new Id4iApi.OrganizationsApi();

var organizationId = "organizationId_example"; // String | The namespace of the organization

var request = new Id4iApi.AddPartnerRequest(); // AddPartnerRequest | request


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

Parameters

Name	Type	Description	Notes
organizationId	String	The namespace of the organization
request	AddPartnerRequest	request

Return type

null (empty response body)

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

addUserRoles

addUserRoles(organizationId, username, changeRoleRequest)

Add role(s) to user

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

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

var apiInstance = new Id4iApi.OrganizationsApi();

var organizationId = "organizationId_example"; // String | The namespace of the organization

var username = "username_example"; // String | username

var changeRoleRequest = new Id4iApi.ChangeRoleRequest(); // ChangeRoleRequest | changeRoleRequest


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.addUserRoles(organizationId, username, changeRoleRequest, callback);

Parameters

Name	Type	Description
organizationId	String	The namespace of the organization
username	String	username
changeRoleRequest	ChangeRoleRequest	changeRoleRequest

Return type

null (empty response body)

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

createOrganization

Organization createOrganization(organization)

Create organization

Creating a new organization.

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

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

var apiInstance = new Id4iApi.OrganizationsApi();

var organization = new Id4iApi.Organization(); // Organization | Organization to be created


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

Parameters

Name	Type	Description	Notes
organization	Organization	Organization to be created

Return type

Organization

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

deleteOrganization

deleteOrganization(organizationId)

Delete organization

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

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

var apiInstance = new Id4iApi.OrganizationsApi();

var organizationId = "organizationId_example"; // String | The namespace of the organization to be deleted.


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

Parameters

Name	Type	Description	Notes
organizationId	String	The namespace of the organization to be deleted.

Return type

null (empty response body)

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

deleteOrganizationBillingAddress

deleteOrganizationBillingAddress(organizationId)

Remove billing address

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

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

var apiInstance = new Id4iApi.OrganizationsApi();

var organizationId = "organizationId_example"; // String | organizationId


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

Parameters

Name	Type	Description	Notes
organizationId	String	organizationId

Return type

null (empty response body)

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

deleteOrganizationLogo

deleteOrganizationLogo(organizationId)

Delete organization logo

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

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

var apiInstance = new Id4iApi.OrganizationsApi();

var organizationId = "organizationId_example"; // String | The namespace of the organization where the logo should be deleted.


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

Parameters

Name	Type	Description	Notes
organizationId	String	The namespace of the organization where the logo should be deleted.

Return type

null (empty response body)

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

findOrganization

Organization findOrganization(organizationId)

Find organization by id/namespace

Returns a single organization.

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

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

var apiInstance = new Id4iApi.OrganizationsApi();

var organizationId = "organizationId_example"; // String | The namespace of the organization to be retrieved.


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

Parameters

Name	Type	Description	Notes
organizationId	String	The namespace of the organization to be retrieved.

Return type

Organization

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

findOrganizationAddress

OrganizationAddress findOrganizationAddress(organizationId)

Retrieve address

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

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

var apiInstance = new Id4iApi.OrganizationsApi();

var organizationId = "organizationId_example"; // String | organizationId


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

Parameters

Name	Type	Description	Notes
organizationId	String	organizationId

Return type

OrganizationAddress

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

findOrganizationBillingAddress

OrganizationAddress findOrganizationBillingAddress(organizationId)

Retrieve billing address

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

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

var apiInstance = new Id4iApi.OrganizationsApi();

var organizationId = "organizationId_example"; // String | organizationId


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

Parameters

Name	Type	Description	Notes
organizationId	String	organizationId

Return type

OrganizationAddress

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

getAllCollectionsOfOrganization

PaginatedResponseOfGuidCollection getAllCollectionsOfOrganization(organizationId, opts)

Get collections of organization

Retrieving all collections of an organization in a paginated manner. You may filter the results by specifying id4n properties with filter operations (eq, in, ne) in the query parameters. e.g. `com.yourcompany.orderId.eq=1234`

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

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

var apiInstance = new Id4iApi.OrganizationsApi();

var organizationId = "organizationId_example"; // String | The namespace of the organization

var opts = { 
  'offset': 56, // Number | Start with the n-th element
  'limit': 56, // Number | The maximum count of returned elements
  'type': "type_example", // String | Filter by this type
  'label': "label_example", // String | Filter by this label
  'labelPrefix': "labelPrefix_example", // String | Filter by this label prefix
  'property': ["property_example"] // [String] | List of i4dn property filter. e.g. \"com.myorga.state:IN:waiting|processing\" or \"com.myorga.orderId:EQ:SAP001\"
};

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

Parameters

Name	Type	Description	Notes
organizationId	String	The namespace of the organization
offset	Number	Start with the n-th element	[optional]
limit	Number	The maximum count of returned elements	[optional]
type	String	Filter by this type	[optional]
label	String	Filter by this label	[optional]
labelPrefix	String	Filter by this label prefix	[optional]
property	[String]	List of i4dn property filter. e.g. "com.myorga.state:IN:waiting	processing" or "com.myorga.orderId:EQ:SAP001"

Return type

PaginatedResponseOfGuidCollection

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

getAllOrganizationRoles

PaginatedResponseOfUserRoles getAllOrganizationRoles(organizationId, opts)

List users and their roles

Listing users and their roles in a paginated manner.

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

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

var apiInstance = new Id4iApi.OrganizationsApi();

var organizationId = "organizationId_example"; // String | organizationId

var opts = { 
  'offset': 56, // Number | Start with the n-th element
  'limit': 56 // Number | The maximum count of returned elements
};

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

Parameters

Name	Type	Description	Notes
organizationId	String	organizationId
offset	Number	Start with the n-th element	[optional]
limit	Number	The maximum count of returned elements	[optional]

Return type

PaginatedResponseOfUserRoles

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

getOrganizationPrivileges

['String'] getOrganizationPrivileges(organizationId)

List my privileges

Listing all privileges of the current user/APIKey of the specified organization.

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

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

var apiInstance = new Id4iApi.OrganizationsApi();

var organizationId = "organizationId_example"; // String | The namespace of the organization


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

Parameters

Name	Type	Description	Notes
organizationId	String	The namespace of the organization

Return type

['String']

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

getOrganizationsOfUser

PaginatedResponseOfOrganization getOrganizationsOfUser(opts)

Retrieve organizations of user

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

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

var apiInstance = new Id4iApi.OrganizationsApi();

var opts = { 
  'role': "role_example", // String | role
  'offset': 56, // Number | Start with the n-th element
  'limit': 56 // Number | The maximum count of returned elements
};

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

Parameters

Name	Type	Description	Notes
role	String	role	[optional]
offset	Number	Start with the n-th element	[optional]
limit	Number	The maximum count of returned elements	[optional]

Return type

PaginatedResponseOfOrganization

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

getPartnerOrganizations

PaginatedResponseOfPartnerOrganization getPartnerOrganizations(organizationId, opts)

Get partners of an organization

Listing partners in a paginated manner.

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

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

var apiInstance = new Id4iApi.OrganizationsApi();

var organizationId = "organizationId_example"; // String | The namespace of the organization to query partner organizations

var opts = { 
  'offset': 56, // Number | Start with the n-th element
  'limit': 56 // Number | The maximum count of returned elements
};

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

Parameters

Name	Type	Description	Notes
organizationId	String	The namespace of the organization to query partner organizations
offset	Number	Start with the n-th element	[optional]
limit	Number	The maximum count of returned elements	[optional]

Return type

PaginatedResponseOfPartnerOrganization

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

getUserRoles

PaginatedResponseOfstring getUserRoles(organizationId, username, opts)

Get user roles by username

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

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

var apiInstance = new Id4iApi.OrganizationsApi();

var organizationId = "organizationId_example"; // String | The namespace of the organization

var username = "username_example"; // String | username

var opts = { 
  'offset': 56, // Number | Start with the n-th element
  'limit': 56 // Number | The maximum count of returned elements
};

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

Parameters

Name	Type	Description	Notes
organizationId	String	The namespace of the organization
username	String	username
offset	Number	Start with the n-th element	[optional]
limit	Number	The maximum count of returned elements	[optional]

Return type

PaginatedResponseOfstring

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

getUsersOfOrganization

PaginatedResponseOfUserPresentation getUsersOfOrganization(organizationId, opts)

Find users in organization

Finding users in the specified organization in a paginated manner.

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

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

var apiInstance = new Id4iApi.OrganizationsApi();

var organizationId = "organizationId_example"; // String | organizationId

var opts = { 
  'offset': 56, // Number | Start with the n-th element
  'limit': 56 // Number | The maximum count of returned elements
};

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

Parameters

Name	Type	Description	Notes
organizationId	String	organizationId
offset	Number	Start with the n-th element	[optional]
limit	Number	The maximum count of returned elements	[optional]

Return type

PaginatedResponseOfUserPresentation

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

inviteUsers

inviteUsers(organizationId, invitationList)

Invite Users

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

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

var apiInstance = new Id4iApi.OrganizationsApi();

var organizationId = "organizationId_example"; // String | The namespace of the organization where users should be invited

var invitationList = new Id4iApi.OrganizationUserInvitationListRequest(); // OrganizationUserInvitationListRequest | invitationList


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

Parameters

Name	Type	Description	Notes
organizationId	String	The namespace of the organization where users should be invited
invitationList	OrganizationUserInvitationListRequest	invitationList

Return type

null (empty response body)

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

listCountries

PaginatedResponseOfCountry listCountries(opts)

List countries

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

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

var apiInstance = new Id4iApi.OrganizationsApi();

var opts = { 
  'offset': 56, // Number | Start with the n-th element
  'limit': 56 // Number | The maximum count of returned elements
};

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

Parameters

Name	Type	Description	Notes
offset	Number	Start with the n-th element	[optional]
limit	Number	The maximum count of returned elements	[optional]

Return type

PaginatedResponseOfCountry

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

removePartnerOrganization

removePartnerOrganization(organizationId, request)

Remove partner

Removing a partner organization

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

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

var apiInstance = new Id4iApi.OrganizationsApi();

var organizationId = "organizationId_example"; // String | The namespace of the organization

var request = new Id4iApi.RemovePartnerRequest(); // RemovePartnerRequest | request


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

Parameters

Name	Type	Description	Notes
organizationId	String	The namespace of the organization
request	RemovePartnerRequest	request

Return type

null (empty response body)

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

removeUserRoles

removeUserRoles(organizationId, username, changeRoleRequest)

Remove role(s) from user

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

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

var apiInstance = new Id4iApi.OrganizationsApi();

var organizationId = "organizationId_example"; // String | The namespace of the organization

var username = "username_example"; // String | username

var changeRoleRequest = new Id4iApi.ChangeRoleRequest(); // ChangeRoleRequest | changeRoleRequest


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
apiInstance.removeUserRoles(organizationId, username, changeRoleRequest, callback);

Parameters

Name	Type	Description
organizationId	String	The namespace of the organization
username	String	username
changeRoleRequest	ChangeRoleRequest	changeRoleRequest

Return type

null (empty response body)

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

setOrganizationLogo

PublicImagePresentation setOrganizationLogo(organizationId, file)

Update organization logo

Updating an organization logo using a multipart file upload.

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

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

var apiInstance = new Id4iApi.OrganizationsApi();

var organizationId = "organizationId_example"; // String | The namespace of the organization where the logo should be updated.

var file = "/path/to/file.txt"; // File | An image containing the new logo.


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

Parameters

Name	Type	Description	Notes
organizationId	String	The namespace of the organization where the logo should be updated.
file	File	An image containing the new logo.

Return type

PublicImagePresentation

Authorization

HTTP request headers

Content-Type: multipart/form-data
Accept: application/xml, application/json

updateOrganization

Organization updateOrganization(organizationId, organizationUpdate)

Update organization

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

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

var apiInstance = new Id4iApi.OrganizationsApi();

var organizationId = "organizationId_example"; // String | The namespace of the organization to be updated.

var organizationUpdate = new Id4iApi.OrganizationUpdate(); // OrganizationUpdate | Updated organization object


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

Parameters

Name	Type	Description	Notes
organizationId	String	The namespace of the organization to be updated.
organizationUpdate	OrganizationUpdate	Updated organization object

Return type

Organization

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

updateOrganizationAddress

OrganizationAddress updateOrganizationAddress(organizationId, addressResource)

Store address

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

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

var apiInstance = new Id4iApi.OrganizationsApi();

var organizationId = "organizationId_example"; // String | organizationId

var addressResource = new Id4iApi.OrganizationAddress(); // OrganizationAddress | addressResource


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

Parameters

Name	Type	Description	Notes
organizationId	String	organizationId
addressResource	OrganizationAddress	addressResource

Return type

OrganizationAddress

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

updateOrganizationBillingAddress

OrganizationAddress updateOrganizationBillingAddress(organizationId, addressResource)

Store billing address

Example

var Id4iApi = require('id4i_api');
var defaultClient = Id4iApi.ApiClient.instance;

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

var apiInstance = new Id4iApi.OrganizationsApi();

var organizationId = "organizationId_example"; // String | organizationId

var addressResource = new Id4iApi.OrganizationAddress(); // OrganizationAddress | addressResource


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

Parameters

Name	Type	Description	Notes
organizationId	String	organizationId
addressResource	OrganizationAddress	addressResource

Return type

OrganizationAddress

Authorization

HTTP request headers

Content-Type: application/xml, application/json
Accept: application/xml, application/json

Files

OrganizationsApi.md

Latest commit

History

OrganizationsApi.md

File metadata and controls

Id4iApi.OrganizationsApi

addPartnerOrganization

Example

Parameters

Return type

Authorization

HTTP request headers

addUserRoles

Example

Parameters

Return type

Authorization

HTTP request headers

createOrganization

Example

Parameters

Return type

Authorization

HTTP request headers

deleteOrganization

Example

Parameters

Return type

Authorization

HTTP request headers

deleteOrganizationBillingAddress

Example

Parameters

Return type

Authorization

HTTP request headers

deleteOrganizationLogo

Example

Parameters

Return type

Authorization

HTTP request headers

findOrganization

Example

Parameters

Return type

Authorization

HTTP request headers

findOrganizationAddress

Example

Parameters

Return type

Authorization

HTTP request headers

findOrganizationBillingAddress

Example

Parameters

Return type

Authorization

HTTP request headers

getAllCollectionsOfOrganization

Example

Parameters

Return type

Authorization

HTTP request headers

getAllOrganizationRoles

Example

Parameters

Return type

Authorization

HTTP request headers

getOrganizationPrivileges

Example

Parameters

Return type

Authorization

HTTP request headers

getOrganizationsOfUser