Net3 API Interface for Customer Portal

<back to all web services

PostUser

Post Tenant User

Requires Authentication
The following routes are available for this service:
POST/backup/backupcustomer/user
PostUser Parameters:
NameParameterData TypeRequiredDescription
locationbodystringYesURL for underlying backup system
postUserbodyPostUserNoUser
environmentbodyN3TEnvironmentYesEnvironment

Allowable Values

  • DEV
  • QA
  • UAT
  • PROD
  • DEMO
  • EXT
N3TEnvironment Enum:
DEV
QA
UAT
PROD
DEMO
EXT
PostUserResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformExecuteResult<User>No
ResponseStatusformResponseStatusNo
ExecuteResult<T> Parameters:
NameParameterData TypeRequiredDescription
HasErrorformboolNo
MessageformstringNo
ResultformTNo
ExceptionformExceptionNo
User Parameters:
NameParameterData TypeRequiredDescription
idformstringNo
versionformintNo
tenant_idformstringNo
created_atformDateTimeNo
updated_atformDateTimeNo
deleted_atformObjectNo
access_policiesformList<Access_Policies>No
personal_tenant_idformstringNo
loginformstringNo
enabledformboolNo
contactformTenantContactNo
activatedformboolNo
languageformstringNo
business_typesformList<string>No
notificationsformList<string>No
idp_idformstringNo
external_idformstringNo
mfa_statusformstringNo
Access_Policies Parameters:
NameParameterData TypeRequiredDescription
idformstringNo
issuer_idformstringNo
trustee_idformstringNo
trustee_typeformstringNo
tenant_idformstringNo
role_idformstringNo
created_atformDateTimeNo
updated_atformDateTimeNo
deleted_atformObjectNo
versionformintNo
TenantContact Parameters:
NameParameterData TypeRequiredDescription
aanformObjectNo
stateformstringNo
zipcodeformstringNo
lastnameformstringNo
address2formstringNo
industryformstringNo
email_confirmedformObjectNo
created_atformDateTimeNo
cityformstringNo
emailformstringNo
address1formstringNo
phoneformstringNo
updated_atformDateTimeNo
organization_sizeformstringNo
websiteformstringNo
idformstringNo
firstnameformstringNo
titleformstringNo
countryformstringNo
faxformstringNo
languageformstringNo
typesformList<string>No

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /backup/backupcustomer/user HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	location: String,
	postUser: 
	{
		tenant_id: String,
		login: String,
		contact: 
		{
			aan: {},
			state: String,
			zipcode: String,
			lastname: String,
			address2: String,
			industry: String,
			email_confirmed: {},
			created_at: 0001-01-01,
			city: String,
			email: String,
			address1: String,
			phone: String,
			updated_at: 0001-01-01,
			organization_size: String,
			website: String,
			id: String,
			firstname: String,
			title: String,
			country: String,
			fax: String,
			language: String,
			types: 
			[
				String
			]
		},
		enabled: False,
		language: String,
		business_types: 
		[
			String
		],
		notifications: 
		[
			String
		]
	},
	environment: DEV
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		hasError: False,
		message: String,
		result: 
		{
			id: String,
			version: 0,
			tenant_id: String,
			created_at: 0001-01-01,
			updated_at: 0001-01-01,
			deleted_at: {},
			access_policies: 
			[
				{
					id: String,
					issuer_id: String,
					trustee_id: String,
					trustee_type: String,
					tenant_id: String,
					role_id: String,
					created_at: 0001-01-01,
					updated_at: 0001-01-01,
					deleted_at: {},
					version: 0
				}
			],
			personal_tenant_id: String,
			login: String,
			enabled: False,
			contact: 
			{
				aan: {},
				state: String,
				zipcode: String,
				lastname: String,
				address2: String,
				industry: String,
				email_confirmed: {},
				created_at: 0001-01-01,
				city: String,
				email: String,
				address1: String,
				phone: String,
				updated_at: 0001-01-01,
				organization_size: String,
				website: String,
				id: String,
				firstname: String,
				title: String,
				country: String,
				fax: String,
				language: String,
				types: 
				[
					String
				]
			},
			activated: False,
			language: String,
			business_types: 
			[
				String
			],
			notifications: 
			[
				String
			],
			idp_id: String,
			external_id: String,
			mfa_status: String
		},
		exception: Exception of type 'System.Exception' was thrown.
	},
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String,
				meta: 
				{
					String: String
				}
			}
		],
		meta: 
		{
			String: String
		}
	}
}