All URIs are relative to https://prod.api.appcluster01.ca-central-1.ezmax.com/rest
Method | HTTP request | Description |
---|---|---|
usergroupCreateObjectV1 | POST /1/object/usergroup | Create a new Usergroup |
usergroupEditObjectV1 | PUT /1/object/usergroup/{pkiUsergroupID} | Edit an existing Usergroup |
usergroupEditPermissionsV1 | PUT /1/object/usergroup/{pkiUsergroupID}/editPermissions | Edit multiple Permissions |
usergroupEditUsergroupdelegationsV1 | PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupdelegations | Edit multiple Usergroupdelegations |
usergroupEditUsergroupmembershipsV1 | PUT /1/object/usergroup/{pkiUsergroupID}/editUsergroupmemberships | Edit multiple Usergroupmemberships |
usergroupGetAutocompleteV2 | GET /2/object/usergroup/getAutocomplete/{sSelector} | Retrieve Usergroups and IDs |
usergroupGetListV1 | GET /1/object/usergroup/getList | Retrieve Usergroup list |
usergroupGetObjectV2 | GET /2/object/usergroup/{pkiUsergroupID} | Retrieve an existing Usergroup |
usergroupGetPermissionsV1 | GET /1/object/usergroup/{pkiUsergroupID}/getPermissions | Retrieve an existing Usergroup's Permissions |
usergroupGetUsergroupdelegationsV1 | GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupdelegations | Retrieve an existing Usergroup's Usergroupdelegations |
usergroupGetUsergroupmembershipsV1 | GET /1/object/usergroup/{pkiUsergroupID}/getUsergroupmemberships | Retrieve an existing Usergroup's Usergroupmemberships |
-(NSURLSessionTask*) usergroupCreateObjectV1WithUsergroupCreateObjectV1Request: (UsergroupCreateObjectV1Request*) usergroupCreateObjectV1Request
completionHandler: (void (^)(UsergroupCreateObjectV1Response* output, NSError* error)) handler;
Create a new Usergroup
The endpoint allows to create one or many elements at once.
DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];
// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
UsergroupCreateObjectV1Request* usergroupCreateObjectV1Request = [[UsergroupCreateObjectV1Request alloc] init]; //
ObjectUsergroupApi*apiInstance = [[ObjectUsergroupApi alloc] init];
// Create a new Usergroup
[apiInstance usergroupCreateObjectV1WithUsergroupCreateObjectV1Request:usergroupCreateObjectV1Request
completionHandler: ^(UsergroupCreateObjectV1Response* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling ObjectUsergroupApi->usergroupCreateObjectV1: %@", error);
}
}];
Name | Type | Description | Notes |
---|---|---|---|
usergroupCreateObjectV1Request | UsergroupCreateObjectV1Request* |
UsergroupCreateObjectV1Response*
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
-(NSURLSessionTask*) usergroupEditObjectV1WithPkiUsergroupID: (NSNumber*) pkiUsergroupID
usergroupEditObjectV1Request: (UsergroupEditObjectV1Request*) usergroupEditObjectV1Request
completionHandler: (void (^)(UsergroupEditObjectV1Response* output, NSError* error)) handler;
Edit an existing Usergroup
DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];
// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
NSNumber* pkiUsergroupID = @56; //
UsergroupEditObjectV1Request* usergroupEditObjectV1Request = [[UsergroupEditObjectV1Request alloc] init]; //
ObjectUsergroupApi*apiInstance = [[ObjectUsergroupApi alloc] init];
// Edit an existing Usergroup
[apiInstance usergroupEditObjectV1WithPkiUsergroupID:pkiUsergroupID
usergroupEditObjectV1Request:usergroupEditObjectV1Request
completionHandler: ^(UsergroupEditObjectV1Response* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling ObjectUsergroupApi->usergroupEditObjectV1: %@", error);
}
}];
Name | Type | Description | Notes |
---|---|---|---|
pkiUsergroupID | NSNumber* | ||
usergroupEditObjectV1Request | UsergroupEditObjectV1Request* |
UsergroupEditObjectV1Response*
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
-(NSURLSessionTask*) usergroupEditPermissionsV1WithPkiUsergroupID: (NSNumber*) pkiUsergroupID
usergroupEditPermissionsV1Request: (UsergroupEditPermissionsV1Request*) usergroupEditPermissionsV1Request
completionHandler: (void (^)(UsergroupEditPermissionsV1Response* output, NSError* error)) handler;
Edit multiple Permissions
Using this endpoint, you can edit multiple Permissions at the same time.
DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];
// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
NSNumber* pkiUsergroupID = @56; //
UsergroupEditPermissionsV1Request* usergroupEditPermissionsV1Request = [[UsergroupEditPermissionsV1Request alloc] init]; //
ObjectUsergroupApi*apiInstance = [[ObjectUsergroupApi alloc] init];
// Edit multiple Permissions
[apiInstance usergroupEditPermissionsV1WithPkiUsergroupID:pkiUsergroupID
usergroupEditPermissionsV1Request:usergroupEditPermissionsV1Request
completionHandler: ^(UsergroupEditPermissionsV1Response* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling ObjectUsergroupApi->usergroupEditPermissionsV1: %@", error);
}
}];
Name | Type | Description | Notes |
---|---|---|---|
pkiUsergroupID | NSNumber* | ||
usergroupEditPermissionsV1Request | UsergroupEditPermissionsV1Request* |
UsergroupEditPermissionsV1Response*
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
-(NSURLSessionTask*) usergroupEditUsergroupdelegationsV1WithPkiUsergroupID: (NSNumber*) pkiUsergroupID
usergroupEditUsergroupdelegationsV1Request: (UsergroupEditUsergroupdelegationsV1Request*) usergroupEditUsergroupdelegationsV1Request
completionHandler: (void (^)(UsergroupEditUsergroupdelegationsV1Response* output, NSError* error)) handler;
Edit multiple Usergroupdelegations
Edit multiple Usergroupdelegations
DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];
// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
NSNumber* pkiUsergroupID = @56; //
UsergroupEditUsergroupdelegationsV1Request* usergroupEditUsergroupdelegationsV1Request = [[UsergroupEditUsergroupdelegationsV1Request alloc] init]; //
ObjectUsergroupApi*apiInstance = [[ObjectUsergroupApi alloc] init];
// Edit multiple Usergroupdelegations
[apiInstance usergroupEditUsergroupdelegationsV1WithPkiUsergroupID:pkiUsergroupID
usergroupEditUsergroupdelegationsV1Request:usergroupEditUsergroupdelegationsV1Request
completionHandler: ^(UsergroupEditUsergroupdelegationsV1Response* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling ObjectUsergroupApi->usergroupEditUsergroupdelegationsV1: %@", error);
}
}];
Name | Type | Description | Notes |
---|---|---|---|
pkiUsergroupID | NSNumber* | ||
usergroupEditUsergroupdelegationsV1Request | UsergroupEditUsergroupdelegationsV1Request* |
UsergroupEditUsergroupdelegationsV1Response*
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
-(NSURLSessionTask*) usergroupEditUsergroupmembershipsV1WithPkiUsergroupID: (NSNumber*) pkiUsergroupID
usergroupEditUsergroupmembershipsV1Request: (UsergroupEditUsergroupmembershipsV1Request*) usergroupEditUsergroupmembershipsV1Request
completionHandler: (void (^)(UsergroupEditUsergroupmembershipsV1Response* output, NSError* error)) handler;
Edit multiple Usergroupmemberships
Using this endpoint, you can edit multiple Usergroupmemberships at the same time.
DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];
// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
NSNumber* pkiUsergroupID = @56; //
UsergroupEditUsergroupmembershipsV1Request* usergroupEditUsergroupmembershipsV1Request = [[UsergroupEditUsergroupmembershipsV1Request alloc] init]; //
ObjectUsergroupApi*apiInstance = [[ObjectUsergroupApi alloc] init];
// Edit multiple Usergroupmemberships
[apiInstance usergroupEditUsergroupmembershipsV1WithPkiUsergroupID:pkiUsergroupID
usergroupEditUsergroupmembershipsV1Request:usergroupEditUsergroupmembershipsV1Request
completionHandler: ^(UsergroupEditUsergroupmembershipsV1Response* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling ObjectUsergroupApi->usergroupEditUsergroupmembershipsV1: %@", error);
}
}];
Name | Type | Description | Notes |
---|---|---|---|
pkiUsergroupID | NSNumber* | ||
usergroupEditUsergroupmembershipsV1Request | UsergroupEditUsergroupmembershipsV1Request* |
UsergroupEditUsergroupmembershipsV1Response*
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
-(NSURLSessionTask*) usergroupGetAutocompleteV2WithSSelector: (NSString*) sSelector
eFilterActive: (NSString*) eFilterActive
sQuery: (NSString*) sQuery
acceptLanguage: (HeaderAcceptLanguage) acceptLanguage
completionHandler: (void (^)(UsergroupGetAutocompleteV2Response* output, NSError* error)) handler;
Retrieve Usergroups and IDs
Get the list of Usergroup to be used in a dropdown or autocomplete control.
DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];
// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
NSString* sSelector = @"sSelector_example"; // The type of Usergroups to return
NSString* eFilterActive = @"Active"; // Specify which results we want to display. (optional) (default to @"Active")
NSString* sQuery = @"sQuery_example"; // Allow to filter the returned results (optional)
HeaderAcceptLanguage acceptLanguage = [[HeaderAcceptLanguage alloc] init]; // (optional)
ObjectUsergroupApi*apiInstance = [[ObjectUsergroupApi alloc] init];
// Retrieve Usergroups and IDs
[apiInstance usergroupGetAutocompleteV2WithSSelector:sSelector
eFilterActive:eFilterActive
sQuery:sQuery
acceptLanguage:acceptLanguage
completionHandler: ^(UsergroupGetAutocompleteV2Response* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling ObjectUsergroupApi->usergroupGetAutocompleteV2: %@", error);
}
}];
Name | Type | Description | Notes |
---|---|---|---|
sSelector | NSString* | The type of Usergroups to return | |
eFilterActive | NSString* | Specify which results we want to display. | [optional] [default to @"Active"] |
sQuery | NSString* | Allow to filter the returned results | [optional] |
acceptLanguage | HeaderAcceptLanguage | [optional] |
UsergroupGetAutocompleteV2Response*
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
-(NSURLSessionTask*) usergroupGetListV1WithEOrderBy: (NSString*) eOrderBy
iRowMax: (NSNumber*) iRowMax
iRowOffset: (NSNumber*) iRowOffset
acceptLanguage: (HeaderAcceptLanguage) acceptLanguage
sFilter: (NSString*) sFilter
completionHandler: (void (^)(UsergroupGetListV1Response* output, NSError* error)) handler;
Retrieve Usergroup list
DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];
// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
NSString* eOrderBy = @"eOrderBy_example"; // Specify how you want the results to be sorted (optional)
NSNumber* iRowMax = @56; // (optional)
NSNumber* iRowOffset = @0; // (optional) (default to @0)
HeaderAcceptLanguage acceptLanguage = [[HeaderAcceptLanguage alloc] init]; // (optional)
NSString* sFilter = @"sFilter_example"; // (optional)
ObjectUsergroupApi*apiInstance = [[ObjectUsergroupApi alloc] init];
// Retrieve Usergroup list
[apiInstance usergroupGetListV1WithEOrderBy:eOrderBy
iRowMax:iRowMax
iRowOffset:iRowOffset
acceptLanguage:acceptLanguage
sFilter:sFilter
completionHandler: ^(UsergroupGetListV1Response* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling ObjectUsergroupApi->usergroupGetListV1: %@", error);
}
}];
Name | Type | Description | Notes |
---|---|---|---|
eOrderBy | NSString* | Specify how you want the results to be sorted | [optional] |
iRowMax | NSNumber* | [optional] | |
iRowOffset | NSNumber* | [optional] [default to @0] | |
acceptLanguage | HeaderAcceptLanguage | [optional] | |
sFilter | NSString* | [optional] |
- 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]
-(NSURLSessionTask*) usergroupGetObjectV2WithPkiUsergroupID: (NSNumber*) pkiUsergroupID
completionHandler: (void (^)(UsergroupGetObjectV2Response* output, NSError* error)) handler;
Retrieve an existing Usergroup
DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];
// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
NSNumber* pkiUsergroupID = @56; //
ObjectUsergroupApi*apiInstance = [[ObjectUsergroupApi alloc] init];
// Retrieve an existing Usergroup
[apiInstance usergroupGetObjectV2WithPkiUsergroupID:pkiUsergroupID
completionHandler: ^(UsergroupGetObjectV2Response* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling ObjectUsergroupApi->usergroupGetObjectV2: %@", error);
}
}];
Name | Type | Description | Notes |
---|---|---|---|
pkiUsergroupID | NSNumber* |
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
-(NSURLSessionTask*) usergroupGetPermissionsV1WithPkiUsergroupID: (NSNumber*) pkiUsergroupID
completionHandler: (void (^)(UsergroupGetPermissionsV1Response* output, NSError* error)) handler;
Retrieve an existing Usergroup's Permissions
DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];
// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
NSNumber* pkiUsergroupID = @56; //
ObjectUsergroupApi*apiInstance = [[ObjectUsergroupApi alloc] init];
// Retrieve an existing Usergroup's Permissions
[apiInstance usergroupGetPermissionsV1WithPkiUsergroupID:pkiUsergroupID
completionHandler: ^(UsergroupGetPermissionsV1Response* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling ObjectUsergroupApi->usergroupGetPermissionsV1: %@", error);
}
}];
Name | Type | Description | Notes |
---|---|---|---|
pkiUsergroupID | NSNumber* |
UsergroupGetPermissionsV1Response*
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
-(NSURLSessionTask*) usergroupGetUsergroupdelegationsV1WithPkiUsergroupID: (NSNumber*) pkiUsergroupID
completionHandler: (void (^)(UsergroupGetUsergroupdelegationsV1Response* output, NSError* error)) handler;
Retrieve an existing Usergroup's Usergroupdelegations
DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];
// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
NSNumber* pkiUsergroupID = @56; //
ObjectUsergroupApi*apiInstance = [[ObjectUsergroupApi alloc] init];
// Retrieve an existing Usergroup's Usergroupdelegations
[apiInstance usergroupGetUsergroupdelegationsV1WithPkiUsergroupID:pkiUsergroupID
completionHandler: ^(UsergroupGetUsergroupdelegationsV1Response* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling ObjectUsergroupApi->usergroupGetUsergroupdelegationsV1: %@", error);
}
}];
Name | Type | Description | Notes |
---|---|---|---|
pkiUsergroupID | NSNumber* |
UsergroupGetUsergroupdelegationsV1Response*
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
-(NSURLSessionTask*) usergroupGetUsergroupmembershipsV1WithPkiUsergroupID: (NSNumber*) pkiUsergroupID
completionHandler: (void (^)(UsergroupGetUsergroupmembershipsV1Response* output, NSError* error)) handler;
Retrieve an existing Usergroup's Usergroupmemberships
DefaultConfiguration *apiConfig = [DefaultConfiguration sharedConfig];
// Configure API key authorization: (authentication scheme: Authorization)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"Authorization"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"Authorization"];
NSNumber* pkiUsergroupID = @56; //
ObjectUsergroupApi*apiInstance = [[ObjectUsergroupApi alloc] init];
// Retrieve an existing Usergroup's Usergroupmemberships
[apiInstance usergroupGetUsergroupmembershipsV1WithPkiUsergroupID:pkiUsergroupID
completionHandler: ^(UsergroupGetUsergroupmembershipsV1Response* output, NSError* error) {
if (output) {
NSLog(@"%@", output);
}
if (error) {
NSLog(@"Error calling ObjectUsergroupApi->usergroupGetUsergroupmembershipsV1: %@", error);
}
}];
Name | Type | Description | Notes |
---|---|---|---|
pkiUsergroupID | NSNumber* |
UsergroupGetUsergroupmembershipsV1Response*
- Content-Type: Not defined
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]