POST | /backup/backupcustomer/user |
---|
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
location | body | string | Yes | URL for underlying backup system |
postUser | body | PostUser | No | User |
environment | body | N3TEnvironment | Yes | EnvironmentAllowable Values
|
DEV | |
QA | |
UAT | |
PROD | |
DEMO | |
EXT |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
Result | form | ExecuteResult<User> | No | |
ResponseStatus | form | ResponseStatus | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
HasError | form | bool | No | |
Message | form | string | No | |
Result | form | T | No | |
Exception | form | Exception | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
id | form | string | No | |
version | form | int | No | |
tenant_id | form | string | No | |
created_at | form | DateTime | No | |
updated_at | form | DateTime | No | |
deleted_at | form | Object | No | |
access_policies | form | List<Access_Policies> | No | |
personal_tenant_id | form | string | No | |
login | form | string | No | |
enabled | form | bool | No | |
contact | form | TenantContact | No | |
activated | form | bool | No | |
language | form | string | No | |
business_types | form | List<string> | No | |
notifications | form | List<string> | No | |
idp_id | form | string | No | |
external_id | form | string | No | |
mfa_status | form | string | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
id | form | string | No | |
issuer_id | form | string | No | |
trustee_id | form | string | No | |
trustee_type | form | string | No | |
tenant_id | form | string | No | |
role_id | form | string | No | |
created_at | form | DateTime | No | |
updated_at | form | DateTime | No | |
deleted_at | form | Object | No | |
version | form | int | No |
Name | Parameter | Data Type | Required | Description |
---|---|---|---|---|
aan | form | Object | No | |
state | form | string | No | |
zipcode | form | string | No | |
lastname | form | string | No | |
address2 | form | string | No | |
industry | form | string | No | |
email_confirmed | form | Object | No | |
created_at | form | DateTime | No | |
city | form | string | No | |
form | string | No | ||
address1 | form | string | No | |
phone | form | string | No | |
updated_at | form | DateTime | No | |
organization_size | form | string | No | |
website | form | string | No | |
id | form | string | No | |
firstname | form | string | No | |
title | form | string | No | |
country | form | string | No | |
fax | form | string | No | |
language | form | string | No | |
types | form | List<string> | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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 } } }