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
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

-(NSURLSessionTask*) userCreateObjectV1WithUserCreateObjectV1Request: (UserCreateObjectV1Request*) userCreateObjectV1Request
        completionHandler: (void (^)(UserCreateObjectV1Response* output, NSError* error)) handler;

Create a new User

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

Example

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"];


UserCreateObjectV1Request* userCreateObjectV1Request = [[UserCreateObjectV1Request alloc] init]; // 

ObjectUserApi*apiInstance = [[ObjectUserApi alloc] init];

// Create a new User
[apiInstance userCreateObjectV1WithUserCreateObjectV1Request:userCreateObjectV1Request
          completionHandler: ^(UserCreateObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectUserApi->userCreateObjectV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
userCreateObjectV1Request	UserCreateObjectV1Request*

Return type

UserCreateObjectV1Response*

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

-(NSURLSessionTask*) userCreateObjectV2WithUserCreateObjectV2Request: (UserCreateObjectV2Request*) userCreateObjectV2Request
        completionHandler: (void (^)(UserCreateObjectV2Response* output, NSError* error)) handler;

Create a new User

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

Example

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"];


UserCreateObjectV2Request* userCreateObjectV2Request = [[UserCreateObjectV2Request alloc] init]; // 

ObjectUserApi*apiInstance = [[ObjectUserApi alloc] init];

// Create a new User
[apiInstance userCreateObjectV2WithUserCreateObjectV2Request:userCreateObjectV2Request
          completionHandler: ^(UserCreateObjectV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectUserApi->userCreateObjectV2: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
userCreateObjectV2Request	UserCreateObjectV2Request*

Return type

UserCreateObjectV2Response*

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

-(NSURLSessionTask*) userEditObjectV1WithPkiUserID: (NSNumber*) pkiUserID
    userEditObjectV1Request: (UserEditObjectV1Request*) userEditObjectV1Request
        completionHandler: (void (^)(UserEditObjectV1Response* output, NSError* error)) handler;

Edit an existing User

Example

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* pkiUserID = @56; // The unique ID of the User
UserEditObjectV1Request* userEditObjectV1Request = [[UserEditObjectV1Request alloc] init]; // 

ObjectUserApi*apiInstance = [[ObjectUserApi alloc] init];

// Edit an existing User
[apiInstance userEditObjectV1WithPkiUserID:pkiUserID
              userEditObjectV1Request:userEditObjectV1Request
          completionHandler: ^(UserEditObjectV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectUserApi->userEditObjectV1: %@", error);
                        }
                    }];

Parameters

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

Return type

UserEditObjectV1Response*

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

-(NSURLSessionTask*) userEditPermissionsV1WithPkiUserID: (NSNumber*) pkiUserID
    userEditPermissionsV1Request: (UserEditPermissionsV1Request*) userEditPermissionsV1Request
        completionHandler: (void (^)(UserEditPermissionsV1Response* output, NSError* error)) handler;

Edit multiple Permissions

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

Example

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* pkiUserID = @56; // 
UserEditPermissionsV1Request* userEditPermissionsV1Request = [[UserEditPermissionsV1Request alloc] init]; // 

ObjectUserApi*apiInstance = [[ObjectUserApi alloc] init];

// Edit multiple Permissions
[apiInstance userEditPermissionsV1WithPkiUserID:pkiUserID
              userEditPermissionsV1Request:userEditPermissionsV1Request
          completionHandler: ^(UserEditPermissionsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectUserApi->userEditPermissionsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiUserID	NSNumber*
userEditPermissionsV1Request	UserEditPermissionsV1Request*

Return type

UserEditPermissionsV1Response*

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

-(NSURLSessionTask*) userGetApikeysV1WithPkiUserID: (NSNumber*) pkiUserID
        completionHandler: (void (^)(UserGetApikeysV1Response* output, NSError* error)) handler;

Retrieve an existing User's Apikeys

Example

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* pkiUserID = @56; // 

ObjectUserApi*apiInstance = [[ObjectUserApi alloc] init];

// Retrieve an existing User's Apikeys
[apiInstance userGetApikeysV1WithPkiUserID:pkiUserID
          completionHandler: ^(UserGetApikeysV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectUserApi->userGetApikeysV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiUserID	NSNumber*

Return type

UserGetApikeysV1Response*

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

-(NSURLSessionTask*) userGetAutocompleteV2WithSSelector: (NSString*) sSelector
    eFilterActive: (NSString*) eFilterActive
    sQuery: (NSString*) sQuery
    acceptLanguage: (HeaderAcceptLanguage) acceptLanguage
        completionHandler: (void (^)(UserGetAutocompleteV2Response* output, NSError* error)) handler;

Retrieve Users and IDs

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

Example

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 Users 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)

ObjectUserApi*apiInstance = [[ObjectUserApi alloc] init];

// Retrieve Users and IDs
[apiInstance userGetAutocompleteV2WithSSelector:sSelector
              eFilterActive:eFilterActive
              sQuery:sQuery
              acceptLanguage:acceptLanguage
          completionHandler: ^(UserGetAutocompleteV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectUserApi->userGetAutocompleteV2: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
sSelector	NSString*	The type of Users 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]

Return type

UserGetAutocompleteV2Response*

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

-(NSURLSessionTask*) userGetEffectivePermissionsV1WithPkiUserID: (NSNumber*) pkiUserID
        completionHandler: (void (^)(UserGetEffectivePermissionsV1Response* output, NSError* error)) handler;

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

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* pkiUserID = @56; // 

ObjectUserApi*apiInstance = [[ObjectUserApi alloc] init];

// Retrieve an existing User's Effective Permissions
[apiInstance userGetEffectivePermissionsV1WithPkiUserID:pkiUserID
          completionHandler: ^(UserGetEffectivePermissionsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectUserApi->userGetEffectivePermissionsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiUserID	NSNumber*

Return type

UserGetEffectivePermissionsV1Response*

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

-(NSURLSessionTask*) userGetListV1WithEOrderBy: (NSString*) eOrderBy
    iRowMax: (NSNumber*) iRowMax
    iRowOffset: (NSNumber*) iRowOffset
    acceptLanguage: (HeaderAcceptLanguage) acceptLanguage
    sFilter: (NSString*) sFilter
        completionHandler: (void (^)(UserGetListV1Response* output, NSError* error)) handler;

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

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)

ObjectUserApi*apiInstance = [[ObjectUserApi alloc] init];

// Retrieve User list
[apiInstance userGetListV1WithEOrderBy:eOrderBy
              iRowMax:iRowMax
              iRowOffset:iRowOffset
              acceptLanguage:acceptLanguage
              sFilter:sFilter
          completionHandler: ^(UserGetListV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectUserApi->userGetListV1: %@", error);
                        }
                    }];

Parameters

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]

Return type

UserGetListV1Response*

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

-(NSURLSessionTask*) userGetObjectV2WithPkiUserID: (NSNumber*) pkiUserID
        completionHandler: (void (^)(UserGetObjectV2Response* output, NSError* error)) handler;

Retrieve an existing User

Example

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* pkiUserID = @56; // The unique ID of the User

ObjectUserApi*apiInstance = [[ObjectUserApi alloc] init];

// Retrieve an existing User
[apiInstance userGetObjectV2WithPkiUserID:pkiUserID
          completionHandler: ^(UserGetObjectV2Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectUserApi->userGetObjectV2: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiUserID	NSNumber*	The unique ID of the User

Return type

UserGetObjectV2Response*

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

-(NSURLSessionTask*) userGetPermissionsV1WithPkiUserID: (NSNumber*) pkiUserID
        completionHandler: (void (^)(UserGetPermissionsV1Response* output, NSError* error)) handler;

Retrieve an existing User's Permissions

Example

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* pkiUserID = @56; // 

ObjectUserApi*apiInstance = [[ObjectUserApi alloc] init];

// Retrieve an existing User's Permissions
[apiInstance userGetPermissionsV1WithPkiUserID:pkiUserID
          completionHandler: ^(UserGetPermissionsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectUserApi->userGetPermissionsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiUserID	NSNumber*

Return type

UserGetPermissionsV1Response*

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

-(NSURLSessionTask*) userGetSubnetsV1WithPkiUserID: (NSNumber*) pkiUserID
        completionHandler: (void (^)(UserGetSubnetsV1Response* output, NSError* error)) handler;

Retrieve an existing User's Subnets

Example

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* pkiUserID = @56; // 

ObjectUserApi*apiInstance = [[ObjectUserApi alloc] init];

// Retrieve an existing User's Subnets
[apiInstance userGetSubnetsV1WithPkiUserID:pkiUserID
          completionHandler: ^(UserGetSubnetsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectUserApi->userGetSubnetsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiUserID	NSNumber*

Return type

UserGetSubnetsV1Response*

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

-(NSURLSessionTask*) userGetUsergroupexternalsV1WithPkiUserID: (NSNumber*) pkiUserID
        completionHandler: (void (^)(UserGetUsergroupexternalsV1Response* output, NSError* error)) handler;

Get User's Usergroupexternals

Example

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* pkiUserID = @56; // 

ObjectUserApi*apiInstance = [[ObjectUserApi alloc] init];

// Get User's Usergroupexternals
[apiInstance userGetUsergroupexternalsV1WithPkiUserID:pkiUserID
          completionHandler: ^(UserGetUsergroupexternalsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectUserApi->userGetUsergroupexternalsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiUserID	NSNumber*

Return type

UserGetUsergroupexternalsV1Response*

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

-(NSURLSessionTask*) userGetUsergroupsV1WithPkiUserID: (NSNumber*) pkiUserID
        completionHandler: (void (^)(UserGetUsergroupsV1Response* output, NSError* error)) handler;

Get User's Usergroups

Example

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* pkiUserID = @56; // 

ObjectUserApi*apiInstance = [[ObjectUserApi alloc] init];

// Get User's Usergroups
[apiInstance userGetUsergroupsV1WithPkiUserID:pkiUserID
          completionHandler: ^(UserGetUsergroupsV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectUserApi->userGetUsergroupsV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiUserID	NSNumber*

Return type

UserGetUsergroupsV1Response*

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

-(NSURLSessionTask*) userSendPasswordResetV1WithPkiUserID: (NSNumber*) pkiUserID
    body: (NSObject*) body
        completionHandler: (void (^)(UserSendPasswordResetV1Response* output, NSError* error)) handler;

Send password reset

Send the password reset email

Example

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* pkiUserID = @56; // 
NSObject* body = NULL; // 

ObjectUserApi*apiInstance = [[ObjectUserApi alloc] init];

// Send password reset
[apiInstance userSendPasswordResetV1WithPkiUserID:pkiUserID
              body:body
          completionHandler: ^(UserSendPasswordResetV1Response* output, NSError* error) {
                        if (output) {
                            NSLog(@"%@", output);
                        }
                        if (error) {
                            NSLog(@"Error calling ObjectUserApi->userSendPasswordResetV1: %@", error);
                        }
                    }];

Parameters

Name	Type	Description	Notes
pkiUserID	NSNumber*
body	NSObject*

Return type

UserSendPasswordResetV1Response*

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]

Files

ObjectUserApi.md

Latest commit

History

ObjectUserApi.md

File metadata and controls

ObjectUserApi

userCreateObjectV1

Example

Parameters

Return type

Authorization

HTTP request headers

userCreateObjectV2

Example

Parameters

Return type

Authorization

HTTP request headers

userEditObjectV1

Example

Parameters

Return type

Authorization

HTTP request headers

userEditPermissionsV1

Example

Parameters

Return type

Authorization

HTTP request headers

userGetApikeysV1

Example

Parameters

Return type

Authorization

HTTP request headers

userGetAutocompleteV2

Example

Parameters

Return type

Authorization

HTTP request headers

userGetEffectivePermissionsV1

Example

Parameters

Return type

Authorization

HTTP request headers

userGetListV1

Example

Parameters

Return type

Authorization

HTTP request headers

userGetObjectV2

Example

Parameters

Return type

Authorization

HTTP request headers

userGetPermissionsV1

Example

Parameters

Return type

Authorization

HTTP request headers

userGetSubnetsV1

Example

Parameters

Return type

Authorization

HTTP request headers

userGetUsergroupexternalsV1

Example

Parameters

Return type

Authorization

HTTP request headers

userGetUsergroupsV1