Skip to content
This repository was archived by the owner on Apr 14, 2024. It is now read-only.

ObjectUserApi.md

Latest commit

 

History

History
494 lines (337 loc) · 15.2 KB

ObjectUserApi.md

File metadata and controls

494 lines (337 loc) · 15.2 KB
Raw

EZmaxApiDefinitionFull.ObjectUserApi

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
userEditObjectV1 PUT /1/object/user/{pkiUserID} Edit an existing User
userEditPermissionsV1 PUT /1/object/user/{pkiUserID}/editPermissions Edit multiple Permissions
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

userCreateObjectV1

UserCreateObjectV1Response userCreateObjectV1(UserCreateObjectV1Request)

Create a new User

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

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let 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';

let apiInstance = new EZmaxApiDefinitionFull.ObjectUserApi();
let UserCreateObjectV1Request = new EZmaxApiDefinitionFull.UserCreateObjectV1Request(); // UserCreateObjectV1Request | 
apiInstance.userCreateObjectV1(UserCreateObjectV1Request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
UserCreateObjectV1Request UserCreateObjectV1Request

Return type

UserCreateObjectV1Response

Authorization

Authorization

HTTP request headers

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

userEditObjectV1

UserEditObjectV1Response userEditObjectV1(pkiUserID, UserEditObjectV1Request)

Edit an existing User

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let 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';

let apiInstance = new EZmaxApiDefinitionFull.ObjectUserApi();
let pkiUserID = 56; // Number | The unique ID of the User
let UserEditObjectV1Request = new EZmaxApiDefinitionFull.UserEditObjectV1Request(); // UserEditObjectV1Request | 
apiInstance.userEditObjectV1(pkiUserID, UserEditObjectV1Request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

Return type

UserEditObjectV1Response

Authorization

Authorization

HTTP request headers

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

userEditPermissionsV1

UserEditPermissionsV1Response userEditPermissionsV1(pkiUserID, UserEditPermissionsV1Request)

Edit multiple Permissions

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

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let 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';

let apiInstance = new EZmaxApiDefinitionFull.ObjectUserApi();
let pkiUserID = 56; // Number | 
let UserEditPermissionsV1Request = new EZmaxApiDefinitionFull.UserEditPermissionsV1Request(); // UserEditPermissionsV1Request | 
apiInstance.userEditPermissionsV1(pkiUserID, UserEditPermissionsV1Request, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiUserID Number
UserEditPermissionsV1Request UserEditPermissionsV1Request

Return type

UserEditPermissionsV1Response

Authorization

Authorization

HTTP request headers

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

userGetAutocompleteV2

UserGetAutocompleteV2Response userGetAutocompleteV2(sSelector, opts)

Retrieve Users and IDs

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

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let 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';

let apiInstance = new EZmaxApiDefinitionFull.ObjectUserApi();
let sSelector = "sSelector_example"; // String | The type of Users to return
let opts = {
  'eFilterActive': "'Active'", // String | Specify which results we want to display.
  'sQuery': "sQuery_example", // String | Allow to filter the returned results
  'Accept_Language': new EZmaxApiDefinitionFull.HeaderAcceptLanguage() // HeaderAcceptLanguage | 
};
apiInstance.userGetAutocompleteV2(sSelector, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

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]
Accept_Language HeaderAcceptLanguage [optional]

Return type

UserGetAutocompleteV2Response

Authorization

Authorization

HTTP request headers

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

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 EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let 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';

let apiInstance = new EZmaxApiDefinitionFull.ObjectUserApi();
let pkiUserID = 56; // Number | 
apiInstance.userGetEffectivePermissionsV1(pkiUserID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiUserID Number

Return type

UserGetEffectivePermissionsV1Response

Authorization

Authorization

HTTP request headers

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

userGetListV1

UserGetListV1Response userGetListV1(opts)

Retrieve User list

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

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let 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';

let apiInstance = new EZmaxApiDefinitionFull.ObjectUserApi();
let opts = {
  'eOrderBy': "eOrderBy_example", // String | Specify how you want the results to be sorted
  'iRowMax': 10000, // Number | 
  'iRowOffset': 0, // Number | 
  'Accept_Language': new EZmaxApiDefinitionFull.HeaderAcceptLanguage(), // HeaderAcceptLanguage | 
  'sFilter': "sFilter_example" // String | 
};
apiInstance.userGetListV1(opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
eOrderBy String Specify how you want the results to be sorted [optional]
iRowMax Number [optional] [default to 10000]
iRowOffset Number [optional] [default to 0]
Accept_Language 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

userGetObjectV2

UserGetObjectV2Response userGetObjectV2(pkiUserID)

Retrieve an existing User

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let 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';

let apiInstance = new EZmaxApiDefinitionFull.ObjectUserApi();
let pkiUserID = 56; // Number | The unique ID of the User
apiInstance.userGetObjectV2(pkiUserID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

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

Return type

UserGetObjectV2Response

Authorization

Authorization

HTTP request headers

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

userGetPermissionsV1

UserGetPermissionsV1Response userGetPermissionsV1(pkiUserID)

Retrieve an existing User's Permissions

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let 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';

let apiInstance = new EZmaxApiDefinitionFull.ObjectUserApi();
let pkiUserID = 56; // Number | 
apiInstance.userGetPermissionsV1(pkiUserID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiUserID Number

Return type

UserGetPermissionsV1Response

Authorization

Authorization

HTTP request headers

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

userGetSubnetsV1

UserGetSubnetsV1Response userGetSubnetsV1(pkiUserID)

Retrieve an existing User's Subnets

Example

import EZmaxApiDefinitionFull from 'e_zmax_api_definition__full';
let defaultClient = EZmaxApiDefinitionFull.ApiClient.instance;
// Configure API key authorization: Authorization
let 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';

let apiInstance = new EZmaxApiDefinitionFull.ObjectUserApi();
let pkiUserID = 56; // Number | 
apiInstance.userGetSubnetsV1(pkiUserID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});

Parameters

Name Type Description Notes
pkiUserID Number

Return type

UserGetSubnetsV1Response

Authorization

Authorization

HTTP request headers

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