Objective-C / DocuSign REST API / Adds news user to the specified account.
Back to Collection Items
#import <CkoHttp.h>
#import <CkoJsonObject.h>
#import <CkoHttpResponse.h>
// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.
CkoHttp *http = [[CkoHttp alloc] init];
BOOL success;
// Use this online tool to generate code from sample JSON: Generate Code to Create JSON
// The following JSON is sent in the request body.
// {
// "newUsers": [
// {
// "userName": "sample string 1",
// "userId": "sample string 2",
// "userType": "sample string 3",
// "isAdmin": "sample string 4",
// "userStatus": "sample string 5",
// "uri": "sample string 6",
// "email": "sample string 7",
// "password": "sample string 8",
// "title": "sample string 9",
// "createdDateTime": "sample string 10",
// "firstName": "sample string 11",
// "middleName": "sample string 12",
// "lastName": "sample string 13",
// "suffixName": "sample string 14",
// "permissionProfileId": "sample string 15",
// "permissionProfileName": "sample string 16",
// "countryCode": "sample string 17",
// "subscribe": "sample string 18",
// "userSettings": [
// {}
// ],
// "accountManagementGranular": {
// "canManageUsers": "sample string 1",
// "canManageAdmins": "sample string 2",
// "canManageGroups": "sample string 3",
// "canManageSharing": "sample string 4",
// "canManageEnvelopeTransfer": "sample string 5",
// "canManageAccountSettings": "sample string 6",
// "canManageReporting": "sample string 7",
// "canManageAccountSecuritySettings": "sample string 8",
// "canManageSigningGroups": "sample string 9",
// "canManageDocumentRetention": "sample string 10",
// "canViewUsers": "sample string 11",
// "canManageUsersMetadata": {
// "rights": "sample string 1",
// "uiHint": "sample string 2",
// "uiType": "sample string 3",
// "uiOrder": "sample string 4",
// "is21CFRPart11": "sample string 5",
// "options": [
// "sample string 1"
// ]
// },
// "canManageAdminsMetadata": {},
// "canManageGroupsMetadata": {},
// "canManageSharingMetadata": {},
// "canManageEnvelopeTransferMetadata": {},
// "canManageAccountSettingsMetadata": {},
// "canManageReportingMetadata": {},
// "canManageAccountSecuritySettingsMetadata": {},
// "canManageSigningGroupsMetadata": {},
// "canManageDocumentRetentionMetadata": {},
// "canViewUsersMetadata": {}
// },
// "sendActivationOnInvalidLogin": "sample string 19",
// "activationAccessCode": "sample string 20",
// "enableConnectForUser": "sample string 21",
// "forgottenPasswordInfo": {
// "forgottenPasswordQuestion1": "sample string 1",
// "forgottenPasswordAnswer1": "sample string 2",
// "forgottenPasswordQuestion2": "sample string 3",
// "forgottenPasswordAnswer2": "sample string 4",
// "forgottenPasswordQuestion3": "sample string 5",
// "forgottenPasswordAnswer3": "sample string 6",
// "forgottenPasswordQuestion4": "sample string 7",
// "forgottenPasswordAnswer4": "sample string 8"
// },
// "groupList": [
// {
// "groupId": "sample string 1",
// "groupName": "sample string 2",
// "permissionProfileId": "sample string 3",
// "groupType": "sample string 4",
// "users": [
// {
// "userName": "sample string 1",
// "userId": "sample string 2",
// "email": "sample string 3",
// "userType": "sample string 4",
// "userStatus": "sample string 5",
// "uri": "sample string 6",
// "loginStatus": "sample string 7",
// "sendActivationEmail": "sample string 8",
// "activationAccessCode": "sample string 9"
// }
// ]
// }
// ],
// "workAddress": {
// "address1": "sample string 1",
// "address2": "sample string 2",
// "city": "sample string 3",
// "stateOrProvince": "sample string 4",
// "postalCode": "sample string 5",
// "phone": "sample string 6",
// "fax": "sample string 7",
// "country": "sample string 8"
// },
// "homeAddress": {},
// "loginStatus": "sample string 22",
// "passwordExpiration": "sample string 23",
// "lastLogin": "sample string 24",
// "sendActivationEmail": "sample string 25",
// "customSettings": [
// {}
// ],
// "profileImageUri": "sample string 26",
// "userProfileLastModifiedDate": "sample string 27",
// "signatureImageUri": "sample string 28",
// "initialsImageUri": "sample string 29",
// "jobTitle": "sample string 30"
// }
// ]
// }
CkoJsonObject *json = [[CkoJsonObject alloc] init];
[json UpdateString: @"newUsers[0].userName" value: @"sample string 1"];
[json UpdateString: @"newUsers[0].userId" value: @"sample string 2"];
[json UpdateString: @"newUsers[0].userType" value: @"sample string 3"];
[json UpdateString: @"newUsers[0].isAdmin" value: @"sample string 4"];
[json UpdateString: @"newUsers[0].userStatus" value: @"sample string 5"];
[json UpdateString: @"newUsers[0].uri" value: @"sample string 6"];
[json UpdateString: @"newUsers[0].email" value: @"sample string 7"];
[json UpdateString: @"newUsers[0].password" value: @"sample string 8"];
[json UpdateString: @"newUsers[0].title" value: @"sample string 9"];
[json UpdateString: @"newUsers[0].createdDateTime" value: @"sample string 10"];
[json UpdateString: @"newUsers[0].firstName" value: @"sample string 11"];
[json UpdateString: @"newUsers[0].middleName" value: @"sample string 12"];
[json UpdateString: @"newUsers[0].lastName" value: @"sample string 13"];
[json UpdateString: @"newUsers[0].suffixName" value: @"sample string 14"];
[json UpdateString: @"newUsers[0].permissionProfileId" value: @"sample string 15"];
[json UpdateString: @"newUsers[0].permissionProfileName" value: @"sample string 16"];
[json UpdateString: @"newUsers[0].countryCode" value: @"sample string 17"];
[json UpdateString: @"newUsers[0].subscribe" value: @"sample string 18"];
[json UpdateString: @"newUsers[0].accountManagementGranular.canManageUsers" value: @"sample string 1"];
[json UpdateString: @"newUsers[0].accountManagementGranular.canManageAdmins" value: @"sample string 2"];
[json UpdateString: @"newUsers[0].accountManagementGranular.canManageGroups" value: @"sample string 3"];
[json UpdateString: @"newUsers[0].accountManagementGranular.canManageSharing" value: @"sample string 4"];
[json UpdateString: @"newUsers[0].accountManagementGranular.canManageEnvelopeTransfer" value: @"sample string 5"];
[json UpdateString: @"newUsers[0].accountManagementGranular.canManageAccountSettings" value: @"sample string 6"];
[json UpdateString: @"newUsers[0].accountManagementGranular.canManageReporting" value: @"sample string 7"];
[json UpdateString: @"newUsers[0].accountManagementGranular.canManageAccountSecuritySettings" value: @"sample string 8"];
[json UpdateString: @"newUsers[0].accountManagementGranular.canManageSigningGroups" value: @"sample string 9"];
[json UpdateString: @"newUsers[0].accountManagementGranular.canManageDocumentRetention" value: @"sample string 10"];
[json UpdateString: @"newUsers[0].accountManagementGranular.canViewUsers" value: @"sample string 11"];
[json UpdateString: @"newUsers[0].accountManagementGranular.canManageUsersMetadata.rights" value: @"sample string 1"];
[json UpdateString: @"newUsers[0].accountManagementGranular.canManageUsersMetadata.uiHint" value: @"sample string 2"];
[json UpdateString: @"newUsers[0].accountManagementGranular.canManageUsersMetadata.uiType" value: @"sample string 3"];
[json UpdateString: @"newUsers[0].accountManagementGranular.canManageUsersMetadata.uiOrder" value: @"sample string 4"];
[json UpdateString: @"newUsers[0].accountManagementGranular.canManageUsersMetadata.is21CFRPart11" value: @"sample string 5"];
[json UpdateString: @"newUsers[0].accountManagementGranular.canManageUsersMetadata.options[0]" value: @"sample string 1"];
[json UpdateNewObject: @"newUsers[0].accountManagementGranular.canManageAdminsMetadata"];
[json UpdateNewObject: @"newUsers[0].accountManagementGranular.canManageGroupsMetadata"];
[json UpdateNewObject: @"newUsers[0].accountManagementGranular.canManageSharingMetadata"];
[json UpdateNewObject: @"newUsers[0].accountManagementGranular.canManageEnvelopeTransferMetadata"];
[json UpdateNewObject: @"newUsers[0].accountManagementGranular.canManageAccountSettingsMetadata"];
[json UpdateNewObject: @"newUsers[0].accountManagementGranular.canManageReportingMetadata"];
[json UpdateNewObject: @"newUsers[0].accountManagementGranular.canManageAccountSecuritySettingsMetadata"];
[json UpdateNewObject: @"newUsers[0].accountManagementGranular.canManageSigningGroupsMetadata"];
[json UpdateNewObject: @"newUsers[0].accountManagementGranular.canManageDocumentRetentionMetadata"];
[json UpdateNewObject: @"newUsers[0].accountManagementGranular.canViewUsersMetadata"];
[json UpdateString: @"newUsers[0].sendActivationOnInvalidLogin" value: @"sample string 19"];
[json UpdateString: @"newUsers[0].activationAccessCode" value: @"sample string 20"];
[json UpdateString: @"newUsers[0].enableConnectForUser" value: @"sample string 21"];
[json UpdateString: @"newUsers[0].forgottenPasswordInfo.forgottenPasswordQuestion1" value: @"sample string 1"];
[json UpdateString: @"newUsers[0].forgottenPasswordInfo.forgottenPasswordAnswer1" value: @"sample string 2"];
[json UpdateString: @"newUsers[0].forgottenPasswordInfo.forgottenPasswordQuestion2" value: @"sample string 3"];
[json UpdateString: @"newUsers[0].forgottenPasswordInfo.forgottenPasswordAnswer2" value: @"sample string 4"];
[json UpdateString: @"newUsers[0].forgottenPasswordInfo.forgottenPasswordQuestion3" value: @"sample string 5"];
[json UpdateString: @"newUsers[0].forgottenPasswordInfo.forgottenPasswordAnswer3" value: @"sample string 6"];
[json UpdateString: @"newUsers[0].forgottenPasswordInfo.forgottenPasswordQuestion4" value: @"sample string 7"];
[json UpdateString: @"newUsers[0].forgottenPasswordInfo.forgottenPasswordAnswer4" value: @"sample string 8"];
[json UpdateString: @"newUsers[0].groupList[0].groupId" value: @"sample string 1"];
[json UpdateString: @"newUsers[0].groupList[0].groupName" value: @"sample string 2"];
[json UpdateString: @"newUsers[0].groupList[0].permissionProfileId" value: @"sample string 3"];
[json UpdateString: @"newUsers[0].groupList[0].groupType" value: @"sample string 4"];
[json UpdateString: @"newUsers[0].groupList[0].users[0].userName" value: @"sample string 1"];
[json UpdateString: @"newUsers[0].groupList[0].users[0].userId" value: @"sample string 2"];
[json UpdateString: @"newUsers[0].groupList[0].users[0].email" value: @"sample string 3"];
[json UpdateString: @"newUsers[0].groupList[0].users[0].userType" value: @"sample string 4"];
[json UpdateString: @"newUsers[0].groupList[0].users[0].userStatus" value: @"sample string 5"];
[json UpdateString: @"newUsers[0].groupList[0].users[0].uri" value: @"sample string 6"];
[json UpdateString: @"newUsers[0].groupList[0].users[0].loginStatus" value: @"sample string 7"];
[json UpdateString: @"newUsers[0].groupList[0].users[0].sendActivationEmail" value: @"sample string 8"];
[json UpdateString: @"newUsers[0].groupList[0].users[0].activationAccessCode" value: @"sample string 9"];
[json UpdateString: @"newUsers[0].workAddress.address1" value: @"sample string 1"];
[json UpdateString: @"newUsers[0].workAddress.address2" value: @"sample string 2"];
[json UpdateString: @"newUsers[0].workAddress.city" value: @"sample string 3"];
[json UpdateString: @"newUsers[0].workAddress.stateOrProvince" value: @"sample string 4"];
[json UpdateString: @"newUsers[0].workAddress.postalCode" value: @"sample string 5"];
[json UpdateString: @"newUsers[0].workAddress.phone" value: @"sample string 6"];
[json UpdateString: @"newUsers[0].workAddress.fax" value: @"sample string 7"];
[json UpdateString: @"newUsers[0].workAddress.country" value: @"sample string 8"];
[json UpdateNewObject: @"newUsers[0].homeAddress"];
[json UpdateString: @"newUsers[0].loginStatus" value: @"sample string 22"];
[json UpdateString: @"newUsers[0].passwordExpiration" value: @"sample string 23"];
[json UpdateString: @"newUsers[0].lastLogin" value: @"sample string 24"];
[json UpdateString: @"newUsers[0].sendActivationEmail" value: @"sample string 25"];
[json UpdateString: @"newUsers[0].profileImageUri" value: @"sample string 26"];
[json UpdateString: @"newUsers[0].userProfileLastModifiedDate" value: @"sample string 27"];
[json UpdateString: @"newUsers[0].signatureImageUri" value: @"sample string 28"];
[json UpdateString: @"newUsers[0].initialsImageUri" value: @"sample string 29"];
[json UpdateString: @"newUsers[0].jobTitle" value: @"sample string 30"];
// Adds the "Authorization: Bearer {{accessToken}}" header.
http.AuthToken = @"{{accessToken}}";
[http SetRequestHeader: @"Accept" value: @"application/json"];
CkoHttpResponse *resp = [http PostJson3: @"https://domain.com/v2.1/accounts/{{accountId}}/users" contentType: @"application/json" json: json];
if (http.LastMethodSuccess == NO) {
NSLog(@"%@",http.LastErrorText);
return;
}
NSLog(@"%d",[resp.StatusCode intValue]);
NSLog(@"%@",resp.BodyStr);
Curl Command
curl -X POST
-H "Accept: application/json"
-H "Authorization: Bearer {{accessToken}}"
-d '{
"newUsers": [
{
"userName": "sample string 1",
"userId": "sample string 2",
"userType": "sample string 3",
"isAdmin": "sample string 4",
"userStatus": "sample string 5",
"uri": "sample string 6",
"email": "sample string 7",
"password": "sample string 8",
"title": "sample string 9",
"createdDateTime": "sample string 10",
"firstName": "sample string 11",
"middleName": "sample string 12",
"lastName": "sample string 13",
"suffixName": "sample string 14",
"permissionProfileId": "sample string 15",
"permissionProfileName": "sample string 16",
"countryCode": "sample string 17",
"subscribe": "sample string 18",
"userSettings": [
{}
],
"accountManagementGranular": {
"canManageUsers": "sample string 1",
"canManageAdmins": "sample string 2",
"canManageGroups": "sample string 3",
"canManageSharing": "sample string 4",
"canManageEnvelopeTransfer": "sample string 5",
"canManageAccountSettings": "sample string 6",
"canManageReporting": "sample string 7",
"canManageAccountSecuritySettings": "sample string 8",
"canManageSigningGroups": "sample string 9",
"canManageDocumentRetention": "sample string 10",
"canViewUsers": "sample string 11",
"canManageUsersMetadata": {
"rights": "sample string 1",
"uiHint": "sample string 2",
"uiType": "sample string 3",
"uiOrder": "sample string 4",
"is21CFRPart11": "sample string 5",
"options": [
"sample string 1"
]
},
"canManageAdminsMetadata": {},
"canManageGroupsMetadata": {},
"canManageSharingMetadata": {},
"canManageEnvelopeTransferMetadata": {},
"canManageAccountSettingsMetadata": {},
"canManageReportingMetadata": {},
"canManageAccountSecuritySettingsMetadata": {},
"canManageSigningGroupsMetadata": {},
"canManageDocumentRetentionMetadata": {},
"canViewUsersMetadata": {}
},
"sendActivationOnInvalidLogin": "sample string 19",
"activationAccessCode": "sample string 20",
"enableConnectForUser": "sample string 21",
"forgottenPasswordInfo": {
"forgottenPasswordQuestion1": "sample string 1",
"forgottenPasswordAnswer1": "sample string 2",
"forgottenPasswordQuestion2": "sample string 3",
"forgottenPasswordAnswer2": "sample string 4",
"forgottenPasswordQuestion3": "sample string 5",
"forgottenPasswordAnswer3": "sample string 6",
"forgottenPasswordQuestion4": "sample string 7",
"forgottenPasswordAnswer4": "sample string 8"
},
"groupList": [
{
"groupId": "sample string 1",
"groupName": "sample string 2",
"permissionProfileId": "sample string 3",
"groupType": "sample string 4",
"users": [
{
"userName": "sample string 1",
"userId": "sample string 2",
"email": "sample string 3",
"userType": "sample string 4",
"userStatus": "sample string 5",
"uri": "sample string 6",
"loginStatus": "sample string 7",
"sendActivationEmail": "sample string 8",
"activationAccessCode": "sample string 9"
}
]
}
],
"workAddress": {
"address1": "sample string 1",
"address2": "sample string 2",
"city": "sample string 3",
"stateOrProvince": "sample string 4",
"postalCode": "sample string 5",
"phone": "sample string 6",
"fax": "sample string 7",
"country": "sample string 8"
},
"homeAddress": {},
"loginStatus": "sample string 22",
"passwordExpiration": "sample string 23",
"lastLogin": "sample string 24",
"sendActivationEmail": "sample string 25",
"customSettings": [
{}
],
"profileImageUri": "sample string 26",
"userProfileLastModifiedDate": "sample string 27",
"signatureImageUri": "sample string 28",
"initialsImageUri": "sample string 29",
"jobTitle": "sample string 30"
}
]
}'
https://domain.com/v2.1/accounts/{{accountId}}/users
Postman Collection Item JSON
{
"name": "Adds news user to the specified account.",
"request": {
"method": "POST",
"header": [
{
"key": "Accept",
"value": "application/json"
},
{
"key": "Authorization",
"value": "Bearer {{accessToken}}"
}
],
"body": {
"mode": "raw",
"raw": "{\n \"newUsers\": [\n {\n \"userName\": \"sample string 1\",\n \"userId\": \"sample string 2\",\n \"userType\": \"sample string 3\",\n \"isAdmin\": \"sample string 4\",\n \"userStatus\": \"sample string 5\",\n \"uri\": \"sample string 6\",\n \"email\": \"sample string 7\",\n \"password\": \"sample string 8\",\n \"title\": \"sample string 9\",\n \"createdDateTime\": \"sample string 10\",\n \"firstName\": \"sample string 11\",\n \"middleName\": \"sample string 12\",\n \"lastName\": \"sample string 13\",\n \"suffixName\": \"sample string 14\",\n \"permissionProfileId\": \"sample string 15\",\n \"permissionProfileName\": \"sample string 16\",\n \"countryCode\": \"sample string 17\",\n \"subscribe\": \"sample string 18\",\n \"userSettings\": [\n {}\n ],\n \"accountManagementGranular\": {\n \"canManageUsers\": \"sample string 1\",\n \"canManageAdmins\": \"sample string 2\",\n \"canManageGroups\": \"sample string 3\",\n \"canManageSharing\": \"sample string 4\",\n \"canManageEnvelopeTransfer\": \"sample string 5\",\n \"canManageAccountSettings\": \"sample string 6\",\n \"canManageReporting\": \"sample string 7\",\n \"canManageAccountSecuritySettings\": \"sample string 8\",\n \"canManageSigningGroups\": \"sample string 9\",\n \"canManageDocumentRetention\": \"sample string 10\",\n \"canViewUsers\": \"sample string 11\",\n \"canManageUsersMetadata\": {\n \"rights\": \"sample string 1\",\n \"uiHint\": \"sample string 2\",\n \"uiType\": \"sample string 3\",\n \"uiOrder\": \"sample string 4\",\n \"is21CFRPart11\": \"sample string 5\",\n \"options\": [\n \"sample string 1\"\n ]\n },\n \"canManageAdminsMetadata\": {},\n \"canManageGroupsMetadata\": {},\n \"canManageSharingMetadata\": {},\n \"canManageEnvelopeTransferMetadata\": {},\n \"canManageAccountSettingsMetadata\": {},\n \"canManageReportingMetadata\": {},\n \"canManageAccountSecuritySettingsMetadata\": {},\n \"canManageSigningGroupsMetadata\": {},\n \"canManageDocumentRetentionMetadata\": {},\n \"canViewUsersMetadata\": {}\n },\n \"sendActivationOnInvalidLogin\": \"sample string 19\",\n \"activationAccessCode\": \"sample string 20\",\n \"enableConnectForUser\": \"sample string 21\",\n \"forgottenPasswordInfo\": {\n \"forgottenPasswordQuestion1\": \"sample string 1\",\n \"forgottenPasswordAnswer1\": \"sample string 2\",\n \"forgottenPasswordQuestion2\": \"sample string 3\",\n \"forgottenPasswordAnswer2\": \"sample string 4\",\n \"forgottenPasswordQuestion3\": \"sample string 5\",\n \"forgottenPasswordAnswer3\": \"sample string 6\",\n \"forgottenPasswordQuestion4\": \"sample string 7\",\n \"forgottenPasswordAnswer4\": \"sample string 8\"\n },\n \"groupList\": [\n {\n \"groupId\": \"sample string 1\",\n \"groupName\": \"sample string 2\",\n \"permissionProfileId\": \"sample string 3\",\n \"groupType\": \"sample string 4\",\n \"users\": [\n {\n \"userName\": \"sample string 1\",\n \"userId\": \"sample string 2\",\n \"email\": \"sample string 3\",\n \"userType\": \"sample string 4\",\n \"userStatus\": \"sample string 5\",\n \"uri\": \"sample string 6\",\n \"loginStatus\": \"sample string 7\",\n \"sendActivationEmail\": \"sample string 8\",\n \"activationAccessCode\": \"sample string 9\"\n }\n ]\n }\n ],\n \"workAddress\": {\n \"address1\": \"sample string 1\",\n \"address2\": \"sample string 2\",\n \"city\": \"sample string 3\",\n \"stateOrProvince\": \"sample string 4\",\n \"postalCode\": \"sample string 5\",\n \"phone\": \"sample string 6\",\n \"fax\": \"sample string 7\",\n \"country\": \"sample string 8\"\n },\n \"homeAddress\": {},\n \"loginStatus\": \"sample string 22\",\n \"passwordExpiration\": \"sample string 23\",\n \"lastLogin\": \"sample string 24\",\n \"sendActivationEmail\": \"sample string 25\",\n \"customSettings\": [\n {}\n ],\n \"profileImageUri\": \"sample string 26\",\n \"userProfileLastModifiedDate\": \"sample string 27\",\n \"signatureImageUri\": \"sample string 28\",\n \"initialsImageUri\": \"sample string 29\",\n \"jobTitle\": \"sample string 30\"\n }\n ]\n}"
},
"url": {
"raw": "{{baseUrl}}/v2.1/accounts/{{accountId}}/users",
"host": [
"{{baseUrl}}"
],
"path": [
"v2.1",
"accounts",
"{{accountId}}",
"users"
],
"variable": [
{
"key": "accountId",
"value": "{{accountId}}"
}
]
},
"description": "Adds new users to your account. Set the `userSettings` property in the request to specify the actions the users can perform on the account."
},
"response": [
]
}
