Net3 API Interface for Customer Portal

<back to all web services

Users

Retrieve list of Users

Requires Authentication
The following routes are available for this service:
GET/backup/backupcustomer/users
Users Parameters:
NameParameterData TypeRequiredDescription
locationquerystringYesURL for underlying backup system
uuidquerystringYesUUID of User
environmentqueryN3TEnvironmentYesEnvironment

Allowable Values

  • DEV
  • QA
  • UAT
  • PROD
  • DEMO
  • EXT
N3TEnvironment Enum:
DEV
QA
UAT
PROD
DEMO
EXT
UsersResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformExecuteResult<Users>No
ResponseStatusformResponseStatusNo
ExecuteResult<T> Parameters:
NameParameterData TypeRequiredDescription
HasErrorformboolNo
MessageformstringNo
ResultformTNo
ExceptionformExceptionNo

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.

GET /backup/backupcustomer/users HTTP/1.1 
Host: n3tapi.palmettovdc.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		hasError: False,
		message: String,
		result: 
		{
			timestamp: String,
			items: 
			[
				{
					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
				}
			],
			paging: 
			{
				cursors: 
				{
					after: 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
		}
	}
}