BlueRain.ID4i.Api.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

void AddPartnerOrganization (string organizationId, AddPartnerRequest request)

Add partner

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

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class AddPartnerOrganizationExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new OrganizationsApi();
            var organizationId = organizationId_example;  // string | The namespace of the organization
            var request = new AddPartnerRequest(); // AddPartnerRequest | request

            try
            {
                // Add partner
                apiInstance.AddPartnerOrganization(organizationId, request);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.AddPartnerOrganization: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

void (empty response body)

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

AddUserRoles

void AddUserRoles (string organizationId, string username, ChangeRoleRequest changeRoleRequest)

Add role(s) to user

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class AddUserRolesExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new OrganizationsApi();
            var organizationId = organizationId_example;  // string | The namespace of the organization
            var username = username_example;  // string | username
            var changeRoleRequest = new ChangeRoleRequest(); // ChangeRoleRequest | changeRoleRequest

            try
            {
                // Add role(s) to user
                apiInstance.AddUserRoles(organizationId, username, changeRoleRequest);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.AddUserRoles: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

void (empty response body)

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CreateOrganization

Organization CreateOrganization (Organization organization)

Create organization

Creating a new organization.

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class CreateOrganizationExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new OrganizationsApi();
            var organization = new Organization(); // Organization | Organization to be created

            try
            {
                // Create organization
                Organization result = apiInstance.CreateOrganization(organization);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.CreateOrganization: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteOrganization

void DeleteOrganization (string organizationId)

Delete organization

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class DeleteOrganizationExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new OrganizationsApi();
            var organizationId = organizationId_example;  // string | The namespace of the organization to be deleted.

            try
            {
                // Delete organization
                apiInstance.DeleteOrganization(organizationId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.DeleteOrganization: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

void (empty response body)

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteOrganizationBillingAddress

void DeleteOrganizationBillingAddress (string organizationId)

Remove billing address

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class DeleteOrganizationBillingAddressExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new OrganizationsApi();
            var organizationId = organizationId_example;  // string | organizationId

            try
            {
                // Remove billing address
                apiInstance.DeleteOrganizationBillingAddress(organizationId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.DeleteOrganizationBillingAddress: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
organizationId	string	organizationId

Return type

void (empty response body)

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

DeleteOrganizationLogo

void DeleteOrganizationLogo (string organizationId)

Delete organization logo

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class DeleteOrganizationLogoExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new OrganizationsApi();
            var organizationId = organizationId_example;  // string | The namespace of the organization where the logo should be deleted.

            try
            {
                // Delete organization logo
                apiInstance.DeleteOrganizationLogo(organizationId);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.DeleteOrganizationLogo: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

void (empty response body)

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FindOrganization

Organization FindOrganization (string organizationId)

Find organization by id/namespace

Returns a single organization.

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class FindOrganizationExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new OrganizationsApi();
            var organizationId = organizationId_example;  // string | The namespace of the organization to be retrieved.

            try
            {
                // Find organization by id/namespace
                Organization result = apiInstance.FindOrganization(organizationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.FindOrganization: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FindOrganizationAddress

OrganizationAddress FindOrganizationAddress (string organizationId)

Retrieve address

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class FindOrganizationAddressExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new OrganizationsApi();
            var organizationId = organizationId_example;  // string | organizationId

            try
            {
                // Retrieve address
                OrganizationAddress result = apiInstance.FindOrganizationAddress(organizationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.FindOrganizationAddress: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FindOrganizationBillingAddress

OrganizationAddress FindOrganizationBillingAddress (string organizationId)

Retrieve billing address

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class FindOrganizationBillingAddressExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new OrganizationsApi();
            var organizationId = organizationId_example;  // string | organizationId

            try
            {
                // Retrieve billing address
                OrganizationAddress result = apiInstance.FindOrganizationBillingAddress(organizationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.FindOrganizationBillingAddress: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllCollectionsOfOrganization

PaginatedResponseOfGuidCollection GetAllCollectionsOfOrganization (string organizationId, int? offset = null, int? limit = null, string type = null, string label = null, string labelPrefix = null, List property = null)

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

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class GetAllCollectionsOfOrganizationExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new OrganizationsApi();
            var organizationId = organizationId_example;  // string | The namespace of the organization
            var offset = 56;  // int? | Start with the n-th element (optional) 
            var limit = 56;  // int? | The maximum count of returned elements (optional) 
            var type = type_example;  // string | Filter by this type (optional) 
            var label = label_example;  // string | Filter by this label (optional) 
            var labelPrefix = labelPrefix_example;  // string | Filter by this label prefix (optional) 
            var property = new List<string>(); // List<string> | List of i4dn property filter. e.g. \"com.myorga.state:IN:waiting|processing\" or \"com.myorga.orderId:EQ:SAP001\" (optional) 

            try
            {
                // Get collections of organization
                PaginatedResponseOfGuidCollection result = apiInstance.GetAllCollectionsOfOrganization(organizationId, offset, limit, type, label, labelPrefix, property);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.GetAllCollectionsOfOrganization: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
organizationId	string	The namespace of the organization
offset	int?	Start with the n-th element	[optional]
limit	int?	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	List<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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetAllOrganizationRoles

PaginatedResponseOfUserRoles GetAllOrganizationRoles (string organizationId, int? offset = null, int? limit = null)

List users and their roles

Listing users and their roles in a paginated manner.

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class GetAllOrganizationRolesExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new OrganizationsApi();
            var organizationId = organizationId_example;  // string | organizationId
            var offset = 56;  // int? | Start with the n-th element (optional) 
            var limit = 56;  // int? | The maximum count of returned elements (optional) 

            try
            {
                // List users and their roles
                PaginatedResponseOfUserRoles result = apiInstance.GetAllOrganizationRoles(organizationId, offset, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.GetAllOrganizationRoles: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
organizationId	string	organizationId
offset	int?	Start with the n-th element	[optional]
limit	int?	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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetOrganizationPrivileges

List GetOrganizationPrivileges (string organizationId)

List my privileges

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

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class GetOrganizationPrivilegesExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new OrganizationsApi();
            var organizationId = organizationId_example;  // string | The namespace of the organization

            try
            {
                // List my privileges
                List&lt;string&gt; result = apiInstance.GetOrganizationPrivileges(organizationId);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.GetOrganizationPrivileges: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
organizationId	string	The namespace of the organization

Return type

List

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetOrganizationsOfUser

PaginatedResponseOfOrganization GetOrganizationsOfUser (string role = null, int? offset = null, int? limit = null)

Retrieve organizations of user

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class GetOrganizationsOfUserExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new OrganizationsApi();
            var role = role_example;  // string | role (optional) 
            var offset = 56;  // int? | Start with the n-th element (optional) 
            var limit = 56;  // int? | The maximum count of returned elements (optional) 

            try
            {
                // Retrieve organizations of user
                PaginatedResponseOfOrganization result = apiInstance.GetOrganizationsOfUser(role, offset, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.GetOrganizationsOfUser: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
role	string	role	[optional]
offset	int?	Start with the n-th element	[optional]
limit	int?	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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetPartnerOrganizations

PaginatedResponseOfPartnerOrganization GetPartnerOrganizations (string organizationId, int? offset = null, int? limit = null)

Get partners of an organization

Listing partners in a paginated manner.

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class GetPartnerOrganizationsExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new OrganizationsApi();
            var organizationId = organizationId_example;  // string | The namespace of the organization to query partner organizations
            var offset = 56;  // int? | Start with the n-th element (optional) 
            var limit = 56;  // int? | The maximum count of returned elements (optional) 

            try
            {
                // Get partners of an organization
                PaginatedResponseOfPartnerOrganization result = apiInstance.GetPartnerOrganizations(organizationId, offset, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.GetPartnerOrganizations: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
organizationId	string	The namespace of the organization to query partner organizations
offset	int?	Start with the n-th element	[optional]
limit	int?	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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUserRoles

PaginatedResponseOfstring GetUserRoles (string organizationId, string username, int? offset = null, int? limit = null)

Get user roles by username

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class GetUserRolesExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new OrganizationsApi();
            var organizationId = organizationId_example;  // string | The namespace of the organization
            var username = username_example;  // string | username
            var offset = 56;  // int? | Start with the n-th element (optional) 
            var limit = 56;  // int? | The maximum count of returned elements (optional) 

            try
            {
                // Get user roles by username
                PaginatedResponseOfstring result = apiInstance.GetUserRoles(organizationId, username, offset, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.GetUserRoles: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
organizationId	string	The namespace of the organization
username	string	username
offset	int?	Start with the n-th element	[optional]
limit	int?	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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

GetUsersOfOrganization

PaginatedResponseOfUserPresentation GetUsersOfOrganization (string organizationId, int? offset = null, int? limit = null)

Find users in organization

Finding users in the specified organization in a paginated manner.

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class GetUsersOfOrganizationExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new OrganizationsApi();
            var organizationId = organizationId_example;  // string | organizationId
            var offset = 56;  // int? | Start with the n-th element (optional) 
            var limit = 56;  // int? | The maximum count of returned elements (optional) 

            try
            {
                // Find users in organization
                PaginatedResponseOfUserPresentation result = apiInstance.GetUsersOfOrganization(organizationId, offset, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.GetUsersOfOrganization: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
organizationId	string	organizationId
offset	int?	Start with the n-th element	[optional]
limit	int?	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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

InviteUsers

void InviteUsers (string organizationId, OrganizationUserInvitationListRequest invitationList)

Invite Users

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class InviteUsersExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new OrganizationsApi();
            var organizationId = organizationId_example;  // string | The namespace of the organization where users should be invited
            var invitationList = new OrganizationUserInvitationListRequest(); // OrganizationUserInvitationListRequest | invitationList

            try
            {
                // Invite Users
                apiInstance.InviteUsers(organizationId, invitationList);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.InviteUsers: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

void (empty response body)

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

ListCountries

PaginatedResponseOfCountry ListCountries (int? offset = null, int? limit = null)

List countries

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class ListCountriesExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new OrganizationsApi();
            var offset = 56;  // int? | Start with the n-th element (optional) 
            var limit = 56;  // int? | The maximum count of returned elements (optional) 

            try
            {
                // List countries
                PaginatedResponseOfCountry result = apiInstance.ListCountries(offset, limit);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.ListCountries: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
offset	int?	Start with the n-th element	[optional]
limit	int?	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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemovePartnerOrganization

void RemovePartnerOrganization (string organizationId, RemovePartnerRequest request)

Remove partner

Removing a partner organization

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class RemovePartnerOrganizationExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new OrganizationsApi();
            var organizationId = organizationId_example;  // string | The namespace of the organization
            var request = new RemovePartnerRequest(); // RemovePartnerRequest | request

            try
            {
                // Remove partner
                apiInstance.RemovePartnerOrganization(organizationId, request);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.RemovePartnerOrganization: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

void (empty response body)

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

RemoveUserRoles

void RemoveUserRoles (string organizationId, string username, ChangeRoleRequest changeRoleRequest)

Remove role(s) from user

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class RemoveUserRolesExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new OrganizationsApi();
            var organizationId = organizationId_example;  // string | The namespace of the organization
            var username = username_example;  // string | username
            var changeRoleRequest = new ChangeRoleRequest(); // ChangeRoleRequest | changeRoleRequest

            try
            {
                // Remove role(s) from user
                apiInstance.RemoveUserRoles(organizationId, username, changeRoleRequest);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.RemoveUserRoles: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

void (empty response body)

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

SetOrganizationLogo

PublicImagePresentation SetOrganizationLogo (string organizationId, System.IO.Stream file)

Update organization logo

Updating an organization logo using a multipart file upload.

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class SetOrganizationLogoExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new OrganizationsApi();
            var organizationId = organizationId_example;  // string | The namespace of the organization where the logo should be updated.
            var file = new System.IO.Stream(); // System.IO.Stream | An image containing the new logo.

            try
            {
                // Update organization logo
                PublicImagePresentation result = apiInstance.SetOrganizationLogo(organizationId, file);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.SetOrganizationLogo: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
organizationId	string	The namespace of the organization where the logo should be updated.
file	System.IO.Stream	An image containing the new logo.

Return type

PublicImagePresentation

Authorization

HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateOrganization

Organization UpdateOrganization (string organizationId, OrganizationUpdate organizationUpdate)

Update organization

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class UpdateOrganizationExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new OrganizationsApi();
            var organizationId = organizationId_example;  // string | The namespace of the organization to be updated.
            var organizationUpdate = new OrganizationUpdate(); // OrganizationUpdate | Updated organization object

            try
            {
                // Update organization
                Organization result = apiInstance.UpdateOrganization(organizationId, organizationUpdate);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.UpdateOrganization: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateOrganizationAddress

OrganizationAddress UpdateOrganizationAddress (string organizationId, OrganizationAddress addressResource)

Store address

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class UpdateOrganizationAddressExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new OrganizationsApi();
            var organizationId = organizationId_example;  // string | organizationId
            var addressResource = new OrganizationAddress(); // OrganizationAddress | addressResource

            try
            {
                // Store address
                OrganizationAddress result = apiInstance.UpdateOrganizationAddress(organizationId, addressResource);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.UpdateOrganizationAddress: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

UpdateOrganizationBillingAddress

OrganizationAddress UpdateOrganizationBillingAddress (string organizationId, OrganizationAddress addressResource)

Store billing address

Example

using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;

namespace Example
{
    public class UpdateOrganizationBillingAddressExample
    {
        public void main()
        {
            // Configure API key authorization: Authorization
            Configuration.Default.AddApiKey("Authorization", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.AddApiKeyPrefix("Authorization", "Bearer");

            var apiInstance = new OrganizationsApi();
            var organizationId = organizationId_example;  // string | organizationId
            var addressResource = new OrganizationAddress(); // OrganizationAddress | addressResource

            try
            {
                // Store billing address
                OrganizationAddress result = apiInstance.UpdateOrganizationBillingAddress(organizationId, addressResource);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling OrganizationsApi.UpdateOrganizationBillingAddress: " + e.Message );
            }
        }
    }
}

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

FilesExpand file tree

OrganizationsApi.md

Latest commit

History

OrganizationsApi.md

File metadata and controls

BlueRain.ID4i.Api.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