Net3 API Interface for Customer Portal

<back to all web services

SetAccessPolicies

Set Access Policies

Requires Authentication
The following routes are available for this service:
PUT/backup/backupcustomer/accessPolicies
SetAccessPolicies Parameters:
NameParameterData TypeRequiredDescription
locationbodystringYesURL for underlying backup system
uuidbodystringYesUUID of User
accessPoliciesbodyAccessPoliciesNoAccess Policies
environmentbodyN3TEnvironmentYesEnvironment

Allowable Values

  • DEV
  • QA
  • UAT
  • PROD
  • DEMO
  • EXT
AccessPolicies Parameters:
NameParameterData TypeRequiredDescription
itemsformList<AccessPolicy>No
AccessPolicy Parameters:
NameParameterData TypeRequiredDescription
idformstringNo
versionformintNo
trustee_idformstringNo
trustee_typeformstringNo
issuer_idformstringNo
tenant_idformstringNo
role_idformstringNo
created_atformstringNo
updated_atformstringNo
deleted_atformObjectNo
N3TEnvironment Enum:
DEV
QA
UAT
PROD
DEMO
EXT
SetAccessPoliciesResponse Parameters:
NameParameterData TypeRequiredDescription
ResultformExecuteResult<AccessPolicies>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.

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

{
	location: String,
	uuid: String,
	accessPolicies: 
	{
		items: 
		[
			{
				id: String,
				version: 0,
				trustee_id: String,
				trustee_type: String,
				issuer_id: String,
				tenant_id: String,
				role_id: String,
				created_at: String,
				updated_at: String,
				deleted_at: {}
			}
		]
	},
	environment: DEV
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	result: 
	{
		hasError: False,
		message: String,
		result: 
		{
			items: 
			[
				{
					id: String,
					version: 0,
					trustee_id: String,
					trustee_type: String,
					issuer_id: String,
					tenant_id: String,
					role_id: String,
					created_at: String,
					updated_at: String,
					deleted_at: {}
				}
			]
		},
		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
		}
	}
}