Skip to content

Latest commit

 

History

History
695 lines (483 loc) · 23.1 KB

ObjectUserApi.md

File metadata and controls

695 lines (483 loc) · 23.1 KB

openapi.api.ObjectUserApi

Load the API package

import 'package:openapi/api.dart';

All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest

Method HTTP request Description
userCreateObjectV1 POST /1/object/user Create a new User
userCreateObjectV2 POST /2/object/user Create a new User
userEditObjectV1 PUT /1/object/user/{pkiUserID} Edit an existing User
userEditPermissionsV1 PUT /1/object/user/{pkiUserID}/editPermissions Edit multiple Permissions
userGetApikeysV1 GET /1/object/user/{pkiUserID}/getApikeys Retrieve an existing User's Apikeys
userGetAutocompleteV2 GET /2/object/user/getAutocomplete/{sSelector} Retrieve Users and IDs
userGetEffectivePermissionsV1 GET /1/object/user/{pkiUserID}/getEffectivePermissions Retrieve an existing User's Effective Permissions
userGetListV1 GET /1/object/user/getList Retrieve User list
userGetObjectV2 GET /2/object/user/{pkiUserID} Retrieve an existing User
userGetPermissionsV1 GET /1/object/user/{pkiUserID}/getPermissions Retrieve an existing User's Permissions
userGetSubnetsV1 GET /1/object/user/{pkiUserID}/getSubnets Retrieve an existing User's Subnets
userGetUsergroupexternalsV1 GET /1/object/user/{pkiUserID}/getUsergroupexternals Get User's Usergroupexternals
userGetUsergroupsV1 GET /1/object/user/{pkiUserID}/getUsergroups Get User's Usergroups
userSendPasswordResetV1 POST /1/object/user/{pkiUserID}/sendPasswordReset Send password reset

userCreateObjectV1

UserCreateObjectV1Response userCreateObjectV1(userCreateObjectV1Request)

Create a new User

The endpoint allows to create one or many elements at once.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectUserApi();
final userCreateObjectV1Request = UserCreateObjectV1Request(); // UserCreateObjectV1Request | 

try {
    final result = api_instance.userCreateObjectV1(userCreateObjectV1Request);
    print(result);
} catch (e) {
    print('Exception when calling ObjectUserApi->userCreateObjectV1: $e\n');
}

Parameters

Name Type Description Notes
userCreateObjectV1Request UserCreateObjectV1Request

Return type

UserCreateObjectV1Response

Authorization

Authorization

HTTP request headers

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

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

userCreateObjectV2

UserCreateObjectV2Response userCreateObjectV2(userCreateObjectV2Request)

Create a new User

The endpoint allows to create one or many elements at once.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectUserApi();
final userCreateObjectV2Request = UserCreateObjectV2Request(); // UserCreateObjectV2Request | 

try {
    final result = api_instance.userCreateObjectV2(userCreateObjectV2Request);
    print(result);
} catch (e) {
    print('Exception when calling ObjectUserApi->userCreateObjectV2: $e\n');
}

Parameters

Name Type Description Notes
userCreateObjectV2Request UserCreateObjectV2Request

Return type

UserCreateObjectV2Response

Authorization

Authorization

HTTP request headers

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

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

userEditObjectV1

UserEditObjectV1Response userEditObjectV1(pkiUserID, userEditObjectV1Request)

Edit an existing User

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectUserApi();
final pkiUserID = 56; // int | The unique ID of the User
final userEditObjectV1Request = UserEditObjectV1Request(); // UserEditObjectV1Request | 

try {
    final result = api_instance.userEditObjectV1(pkiUserID, userEditObjectV1Request);
    print(result);
} catch (e) {
    print('Exception when calling ObjectUserApi->userEditObjectV1: $e\n');
}

Parameters

Name Type Description Notes
pkiUserID int The unique ID of the User
userEditObjectV1Request UserEditObjectV1Request

Return type

UserEditObjectV1Response

Authorization

Authorization

HTTP request headers

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

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

userEditPermissionsV1

UserEditPermissionsV1Response userEditPermissionsV1(pkiUserID, userEditPermissionsV1Request)

