All URIs are relative to https://backend.id4i.de
| Method | HTTP request | Description |
|---|---|---|
| AddUserRoles | POST /api/v1/organizations/{organizationId}/users/{username}/roles | Add role(s) to user |
| CompleteRegistration | PUT /account/registration | Complete registration |
| FindUserByUsername | GET /api/v1/users/{username} | Find by username |
| FindUsers | GET /api/v1/users | Find users |
| GetAllOrganizationRoles | GET /api/v1/organizations/{organizationId}/roles | List users and their roles |
| GetOrganizationsOfUser | GET /api/v1/user/organizations | Retrieve organizations of user |
| 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 |
| ListAllRoles | GET /api/v1/roles | List roles |
| Login | POST /login | |
| RegisterUser | POST /account/registration | Register user |
| RemoveUserRoles | DELETE /api/v1/organizations/{organizationId}/users/{username}/roles | Remove role(s) from user |
| RequestPasswordReset | POST /account/password | Request password reset |
| VerifyPasswordReset | PUT /account/password | Verify password reset |
| VerifyUserRegistration | POST /account/verification | Verify registration |
void AddUserRoles (string organizationId, string username, ChangeRoleRequest changeRoleRequest)
Add role(s) to user
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 AccountsApi();
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 AccountsApi.AddUserRoles: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| organizationId | string | The namespace of the organization | |
| username | string | username | |
| changeRoleRequest | ChangeRoleRequest | changeRoleRequest |
void (empty response body)
- 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]
void CompleteRegistration (CompleteUserRegistrationRequest completeRegistration)
Complete registration
Completing a registration e.g. for invited users. Finish registration with a username and a password.
using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;
namespace Example
{
public class CompleteRegistrationExample
{
public void main()
{
var apiInstance = new AccountsApi();
var completeRegistration = new CompleteUserRegistrationRequest(); // CompleteUserRegistrationRequest | Contains the verification token, the username and the initial password.
try
{
// Complete registration
apiInstance.CompleteRegistration(completeRegistration);
}
catch (Exception e)
{
Debug.Print("Exception when calling AccountsApi.CompleteRegistration: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| completeRegistration | CompleteUserRegistrationRequest | Contains the verification token, the username and the initial password. |
void (empty response body)
No authorization required
- 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]
UserPresentation FindUserByUsername (string username)
Find by username
using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;
namespace Example
{
public class FindUserByUsernameExample
{
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 AccountsApi();
var username = username_example; // string | username
try
{
// Find by username
UserPresentation result = apiInstance.FindUserByUsername(username);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AccountsApi.FindUserByUsername: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| username | string | username |
- 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]
PaginatedResponseOfUserPresentation FindUsers (string usernamePrefix = null, int? offset = null, int? limit = null)
Find users
using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;
namespace Example
{
public class FindUsersExample
{
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 AccountsApi();
var usernamePrefix = usernamePrefix_example; // string | (optional)
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
PaginatedResponseOfUserPresentation result = apiInstance.FindUsers(usernamePrefix, offset, limit);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AccountsApi.FindUsers: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| usernamePrefix | string | [optional] | |
| offset | int? | Start with the n-th element | [optional] |
| limit | int? | The maximum count of returned elements | [optional] |
PaginatedResponseOfUserPresentation
- 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]
PaginatedResponseOfUserRoles GetAllOrganizationRoles (string organizationId, int? offset = null, int? limit = null)
List users and their roles
Listing users and their roles in a paginated manner.
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 AccountsApi();
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 AccountsApi.GetAllOrganizationRoles: " + e.Message );
}
}
}
}| 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] |
- 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]
PaginatedResponseOfOrganization GetOrganizationsOfUser (string role = null, int? offset = null, int? limit = null)
Retrieve organizations of user
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 AccountsApi();
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 AccountsApi.GetOrganizationsOfUser: " + e.Message );
}
}
}
}| 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] |
PaginatedResponseOfOrganization
- 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]
PaginatedResponseOfstring GetUserRoles (string organizationId, string username, int? offset = null, int? limit = null)
Get user roles by username
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 AccountsApi();
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 AccountsApi.GetUserRoles: " + e.Message );
}
}
}
}| 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] |
- 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]
PaginatedResponseOfUserPresentation GetUsersOfOrganization (string organizationId, int? offset = null, int? limit = null)
Find users in organization
Finding users in the specified organization in a paginated manner.
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 AccountsApi();
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 AccountsApi.GetUsersOfOrganization: " + e.Message );
}
}
}
}| 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] |
PaginatedResponseOfUserPresentation
- 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]
void InviteUsers (string organizationId, OrganizationUserInvitationListRequest invitationList)
Invite Users
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 AccountsApi();
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 AccountsApi.InviteUsers: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| organizationId | string | The namespace of the organization where users should be invited | |
| invitationList | OrganizationUserInvitationListRequest | invitationList |
void (empty response body)
- 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]
PaginatedResponseOfRole ListAllRoles (string privilege = null, int? offset = null, int? limit = null)
List roles
Listing of roles.
using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;
namespace Example
{
public class ListAllRolesExample
{
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 AccountsApi();
var privilege = privilege_example; // string | If specified the roles will be filtered containing that privilege. (optional)
var offset = 56; // int? | Start with the n-th element (optional)
var limit = 56; // int? | The maximum count of returned elements (optional)
try
{
// List roles
PaginatedResponseOfRole result = apiInstance.ListAllRoles(privilege, offset, limit);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AccountsApi.ListAllRoles: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| privilege | string | If specified the roles will be filtered containing that privilege. | [optional] |
| offset | int? | Start with the n-th element | [optional] |
| limit | int? | The maximum count of returned elements | [optional] |
- 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]
void Login (AccountCredentials accountCredentials)
ID4i API Login
using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;
namespace Example
{
public class LoginExample
{
public void main()
{
var apiInstance = new AccountsApi();
var accountCredentials = new AccountCredentials(); // AccountCredentials |
try
{
apiInstance.Login(accountCredentials);
}
catch (Exception e)
{
Debug.Print("Exception when calling AccountsApi.Login: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| accountCredentials | AccountCredentials |
void (empty response body)
No authorization required
- 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]
UserRegistrationResponse RegisterUser (UserRegistrationRequest userRegistration)
Register user
Registering a new user.
using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;
namespace Example
{
public class RegisterUserExample
{
public void main()
{
var apiInstance = new AccountsApi();
var userRegistration = new UserRegistrationRequest(); // UserRegistrationRequest | The user information about the new created user.
try
{
// Register user
UserRegistrationResponse result = apiInstance.RegisterUser(userRegistration);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AccountsApi.RegisterUser: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| userRegistration | UserRegistrationRequest | The user information about the new created user. |
No authorization required
- 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]
void RemoveUserRoles (string organizationId, string username, ChangeRoleRequest changeRoleRequest)
Remove role(s) from user
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 AccountsApi();
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 AccountsApi.RemoveUserRoles: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| organizationId | string | The namespace of the organization | |
| username | string | username | |
| changeRoleRequest | ChangeRoleRequest | changeRoleRequest |
void (empty response body)
- 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]
SimpleMessageResponse RequestPasswordReset (PasswordResetRequest resetRequest)
Request password reset
Requesting a reset for a new password.
using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;
namespace Example
{
public class RequestPasswordResetExample
{
public void main()
{
var apiInstance = new AccountsApi();
var resetRequest = new PasswordResetRequest(); // PasswordResetRequest | Contains the required information to request a new password.
try
{
// Request password reset
SimpleMessageResponse result = apiInstance.RequestPasswordReset(resetRequest);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AccountsApi.RequestPasswordReset: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| resetRequest | PasswordResetRequest | Contains the required information to request a new password. |
No authorization required
- 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]
SimpleMessageResponse VerifyPasswordReset (PasswordResetVerificationRequest verificationRequest)
Verify password reset
Setting a new password and verifying the request to set the password.
using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;
namespace Example
{
public class VerifyPasswordResetExample
{
public void main()
{
var apiInstance = new AccountsApi();
var verificationRequest = new PasswordResetVerificationRequest(); // PasswordResetVerificationRequest | Contains the new password and the verification token to set the new password.
try
{
// Verify password reset
SimpleMessageResponse result = apiInstance.VerifyPasswordReset(verificationRequest);
Debug.WriteLine(result);
}
catch (Exception e)
{
Debug.Print("Exception when calling AccountsApi.VerifyPasswordReset: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| verificationRequest | PasswordResetVerificationRequest | Contains the new password and the verification token to set the new password. |
No authorization required
- 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]
void VerifyUserRegistration (RegistrationVerificationTokenPresentation token)
Verify registration
Verifies a new user registration.
using System;
using System.Diagnostics;
using BlueRain.ID4i.Api;
using BlueRain.ID4i.Client;
using BlueRain.ID4i.Model;
namespace Example
{
public class VerifyUserRegistrationExample
{
public void main()
{
var apiInstance = new AccountsApi();
var token = new RegistrationVerificationTokenPresentation(); // RegistrationVerificationTokenPresentation | The token for user verification.
try
{
// Verify registration
apiInstance.VerifyUserRegistration(token);
}
catch (Exception e)
{
Debug.Print("Exception when calling AccountsApi.VerifyUserRegistration: " + e.Message );
}
}
}
}| Name | Type | Description | Notes |
|---|---|---|---|
| token | RegistrationVerificationTokenPresentation | The token for user verification. |
void (empty response body)
No authorization required
- 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]