Edit multiple Permissions

Using this endpoint, you can edit multiple Permissions at the same time.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectUserApi();
final pkiUserID = 56; // int | 
final userEditPermissionsV1Request = UserEditPermissionsV1Request(); // UserEditPermissionsV1Request | 

try {
    final result = api_instance.userEditPermissionsV1(pkiUserID, userEditPermissionsV1Request);
    print(result);
} catch (e) {
    print('Exception when calling ObjectUserApi->userEditPermissionsV1: $e\n');
}

Parameters

Name Type Description Notes
pkiUserID int
userEditPermissionsV1Request UserEditPermissionsV1Request

Return type

UserEditPermissionsV1Response

Authorization

Authorization

HTTP request headers

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

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

userGetApikeysV1

UserGetApikeysV1Response userGetApikeysV1(pkiUserID)

Retrieve an existing User's Apikeys

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectUserApi();
final pkiUserID = 56; // int | 

try {
    final result = api_instance.userGetApikeysV1(pkiUserID);
    print(result);
} catch (e) {
    print('Exception when calling ObjectUserApi->userGetApikeysV1: $e\n');
}

Parameters

Name Type Description Notes
pkiUserID int

Return type

UserGetApikeysV1Response

Authorization

Authorization

HTTP request headers

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

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

userGetAutocompleteV2

UserGetAutocompleteV2Response userGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage)

Retrieve Users and IDs

Get the list of User to be used in a dropdown or autocomplete control.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectUserApi();
final sSelector = sSelector_example; // String | The type of Users to return
final eFilterActive = eFilterActive_example; // String | Specify which results we want to display.
final sQuery = sQuery_example; // String | Allow to filter the returned results
final acceptLanguage = ; // HeaderAcceptLanguage | 

try {
    final result = api_instance.userGetAutocompleteV2(sSelector, eFilterActive, sQuery, acceptLanguage);
    print(result);
} catch (e) {
    print('Exception when calling ObjectUserApi->userGetAutocompleteV2: $e\n');
}

Parameters

Name Type Description Notes
sSelector String The type of Users to return
eFilterActive String Specify which results we want to display. [optional] [default to 'Active']
sQuery String Allow to filter the returned results [optional]
acceptLanguage HeaderAcceptLanguage [optional]

Return type

UserGetAutocompleteV2Response

Authorization

Authorization

HTTP request headers

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

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

userGetEffectivePermissionsV1

UserGetEffectivePermissionsV1Response userGetEffectivePermissionsV1(pkiUserID)

Retrieve an existing User's Effective Permissions

Effective Permissions refers to the combination of Permissions held by a User and the Permissions associated with the Usergroups they belong to.

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectUserApi();
final pkiUserID = 56; // int | 

try {
    final result = api_instance.userGetEffectivePermissionsV1(pkiUserID);
    print(result);
} catch (e) {
    print('Exception when calling ObjectUserApi->userGetEffectivePermissionsV1: $e\n');
}

Parameters

Name Type Description Notes
pkiUserID int

Return type

UserGetEffectivePermissionsV1Response

Authorization

Authorization

HTTP request headers

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

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

userGetListV1

UserGetListV1Response userGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter)

Retrieve User list

Enum values that can be filtered in query parameter sFilter: | Variable | Valid values | |---|---| | eUserType | AgentBroker
Assistant
Employee
EzsignUser
Normal | | eUserOrigin | BuiltIn
External | | eUserEzsignaccess | No
PaidByOffice
PerDocument
Prepaid |

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectUserApi();
final eOrderBy = eOrderBy_example; // String | Specify how you want the results to be sorted
final iRowMax = 56; // int | 
final iRowOffset = 56; // int | 
final acceptLanguage = ; // HeaderAcceptLanguage | 
final sFilter = sFilter_example; // String | 

try {
    final result = api_instance.userGetListV1(eOrderBy, iRowMax, iRowOffset, acceptLanguage, sFilter);
    print(result);
} catch (e) {
    print('Exception when calling ObjectUserApi->userGetListV1: $e\n');
}

Parameters

Name Type Description Notes
eOrderBy String Specify how you want the results to be sorted [optional]
iRowMax int [optional]
iRowOffset int [optional] [default to 0]
acceptLanguage HeaderAcceptLanguage [optional]
sFilter String [optional]

Return type

UserGetListV1Response

Authorization

Authorization

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

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

userGetObjectV2

UserGetObjectV2Response userGetObjectV2(pkiUserID)

Retrieve an existing User

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectUserApi();
final pkiUserID = 56; // int | The unique ID of the User

try {
    final result = api_instance.userGetObjectV2(pkiUserID);
    print(result);
} catch (e) {
    print('Exception when calling ObjectUserApi->userGetObjectV2: $e\n');
}

Parameters

Name Type Description Notes
pkiUserID int The unique ID of the User

Return type

UserGetObjectV2Response

Authorization

Authorization

HTTP request headers

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

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

userGetPermissionsV1

UserGetPermissionsV1Response userGetPermissionsV1(pkiUserID)

Retrieve an existing User's Permissions

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectUserApi();
final pkiUserID = 56; // int | 

try {
    final result = api_instance.userGetPermissionsV1(pkiUserID);
    print(result);
} catch (e) {
    print('Exception when calling ObjectUserApi->userGetPermissionsV1: $e\n');
}

Parameters

Name Type Description Notes
pkiUserID int

Return type

UserGetPermissionsV1Response

Authorization

Authorization

HTTP request headers

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

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

userGetSubnetsV1

UserGetSubnetsV1Response userGetSubnetsV1(pkiUserID)

Retrieve an existing User's Subnets

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectUserApi();
final pkiUserID = 56; // int | 

try {
    final result = api_instance.userGetSubnetsV1(pkiUserID);
    print(result);
} catch (e) {
    print('Exception when calling ObjectUserApi->userGetSubnetsV1: $e\n');
}

Parameters

Name Type Description Notes
pkiUserID int

Return type

UserGetSubnetsV1Response

Authorization

Authorization

HTTP request headers

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

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

userGetUsergroupexternalsV1

UserGetUsergroupexternalsV1Response userGetUsergroupexternalsV1(pkiUserID)

Get User's Usergroupexternals

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectUserApi();
final pkiUserID = 56; // int | 

try {
    final result = api_instance.userGetUsergroupexternalsV1(pkiUserID);
    print(result);
} catch (e) {
    print('Exception when calling ObjectUserApi->userGetUsergroupexternalsV1: $e\n');
}

Parameters

Name Type Description Notes
pkiUserID int

Return type

UserGetUsergroupexternalsV1Response

Authorization

Authorization

HTTP request headers

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

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

userGetUsergroupsV1

UserGetUsergroupsV1Response userGetUsergroupsV1(pkiUserID)

Get User's Usergroups

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectUserApi();
final pkiUserID = 56; // int | 

try {
    final result = api_instance.userGetUsergroupsV1(pkiUserID);
    print(result);
} catch (e) {
    print('Exception when calling ObjectUserApi->userGetUsergroupsV1: $e\n');
}

Parameters

Name Type Description Notes
pkiUserID int

Return type

UserGetUsergroupsV1Response

Authorization

Authorization

HTTP request headers

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

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

userSendPasswordResetV1

UserSendPasswordResetV1Response userSendPasswordResetV1(pkiUserID, body)

Send password reset

Send the password reset email

Example

import 'package:openapi/api.dart';
// TODO Configure API key authorization: Authorization
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('Authorization').apiKeyPrefix = 'Bearer';

final api_instance = ObjectUserApi();
final pkiUserID = 56; // int | 
final body = Object(); // Object | 

try {
    final result = api_instance.userSendPasswordResetV1(pkiUserID, body);
    print(result);
} catch (e) {
    print('Exception when calling ObjectUserApi->userSendPasswordResetV1: $e\n');
}

Parameters

Name Type Description Notes
pkiUserID int
body Object

Return type

UserSendPasswordResetV1Response

Authorization

Authorization

HTTP request headers

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

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