Users v0.4.2

Scroll down for code samples, example requests and responses. Select a language for code samples from the tabs above or the mobile navigation menu.

The Users API provides operations to allow for the creation and maintainence of user related information.

Users can be created (never deleted) and the state of a user can be modified by authorized users. Every user is uniquely identifiable by a system-generated GUID. A User may have one of more of the following links depending on its current state:

• self: A link to the user resource.
• apiture:activate: A link to activate the current user (via POST). This link only exists if the user resource is inactive or locked and if the caller is authorized to activate users.
• apiture:deactivate: A link to deactivate the current user (via POST). This link only exists if the user resource is active or locked and if the caller is authorized to deactivate users.
• apiture:lock: A link to lock the current user (via POST). This link only exists if the user resource is active or inactive and if the caller is authorized to lock users.
• apiture:remove: A link to remove the current user (via POST). This link only exists if the user resource is not removed and if the caller is authorized to remove users.
• apiture:merge: A link to merge the current user (or a collection of users) with a specified master user (via POST). This link only exists if the user resource is active, inactive, or locked and if the caller is authorized to merge users.

Download OpenAPI Definition (YAML)

Base URLs:

• /users

Terms of service

Email: Apiture Web: Apiture

License: Pending.

Authentication

• API Key (apiKey)
  • header parameter: API-Key
  • API Key based authentication. Each client application must pass its private, unique API key, allocated in the developer portal, via the API-Key: {api-key} request header.

• OAuth2 authentication (accessToken)
  • OAuth2 client access token authentication. The client authenticates against the server at authorizationUrl, passing the client's private clientId (and optional clientSecret) as part of this flow. The client obtains an access token from the server at tokenUrl. It then passes the received access token via the Authorization: Bearer {access-token} header in subsequent API calls. The authorization process also returns a refresh token which the client should use to renew the access token before it expires.
  • Flow: authorizationCode
  • Authorization URL = https://auth.apiture.com/oauth2/authorize
  • Token URL = http://auth.apiture.com/auth/oauth2/token

API

Endpoints which describe this API.

getApi

Code samples

# You can also use wget
curl -X GET /users/ \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY'

GET /users/ HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY'

};

$.ajax({
  url: '/users/',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY'

};

fetch('/users/',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY'
}

result = RestClient.get '/users/',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY'
}

r = requests.get('/users/', params={

}, headers = headers)

print r.json()

URL obj = new URL("/users/");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/users/", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Top-level resources and operations in this API

GET /

Return links to the top-level resources and operations in this API. Links in the root response may include:

• apiture:user : A link to a specific user.
• apiture:users : A link to the collection of all users.
• apiture:createuser : A link to create a new user (via POST)
• apiture:activateUser : A link to activate a user (via POST)
• apiture:deactivateUser : A link to deactivate a user (via POST)
• apiture:lockUser : A link to lock a user (via POST)
• apiture:removeUser : A link to remove a user (via POST)
• apiture:mergeUser : A link to merge a user (via POST)

Example responses

200 Response

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "0.0.1-SNAPSHOT",
  "_profile": "https://api.apiture.com/schemas/common/root/v1.0.0/profile.json",
  "_links": {}
}

Responses

getApiDoc

Code samples

# You can also use wget
curl -X GET /users/apiDoc \
  -H 'Accept: application/json' \
  -H 'API-Key: API_KEY'

GET /users/apiDoc HTTP/1.1

Accept: application/json

var headers = {
  'Accept':'application/json',
  'API-Key':'API_KEY'

};

$.ajax({
  url: '/users/apiDoc',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/json',
  'API-Key':'API_KEY'

};

fetch('/users/apiDoc',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'API-Key' => 'API_KEY'
}

result = RestClient.get '/users/apiDoc',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'API-Key': 'API_KEY'
}

r = requests.get('/users/apiDoc', params={

}, headers = headers)

print r.json()

URL obj = new URL("/users/apiDoc");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/json"},
        "API-Key": []string{"API_KEY"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/users/apiDoc", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return API definition document

GET /apiDoc

Return the OpenAPI document that describes this API.

Example responses

200 Response

{}

Responses

Response Schema

User

Endpoints to manage users.

getUsers

Code samples

# You can also use wget
curl -X GET /users/users \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /users/users HTTP/1.1

Accept: application/hal+json

var headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/users/users',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/users/users',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/users/users',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/users/users', params={

}, headers = headers)

print r.json()

URL obj = new URL("/users/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/users/users", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Return a collection of users

GET /users

Use this endpoint to retrieve a paginated, sortable, filterable, searchable collection of folders. The links in the response include pagination links. This representation will contain links in each user in the embedded items array:

• self: A link to the user.
• apiture:remove: A link to remove the current user (via POST). This link only exists if the user resource is not removed and if the caller is authorized to remove users.
• apiture:activate: A link to activate the current user (via POST). This link only exists if the user resource is inactive or locked and if the caller is authorized to activate users.
• apiture:deactivate: A link to deactivate the current user (via POST) This link only exists if the user resource is active or locked and if the caller is authorized to deactivate users.
• apiture:lock: A link to lock the current user (via POST). This link only exists if the user resource is active or 'inactive`' and if the caller is authorized to lock users.
• apiture:merge: A link to merge the current user (or a collection of users) with a specified master user (via POST). This link only exists if the user resource is active, inactive, or locked and if the caller is authorized to merge users.

Parameters

Example responses

200 Response

{
  "_profile": "https://api.apiture.com/schemas/users/users/v1.0.0/profile.json",
  "start": 0,
  "limit": 10,
  "count": 2,
  "name": "users",
  "_links": {
    "self": {
      "href": "/users?start=0&limit=10"
    },
    "first": {
      "href": "/users?start=10&limit=10"
    },
    "next": {
      "href": "/users?start=10&limit=10"
    },
    "collection": {
      "href": "/users"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "9604e5f8-da29-4197-b6fb-60a1cfecfba8",
        "_profile": "https://api.apiture.com/schemas/users/user/v.0.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/users/users/9604e5f8-da29-4197-b6fb-60a1cfecfba8"
          },
          "apiture:deactivate": {
            "href": "/users/inactiveUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
          },
          "apiture:lock": {
            "href": "/users/lockedUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
          },
          "apiture:remove": {
            "href": "/users/removedUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
          },
          "apiture:merge": {
            "href": "/users/mergedUsers"
          }
        },
        "username": "Johnny1733",
        "firstName": "John",
        "middleName": "Daniel",
        "lastName": "Smith",
        "preferredName": "John",
        "identification": [
          {
            "value": "111-11-1111",
            "type": "taxId"
          }
        ],
        "emailAddresses": [
          "api@apiture.com",
          "support@apiture.com"
        ],
        "phones": [
          {
            "type": "home",
            "number": "(555) 555-5555"
          },
          {
            "type": "mobile",
            "number": "(999) 555-5555"
          }
        ],
        "birthdate": "1974-10-27",
        "citizenship": [
          {
            "country": "US",
            "status": "citizen"
          }
        ],
        "occupation": "Software Engineer",
        "addresses": [
          {
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "region": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US"
          },
          {
            "type": "home",
            "addressLine1": "123 S 3rd Street",
            "addressLine2": "Apt 42",
            "city": "Wilmington",
            "region": "NC",
            "postalCode": "28411-5405",
            "countryCode": "US"
          }
        ],
        "lastContactedAt": "2018-07-29T11:13:54Z",
        "lastLoggedInAt": "2017-12-29T15:19:41Z",
        "metadata": [],
        "state": "active",
        "createdAt": "2018-03-09T20:14:32Z"
      },
      {
        "_id": "d1fabf13-31d1-4351-89ad-877ac4d1220a",
        "_profile": "https://api.apiture.com/schemas/users/user/v.0.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/users/users/d1fabf13-31d1-4351-89ad-877ac4d1220a"
          },
          "apiture:deactivate": {
            "href": "/users/inactiveUsers?user=d1fabf13-31d1-4351-89ad-877ac4d1220a"
          },
          "apiture:lock": {
            "href": "/users/lockedUsers?user=d1fabf13-31d1-4351-89ad-877ac4d1220a"
          },
          "apiture:remove": {
            "href": "/users/removedUsers?user=d1fabf13-31d1-4351-89ad-877ac4d1220a"
          },
          "apiture:merge": {
            "href": "/users/mergedUsers"
          }
        },
        "username": "LAS15",
        "firstName": "Laura",
        "middleName": "Eileen",
        "lastName": "Smith",
        "preferredName": "Laura",
        "identification": [
          {
            "value": "111-11-1111",
            "type": "taxId"
          }
        ],
        "emailAddresses": [
          "api@apiture.com",
          "support@apiture.com"
        ],
        "phones": [
          {
            "type": "home",
            "number": "(555) 555-5555"
          },
          {
            "type": "mobile",
            "number": "(999) 555-5555"
          }
        ],
        "birthdate": "1980-03-19",
        "citizenship": [
          {
            "country": "US",
            "status": "citizen"
          }
        ],
        "occupation": "Product Manager",
        "addresses": [
          {
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "region": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US"
          },
          {
            "type": "home",
            "addressLine1": "123 S 3rd Street",
            "addressLine2": "Apt 42",
            "city": "Wilmington",
            "region": "NC",
            "postalCode": "28411-5405",
            "countryCode": "US"
          }
        ],
        "lastContactedAt": "2018-07-29T11:13:54Z",
        "lastLoggedInAt": "2017-12-29T15:19:41Z",
        "metadata": [],
        "state": "active",
        "createdAt": "2018-07-29T11:13:54Z"
      }
    ]
  }
}

Responses

createUser

Code samples

# You can also use wget
curl -X POST /users/users \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST /users/users HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/users/users',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "property1": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    },
    "property2": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    }
  },
  "_embedded": {},
  "_profile": "http://example.com",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  },
  "username": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "preferredName": "string",
  "identification": [
    {
      "value": "string",
      "type": "taxId",
      "expiration": "string"
    }
  ],
  "phones": [
    {
      "type": "home",
      "number": "string"
    }
  ],
  "emailAddresses": [
    "user@example.com"
  ],
  "birthdate": "2019-07-09",
  "citizenship": [
    {
      "country": "string",
      "status": "citizen"
    }
  ],
  "occupation": "string",
  "addresses": [
    {
      "type": "home",
      "label": "string",
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "region": "string",
      "postalCode": "string",
      "countryCode": "string"
    }
  ],
  "lastContactedAt": "2019-07-09T10:55:35Z",
  "lastLoggedInAt": "2019-07-09T10:55:35Z",
  "metadata": [
    {}
  ],
  "state": "active"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/users/users',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/users/users',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/users/users', params={

}, headers = headers)

print r.json()

URL obj = new URL("/users/users");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/users/users", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Create a new user

POST /users

Body parameter

{
  "_links": {
    "property1": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    },
    "property2": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    }
  },
  "_embedded": {},
  "_profile": "http://example.com",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  },
  "username": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "preferredName": "string",
  "identification": [
    {
      "value": "string",
      "type": "taxId",
      "expiration": "string"
    }
  ],
  "phones": [
    {
      "type": "home",
      "number": "string"
    }
  ],
  "emailAddresses": [
    "user@example.com"
  ],
  "birthdate": "2019-07-09",
  "citizenship": [
    {
      "country": "string",
      "status": "citizen"
    }
  ],
  "occupation": "string",
  "addresses": [
    {
      "type": "home",
      "label": "string",
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "region": "string",
      "postalCode": "string",
      "countryCode": "string"
    }
  ],
  "lastContactedAt": "2019-07-09T10:55:35Z",
  "lastLoggedInAt": "2019-07-09T10:55:35Z",
  "metadata": [
    {}
  ],
  "state": "active"
}

Parameters

Example responses

201 Response

{
  "_id": "9604e5f8-da29-4197-b6fb-60a1cfecfba8",
  "_profile": "https://api.apiture.com/schemas/users/user/v.0.1.0/profile.json",
  "_links": {
    "self": {
      "href": "/users/users/9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:deactivate": {
      "href": "/users/inactiveUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:lock": {
      "href": "/users/lockedUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:remove": {
      "href": "/users/removedUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:merge": {
      "href": "/users/mergedUsers"
    }
  },
  "createdAt": "2018-03-09T20:14:32Z"
}

Responses

Response Headers

getUser

Code samples

# You can also use wget
curl -X GET /users/users/{userId} \
  -H 'Accept: application/hal+json' \
  -H 'If-None-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

GET /users/users/{userId} HTTP/1.1

Accept: application/hal+json
If-None-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/users/users/{userId}',
  method: 'get',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-None-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/users/users/{userId}',
{
  method: 'GET',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-None-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get '/users/users/{userId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-None-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('/users/users/{userId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/users/users/{userId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-None-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "/users/users/{userId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Fetch a representation of this user

GET /users/{userId}

Return a HAL representation of this user resource.

This representation will contain links related to the current user:

• self: A link to the user resource.
• apiture:remove: A link to remove the current user (via POST). This link only exists if the user resource is not removed and if the caller is authorized to remove users.
• apiture:activate: A link to activate the current user (via POST). This link only exists if the user resource is inactive or locked and if the caller is authorized to activate users.
• apiture:deactivate: A link to deactivate the current user (via POST). This link only exists if the user resource is active or locked and if the caller is authorized to deactivate users.
• apiture:lock: A link to lock the current user (via POST). This link only exists if the user resource is active or 'inactive`' and if the caller is authorized to lock users.
• apiture:merge: A link to merge the current user (or a collection of users) with a specified master user (via POST). This link only exists if the user resource is active, inactive, or locked and if the caller is authorized to merge users.

Parameters

Example responses

200 Response

{
  "_id": "9604e5f8-da29-4197-b6fb-60a1cfecfba8",
  "_profile": "https://api.apiture.com/schemas/users/user/v.0.1.0/profile.json",
  "_links": {
    "self": {
      "href": "/users/users/9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:deactivate": {
      "href": "/users/inactiveUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:lock": {
      "href": "/users/lockedUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:remove": {
      "href": "/users/removedUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:merge": {
      "href": "/users/mergedUsers"
    }
  },
  "createdAt": "2018-03-09T20:14:32Z"
}

Responses

Response Headers

updateUser

Code samples

# You can also use wget
curl -X PUT /users/users/{userId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PUT /users/users/{userId} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/users/users/{userId}',
  method: 'put',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "username": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "preferredName": "string",
  "identification": [
    {
      "value": "string",
      "type": "taxId",
      "expiration": "string"
    }
  ],
  "phones": [
    {
      "type": "home",
      "number": "string"
    }
  ],
  "emailAddresses": [
    "user@example.com"
  ],
  "birthdate": "2019-07-09",
  "citizenship": [
    {
      "country": "string",
      "status": "citizen"
    }
  ],
  "occupation": "string",
  "addresses": [
    {
      "type": "home",
      "label": "string",
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "region": "string",
      "postalCode": "string",
      "countryCode": "string"
    }
  ],
  "lastContactedAt": "2019-07-09T10:55:35Z",
  "lastLoggedInAt": "2019-07-09T10:55:35Z",
  "metadata": [
    {}
  ],
  "state": "active",
  "_links": {
    "property1": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    },
    "property2": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    }
  },
  "_embedded": {},
  "_profile": "http://example.com",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  },
  "_id": "string"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/users/users/{userId}',
{
  method: 'PUT',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.put '/users/users/{userId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.put('/users/users/{userId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/users/users/{userId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PUT");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PUT", "/users/users/{userId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update this user

PUT /users/{userId}

Perform a complete replacement of this user.

Body parameter

{
  "username": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "preferredName": "string",
  "identification": [
    {
      "value": "string",
      "type": "taxId",
      "expiration": "string"
    }
  ],
  "phones": [
    {
      "type": "home",
      "number": "string"
    }
  ],
  "emailAddresses": [
    "user@example.com"
  ],
  "birthdate": "2019-07-09",
  "citizenship": [
    {
      "country": "string",
      "status": "citizen"
    }
  ],
  "occupation": "string",
  "addresses": [
    {
      "type": "home",
      "label": "string",
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "region": "string",
      "postalCode": "string",
      "countryCode": "string"
    }
  ],
  "lastContactedAt": "2019-07-09T10:55:35Z",
  "lastLoggedInAt": "2019-07-09T10:55:35Z",
  "metadata": [
    {}
  ],
  "state": "active",
  "_links": {
    "property1": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    },
    "property2": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    }
  },
  "_embedded": {},
  "_profile": "http://example.com",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  },
  "_id": "string"
}

Parameters

Example responses

200 Response

{
  "_id": "9604e5f8-da29-4197-b6fb-60a1cfecfba8",
  "_profile": "https://api.apiture.com/schemas/users/user/v.0.1.0/profile.json",
  "_links": {
    "self": {
      "href": "/users/users/9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:deactivate": {
      "href": "/users/inactiveUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:lock": {
      "href": "/users/lockedUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:remove": {
      "href": "/users/removedUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:merge": {
      "href": "/users/mergedUsers"
    }
  },
  "createdAt": "2018-03-09T20:14:32Z"
}

Responses

Response Headers

patchUser

Code samples

# You can also use wget
curl -X PATCH /users/users/{userId} \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

PATCH /users/users/{userId} HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json
If-Match: string

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/users/users/{userId}',
  method: 'patch',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "username": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "preferredName": "string",
  "identification": [
    {
      "value": "string",
      "type": "taxId",
      "expiration": "string"
    }
  ],
  "phones": [
    {
      "type": "home",
      "number": "string"
    }
  ],
  "emailAddresses": [
    "user@example.com"
  ],
  "birthdate": "2019-07-09",
  "citizenship": [
    {
      "country": "string",
      "status": "citizen"
    }
  ],
  "occupation": "string",
  "addresses": [
    {
      "type": "home",
      "label": "string",
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "region": "string",
      "postalCode": "string",
      "countryCode": "string"
    }
  ],
  "lastContactedAt": "2019-07-09T10:55:35Z",
  "lastLoggedInAt": "2019-07-09T10:55:35Z",
  "metadata": [
    {}
  ],
  "state": "active",
  "_links": {
    "property1": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    },
    "property2": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    }
  },
  "_embedded": {},
  "_profile": "http://example.com",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  },
  "_id": "string"
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/users/users/{userId}',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch '/users/users/{userId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('/users/users/{userId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("/users/users/{userId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "/users/users/{userId}", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Update this user

PATCH /users/{userId}

Perform a partial update of this user. Fields which are omitted are not updated.

Body parameter

{
  "username": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "preferredName": "string",
  "identification": [
    {
      "value": "string",
      "type": "taxId",
      "expiration": "string"
    }
  ],
  "phones": [
    {
      "type": "home",
      "number": "string"
    }
  ],
  "emailAddresses": [
    "user@example.com"
  ],
  "birthdate": "2019-07-09",
  "citizenship": [
    {
      "country": "string",
      "status": "citizen"
    }
  ],
  "occupation": "string",
  "addresses": [
    {
      "type": "home",
      "label": "string",
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "region": "string",
      "postalCode": "string",
      "countryCode": "string"
    }
  ],
  "lastContactedAt": "2019-07-09T10:55:35Z",
  "lastLoggedInAt": "2019-07-09T10:55:35Z",
  "metadata": [
    {}
  ],
  "state": "active",
  "_links": {
    "property1": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    },
    "property2": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    }
  },
  "_embedded": {},
  "_profile": "http://example.com",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  },
  "_id": "string"
}

Parameters

Example responses

200 Response

{
  "_id": "9604e5f8-da29-4197-b6fb-60a1cfecfba8",
  "_profile": "https://api.apiture.com/schemas/users/user/v.0.1.0/profile.json",
  "_links": {
    "self": {
      "href": "/users/users/9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:deactivate": {
      "href": "/users/inactiveUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:lock": {
      "href": "/users/lockedUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:remove": {
      "href": "/users/removedUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:merge": {
      "href": "/users/mergedUsers"
    }
  },
  "createdAt": "2018-03-09T20:14:32Z"
}

Responses

Response Headers

removeUser

Code samples

# You can also use wget
curl -X POST /users/removedUsers \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST /users/removedUsers HTTP/1.1

Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/users/removedUsers',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/users/removedUsers',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/users/removedUsers',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/users/removedUsers', params={

}, headers = headers)

print r.json()

URL obj = new URL("/users/removedUsers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/users/removedUsers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Remove a user.

POST /removedUsers

Remove a user from active use.

This operation is invoked from the apiture:remove link on a user resource when that user is eligible to be removed.

This changes the state to removed.

Parameters

Example responses

200 Response

{
  "_id": "9604e5f8-da29-4197-b6fb-60a1cfecfba8",
  "_profile": "https://api.apiture.com/schemas/users/user/v.0.1.0/profile.json",
  "_links": {
    "self": {
      "href": "/users/users/9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:deactivate": {
      "href": "/users/inactiveUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:lock": {
      "href": "/users/lockedUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:remove": {
      "href": "/users/removedUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:merge": {
      "href": "/users/mergedUsers"
    }
  },
  "createdAt": "2018-03-09T20:14:32Z"
}

Responses

Response Headers

activateUser

Code samples

# You can also use wget
curl -X POST /users/activeUsers \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST /users/activeUsers HTTP/1.1

Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/users/activeUsers',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/users/activeUsers',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/users/activeUsers',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/users/activeUsers', params={

}, headers = headers)

print r.json()

URL obj = new URL("/users/activeUsers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/users/activeUsers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Activate a user.

POST /activeUsers

Activate a user from an inactive state.

This operation is invoked from the apiture:activate link on a user resource when that user is eligible to be activated.

This changes the state to active.

Parameters

Example responses

200 Response

{
  "_id": "9604e5f8-da29-4197-b6fb-60a1cfecfba8",
  "_profile": "https://api.apiture.com/schemas/users/user/v.0.1.0/profile.json",
  "_links": {
    "self": {
      "href": "/users/users/9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:deactivate": {
      "href": "/users/inactiveUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:lock": {
      "href": "/users/lockedUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:remove": {
      "href": "/users/removedUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:merge": {
      "href": "/users/mergedUsers"
    }
  },
  "createdAt": "2018-03-09T20:14:32Z"
}

Responses

Response Headers

deactivateUser

Code samples

# You can also use wget
curl -X POST /users/inactiveUsers \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST /users/inactiveUsers HTTP/1.1

Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/users/inactiveUsers',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/users/inactiveUsers',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/users/inactiveUsers',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/users/inactiveUsers', params={

}, headers = headers)

print r.json()

URL obj = new URL("/users/inactiveUsers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/users/inactiveUsers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Deactivate a user.

POST /inactiveUsers

Deactivate a user from an active state.

This operation is invoked from the apiture:deactivate link on a user resource when that user is eligible to be deactivated.

This changes the state to inactive.

Parameters

Example responses

200 Response

{
  "_id": "9604e5f8-da29-4197-b6fb-60a1cfecfba8",
  "_profile": "https://api.apiture.com/schemas/users/user/v.0.1.0/profile.json",
  "_links": {
    "self": {
      "href": "/users/users/9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:deactivate": {
      "href": "/users/inactiveUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:lock": {
      "href": "/users/lockedUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:remove": {
      "href": "/users/removedUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:merge": {
      "href": "/users/mergedUsers"
    }
  },
  "createdAt": "2018-03-09T20:14:32Z"
}

Responses

Response Headers

lockUser

Code samples

# You can also use wget
curl -X POST /users/lockedUsers \
  -H 'Accept: application/hal+json' \
  -H 'If-Match: string' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST /users/lockedUsers HTTP/1.1

Accept: application/hal+json
If-Match: string

var headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/users/lockedUsers',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');

const headers = {
  'Accept':'application/hal+json',
  'If-Match':'string',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/users/lockedUsers',
{
  method: 'POST',

  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/hal+json',
  'If-Match' => 'string',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/users/lockedUsers',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/hal+json',
  'If-Match': 'string',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/users/lockedUsers', params={

}, headers = headers)

print r.json()

URL obj = new URL("/users/lockedUsers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Accept": []string{"application/hal+json"},
        "If-Match": []string{"string"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/users/lockedUsers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Lock a user.

POST /lockedUsers

Lock a user from an active or inactive state.

This operation is invoked from the apiture:lock link on a user resource when that user is eligible to be lock.

This changes the state to locked.

Parameters

Example responses

200 Response

{
  "_id": "9604e5f8-da29-4197-b6fb-60a1cfecfba8",
  "_profile": "https://api.apiture.com/schemas/users/user/v.0.1.0/profile.json",
  "_links": {
    "self": {
      "href": "/users/users/9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:deactivate": {
      "href": "/users/inactiveUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:lock": {
      "href": "/users/lockedUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:remove": {
      "href": "/users/removedUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:merge": {
      "href": "/users/mergedUsers"
    }
  },
  "createdAt": "2018-03-09T20:14:32Z"
}

Responses

Response Headers

mergeUsers

Code samples

# You can also use wget
curl -X POST /users/mergedUsers \
  -H 'Content-Type: application/hal+json' \
  -H 'Accept: application/hal+json' \
  -H 'API-Key: API_KEY' \
  -H 'Authorization: Bearer {access-token}'

POST /users/mergedUsers HTTP/1.1

Content-Type: application/hal+json
Accept: application/hal+json

var headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: '/users/mergedUsers',
  method: 'post',

  headers: headers,
  success: function(data) {
    console.log(JSON.stringify(data));
  }
})

const fetch = require('node-fetch');
const inputBody = '{
  "_links": {
    "apiture:master": {
      "href": "/users/users/5150d4f2-0d94-4602-8ca8-f68d00815f63"
    }
  },
  "items": [
    {
      "_id": "9604e5f8-da29-4197-b6fb-60a1cfecfba8",
      "_profile": "https://api.apiture.com/schemas/users/user/v.0.1.0/profile.json",
      "_links": {
        "self": {
          "href": "/users/users/9604e5f8-da29-4197-b6fb-60a1cfecfba8"
        }
      },
      "username": "Johnny1733",
      "firstName": "John",
      "middleName": "Daniel",
      "lastName": "Smith",
      "preferredName": "John",
      "identification": [
        {
          "value": "111-11-1111",
          "type": "taxId"
        }
      ],
      "emailAddresses": [
        "api@apiture.com",
        "support@apiture.com"
      ],
      "phones": [
        {
          "type": "home",
          "number": "(555) 555-5555"
        },
        {
          "type": "mobile",
          "number": "(999) 555-5555"
        }
      ],
      "birthdate": "1974-10-27",
      "citizenship": [
        {
          "country": "US",
          "status": "citizen"
        }
      ],
      "occupation": "Software Engineer",
      "addresses": [
        {
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "region": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        {
          "type": "home",
          "addressLine1": "123 S 3rd Street",
          "addressLine2": "Apt 42",
          "city": "Wilmington",
          "region": "NC",
          "postalCode": "28411-5405",
          "countryCode": "US"
        }
      ],
      "lastContactedAt": "2018-07-29T11:13:54Z",
      "lastLoggedInAt": "2017-12-29T15:19:41Z",
      "metadata": [],
      "state": "active",
      "createdAt": "2018-03-09T20:14:32Z"
    },
    {
      "_id": "d1fabf13-31d1-4351-89ad-877ac4d1220a",
      "_profile": "https://api.apiture.com/schemas/users/user/v.0.1.0/profile.json",
      "_links": {
        "self": {
          "href": "/users/users/d1fabf13-31d1-4351-89ad-877ac4d1220a"
        }
      },
      "username": "LAS15",
      "firstName": "Laura",
      "middleName": "Eileen",
      "lastName": "Smith",
      "preferredName": "Laura",
      "identification": [
        {
          "value": "111-11-1111",
          "type": "taxId"
        }
      ],
      "emailAddresses": [
        "api@apiture.com",
        "support@apiture.com"
      ],
      "phones": [
        {
          "type": "home",
          "number": "(555) 555-5555"
        },
        {
          "type": "mobile",
          "number": "(999) 555-5555"
        }
      ],
      "birthdate": "1980-03-19",
      "citizenship": [
        {
          "country": "US",
          "status": "citizen"
        }
      ],
      "occupation": "Product Manager",
      "addresses": [
        {
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": null,
          "city": "Wilmington",
          "region": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        {
          "type": "home",
          "addressLine1": "123 S 3rd Street",
          "addressLine2": "Apt 42",
          "city": "Wilmington",
          "region": "NC",
          "postalCode": "28411-5405",
          "countryCode": "US"
        }
      ],
      "lastContactedAt": "2018-07-29T11:13:54Z",
      "lastLoggedInAt": "2017-12-29T15:19:41Z",
      "metadata": [],
      "state": "active",
      "createdAt": "2018-07-29T11:13:54Z"
    }
  ]
}';
const headers = {
  'Content-Type':'application/hal+json',
  'Accept':'application/hal+json',
  'API-Key':'API_KEY',
  'Authorization':'Bearer {access-token}'

};

fetch('/users/mergedUsers',
{
  method: 'POST',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/hal+json',
  'Accept' => 'application/hal+json',
  'API-Key' => 'API_KEY',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.post '/users/mergedUsers',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/hal+json',
  'Accept': 'application/hal+json',
  'API-Key': 'API_KEY',
  'Authorization': 'Bearer {access-token}'
}

r = requests.post('/users/mergedUsers', params={

}, headers = headers)

print r.json()

URL obj = new URL("/users/mergedUsers");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("POST");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/hal+json"},
        "Accept": []string{"application/hal+json"},
        "API-Key": []string{"API_KEY"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("POST", "/users/mergedUsers", data)
    req.Header = headers

    client := &http.Client{}
    resp, err := client.Do(req)
    // ...
}

Merge a set of users.

POST /mergedUsers

Merge a collection of users from an active, inactive or locked state into the user specified via the apiture:master link.

This operation is invoked from the apiture:merge link on a user resource when that user is eligible to be merged.

This changes the state to merged.

Body parameter

{
  "_links": {
    "apiture:master": {
      "href": "/users/users/5150d4f2-0d94-4602-8ca8-f68d00815f63"
    }
  },
  "items": [
    {
      "_id": "9604e5f8-da29-4197-b6fb-60a1cfecfba8",
      "_profile": "https://api.apiture.com/schemas/users/user/v.0.1.0/profile.json",
      "_links": {
        "self": {
          "href": "/users/users/9604e5f8-da29-4197-b6fb-60a1cfecfba8"
        }
      },
      "username": "Johnny1733",
      "firstName": "John",
      "middleName": "Daniel",
      "lastName": "Smith",
      "preferredName": "John",
      "identification": [
        {
          "value": "111-11-1111",
          "type": "taxId"
        }
      ],
      "emailAddresses": [
        "api@apiture.com",
        "support@apiture.com"
      ],
      "phones": [
        {
          "type": "home",
          "number": "(555) 555-5555"
        },
        {
          "type": "mobile",
          "number": "(999) 555-5555"
        }
      ],
      "birthdate": "1974-10-27",
      "citizenship": [
        {
          "country": "US",
          "status": "citizen"
        }
      ],
      "occupation": "Software Engineer",
      "addresses": [
        {
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "region": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        {
          "type": "home",
          "addressLine1": "123 S 3rd Street",
          "addressLine2": "Apt 42",
          "city": "Wilmington",
          "region": "NC",
          "postalCode": "28411-5405",
          "countryCode": "US"
        }
      ],
      "lastContactedAt": "2018-07-29T11:13:54Z",
      "lastLoggedInAt": "2017-12-29T15:19:41Z",
      "metadata": [],
      "state": "active",
      "createdAt": "2018-03-09T20:14:32Z"
    },
    {
      "_id": "d1fabf13-31d1-4351-89ad-877ac4d1220a",
      "_profile": "https://api.apiture.com/schemas/users/user/v.0.1.0/profile.json",
      "_links": {
        "self": {
          "href": "/users/users/d1fabf13-31d1-4351-89ad-877ac4d1220a"
        }
      },
      "username": "LAS15",
      "firstName": "Laura",
      "middleName": "Eileen",
      "lastName": "Smith",
      "preferredName": "Laura",
      "identification": [
        {
          "value": "111-11-1111",
          "type": "taxId"
        }
      ],
      "emailAddresses": [
        "api@apiture.com",
        "support@apiture.com"
      ],
      "phones": [
        {
          "type": "home",
          "number": "(555) 555-5555"
        },
        {
          "type": "mobile",
          "number": "(999) 555-5555"
        }
      ],
      "birthdate": "1980-03-19",
      "citizenship": [
        {
          "country": "US",
          "status": "citizen"
        }
      ],
      "occupation": "Product Manager",
      "addresses": [
        {
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": null,
          "city": "Wilmington",
          "region": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        {
          "type": "home",
          "addressLine1": "123 S 3rd Street",
          "addressLine2": "Apt 42",
          "city": "Wilmington",
          "region": "NC",
          "postalCode": "28411-5405",
          "countryCode": "US"
        }
      ],
      "lastContactedAt": "2018-07-29T11:13:54Z",
      "lastLoggedInAt": "2017-12-29T15:19:41Z",
      "metadata": [],
      "state": "active",
      "createdAt": "2018-07-29T11:13:54Z"
    }
  ]
}

Parameters

Example responses

200 Response

{
  "_id": "9604e5f8-da29-4197-b6fb-60a1cfecfba8",
  "_profile": "https://api.apiture.com/schemas/users/user/v.0.1.0/profile.json",
  "_links": {
    "self": {
      "href": "/users/users/9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:deactivate": {
      "href": "/users/inactiveUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:lock": {
      "href": "/users/lockedUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:remove": {
      "href": "/users/removedUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:merge": {
      "href": "/users/mergedUsers"
    }
  },
  "createdAt": "2018-03-09T20:14:32Z"
}

Responses

Response Headers

Schemas

abstractResource

{
  "_profile": "https://api.apiture.com/schema/example/v1.0.0/profile.json",
  "_links": {
    "self": {
      "href": "{uri of current resource}"
    }
  }
}

Abstract Resource

An augmented HAL resource representation. This model contains hypermedia _links, and either optional domain object data with _profile and optional _embedded objects, or an _error object. In responses, if the operation was successful, this object will not include the _error, but if the operation was a 4xx or 5xx error, this object will not include _embedded or any data fields, only _error and optionally _links.

Properties

root

{
  "id": "apiName",
  "name": "API name",
  "apiVersion": "0.0.1-SNAPSHOT",
  "_profile": "https://api.apiture.com/schemas/common/root/v1.0.0/profile.json",
  "_links": {}
}

API Root

A HAL response, with hypermedia _links for the top-level resources and operations in API.

Properties

errorResponse

{
  "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": {},
    "_links": {
      "describedby": {
        "href": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  }
}

Error Response

Describes an error response, typically returned on 4xx or 5xx errors from API operations. The _error object contains the error details.

Properties

error

{
  "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
  "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
  "message": "The value for deposit must be greater than 0.",
  "statusCode": 422,
  "type": "positiveNumberRequired",
  "attributes": {
    "value": -125.5
  },
  "remediation": "Provide a value which is greater than 0",
  "occurredAt": "2018-01-25T05:50:52.375Z",
  "_links": {
    "describedby": {
      "href": "http://doc.apiture.com/errors/positiveNumberRequired"
    }
  },
  "_embedded": {
    "errors": []
  }
}

Error

An error description. Nested source errors are contained in the _embedded object with the key "errors"; this is an array of nested error objects. For example, an API which validates its request body may find multiple errors in the request, which may be detailed here. The _links may contain a describedby link which refers to a web page with details about the error. The attributes field An optional map of name/value pairs which provide structured data about the error. For example, if the error is a value out of range, the attributes may specify the range values min and max. This allows clients to present error messages as they see fit (the API does not assume the client/presentation tier).

Properties

attributes

{}

Attributes

An optional map of name/value pairs which contains additional dynamic data about the resource.

Properties

No properties

links

{
  "property1": {
    "href": "http://example.com",
    "type": "string",
    "templated": true,
    "title": "string",
    "deprecation": "http://example.com",
    "profile": "http://example.com"
  },
  "property2": {
    "href": "http://example.com",
    "type": "string",
    "templated": true,
    "title": "string",
    "deprecation": "http://example.com",
    "profile": "http://example.com"
  }
}

Links

An optional map of links, mapping each link relation to a link object. This model defines the _links object of HAL representations.

Properties

link

{
  "href": "http://example.com",
  "type": "string",
  "templated": true,
  "title": "string",
  "deprecation": "http://example.com",
  "profile": "http://example.com"
}

Link

Describes a hypermedia link within a _links object in HAL representations. In Apiture APIs, links are HAL links, but Apiture APIs do not use the name or hreflang properties of HAL. Apiture links may include a method property.

Properties

collection

{
  "_links": {
    "property1": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    },
    "property2": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    }
  },
  "_embedded": {},
  "_profile": "http://example.com",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  },
  "count": 0,
  "start": 0,
  "limit": 0,
  "name": "string"
}

Collection

A collection of resources. This is an abstract model schema which is extended to define specific resource collections.

Properties

userFields

{
  "username": "Johnny1733",
  "firstName": "John",
  "middleName": "Daniel",
  "lastName": "Smith",
  "preferredName": "John",
  "identification": [
    {
      "value": "111-11-1111",
      "type": "taxId"
    }
  ],
  "emailAddresses": [
    "api@apiture.com",
    "support@apiture.com"
  ],
  "phones": [
    {
      "type": "home",
      "number": "(555) 555-5555"
    },
    {
      "type": "mobile",
      "number": "(999) 555-5555"
    }
  ],
  "birthdate": "1974-10-27",
  "citizenship": [
    {
      "country": "US",
      "status": "citizen"
    }
  ],
  "occupation": "Software Engineer",
  "addresses": [
    {
      "type": "home",
      "addressLine1": "555 N Front Street",
      "addressLine2": "Suite 5555",
      "city": "Wilmington",
      "region": "NC",
      "postalCode": "28401-5405",
      "countryCode": "US"
    },
    {
      "type": "home",
      "addressLine1": "123 S 3rd Street",
      "addressLine2": "Apt 42",
      "city": "Wilmington",
      "region": "NC",
      "postalCode": "28411-5405",
      "countryCode": "US"
    }
  ],
  "metadata": [],
  "state": "active"
}

Common fields of a user

Core fields of the user resource.

Properties

createUser

{
  "_links": {
    "property1": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    },
    "property2": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    }
  },
  "_embedded": {},
  "_profile": "http://example.com",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  },
  "username": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "preferredName": "string",
  "identification": [
    {
      "value": "string",
      "type": "taxId",
      "expiration": "string"
    }
  ],
  "phones": [
    {
      "type": "home",
      "number": "string"
    }
  ],
  "emailAddresses": [
    "user@example.com"
  ],
  "birthdate": "2019-07-09",
  "citizenship": [
    {
      "country": "string",
      "status": "citizen"
    }
  ],
  "occupation": "string",
  "addresses": [
    {
      "type": "home",
      "label": "string",
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "region": "string",
      "postalCode": "string",
      "countryCode": "string"
    }
  ],
  "lastContactedAt": "2019-07-09T10:55:35Z",
  "lastLoggedInAt": "2019-07-09T10:55:35Z",
  "metadata": [
    {}
  ],
  "state": "active"
}

Create User

Representation used to create a new user.

Properties

summaryUser

{
  "username": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "preferredName": "string",
  "identification": [
    {
      "value": "string",
      "type": "taxId",
      "expiration": "string"
    }
  ],
  "phones": [
    {
      "type": "home",
      "number": "string"
    }
  ],
  "emailAddresses": [
    "user@example.com"
  ],
  "birthdate": "2019-07-09",
  "citizenship": [
    {
      "country": "string",
      "status": "citizen"
    }
  ],
  "occupation": "string",
  "addresses": [
    {
      "type": "home",
      "label": "string",
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "region": "string",
      "postalCode": "string",
      "countryCode": "string"
    }
  ],
  "lastContactedAt": "2019-07-09T10:55:35Z",
  "lastLoggedInAt": "2019-07-09T10:55:35Z",
  "metadata": [
    {}
  ],
  "state": "active",
  "_links": {
    "property1": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    },
    "property2": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    }
  },
  "_embedded": {},
  "_profile": "http://example.com",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  },
  "_id": "string"
}

Summary User

Summary representation of a user resource in user collections. This representation normally does not contain any _embedded objects. If needed, call the GET operation on the item's self link to get _embedded objects.

Properties

updateUser

{
  "username": "string",
  "firstName": "string",
  "middleName": "string",
  "lastName": "string",
  "preferredName": "string",
  "identification": [
    {
      "value": "string",
      "type": "taxId",
      "expiration": "string"
    }
  ],
  "phones": [
    {
      "type": "home",
      "number": "string"
    }
  ],
  "emailAddresses": [
    "user@example.com"
  ],
  "birthdate": "2019-07-09",
  "citizenship": [
    {
      "country": "string",
      "status": "citizen"
    }
  ],
  "occupation": "string",
  "addresses": [
    {
      "type": "home",
      "label": "string",
      "addressLine1": "string",
      "addressLine2": "string",
      "city": "string",
      "region": "string",
      "postalCode": "string",
      "countryCode": "string"
    }
  ],
  "lastContactedAt": "2019-07-09T10:55:35Z",
  "lastLoggedInAt": "2019-07-09T10:55:35Z",
  "metadata": [
    {}
  ],
  "state": "active",
  "_links": {
    "property1": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    },
    "property2": {
      "href": "http://example.com",
      "type": "string",
      "templated": true,
      "title": "string",
      "deprecation": "http://example.com",
      "profile": "http://example.com"
    }
  },
  "_embedded": {},
  "_profile": "http://example.com",
  "_error": {
    "_id": "2eae46e1-575c-4d69-8a8f-0a7b0115a4b3",
    "_profile": "https://api.apiture.com/schemas/common/errorResponse/v1.0.0/profile.json",
    "message": "The value for deposit must be greater than 0.",
    "statusCode": 422,
    "type": "positiveNumberRequired",
    "attributes": {
      "value": -125.5
    },
    "remediation": "Provide a value which is greater than 0",
    "occurredAt": "2018-01-25T05:50:52.375Z",
    "_links": {
      "describedby": {
        "href": "http://doc.apiture.com/errors/positiveNumberRequired"
      }
    },
    "_embedded": {
      "errors": []
    }
  },
  "_id": "string",
  "createdAt": "2019-07-09T10:55:35Z"
}

Update User

Representation used to update or patch a user.

Properties

mergeUsers

{
  "_links": {
    "apiture:master": {
      "href": "/users/users/5150d4f2-0d94-4602-8ca8-f68d00815f63"
    }
  },
  "items": [
    {
      "_id": "9604e5f8-da29-4197-b6fb-60a1cfecfba8",
      "_profile": "https://api.apiture.com/schemas/users/user/v.0.1.0/profile.json",
      "_links": {
        "self": {
          "href": "/users/users/9604e5f8-da29-4197-b6fb-60a1cfecfba8"
        }
      },
      "username": "Johnny1733",
      "firstName": "John",
      "middleName": "Daniel",
      "lastName": "Smith",
      "preferredName": "John",
      "identification": [
        {
          "value": "111-11-1111",
          "type": "taxId"
        }
      ],
      "emailAddresses": [
        "api@apiture.com",
        "support@apiture.com"
      ],
      "phones": [
        {
          "type": "home",
          "number": "(555) 555-5555"
        },
        {
          "type": "mobile",
          "number": "(999) 555-5555"
        }
      ],
      "birthdate": "1974-10-27",
      "citizenship": [
        {
          "country": "US",
          "status": "citizen"
        }
      ],
      "occupation": "Software Engineer",
      "addresses": [
        {
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": "Suite 5555",
          "city": "Wilmington",
          "region": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        {
          "type": "home",
          "addressLine1": "123 S 3rd Street",
          "addressLine2": "Apt 42",
          "city": "Wilmington",
          "region": "NC",
          "postalCode": "28411-5405",
          "countryCode": "US"
        }
      ],
      "lastContactedAt": "2018-07-29T11:13:54Z",
      "lastLoggedInAt": "2017-12-29T15:19:41Z",
      "metadata": [],
      "state": "active",
      "createdAt": "2018-03-09T20:14:32Z"
    },
    {
      "_id": "d1fabf13-31d1-4351-89ad-877ac4d1220a",
      "_profile": "https://api.apiture.com/schemas/users/user/v.0.1.0/profile.json",
      "_links": {
        "self": {
          "href": "/users/users/d1fabf13-31d1-4351-89ad-877ac4d1220a"
        }
      },
      "username": "LAS15",
      "firstName": "Laura",
      "middleName": "Eileen",
      "lastName": "Smith",
      "preferredName": "Laura",
      "identification": [
        {
          "value": "111-11-1111",
          "type": "taxId"
        }
      ],
      "emailAddresses": [
        "api@apiture.com",
        "support@apiture.com"
      ],
      "phones": [
        {
          "type": "home",
          "number": "(555) 555-5555"
        },
        {
          "type": "mobile",
          "number": "(999) 555-5555"
        }
      ],
      "birthdate": "1980-03-19",
      "citizenship": [
        {
          "country": "US",
          "status": "citizen"
        }
      ],
      "occupation": "Product Manager",
      "addresses": [
        {
          "type": "home",
          "addressLine1": "555 N Front Street",
          "addressLine2": null,
          "city": "Wilmington",
          "region": "NC",
          "postalCode": "28401-5405",
          "countryCode": "US"
        },
        {
          "type": "home",
          "addressLine1": "123 S 3rd Street",
          "addressLine2": "Apt 42",
          "city": "Wilmington",
          "region": "NC",
          "postalCode": "28411-5405",
          "countryCode": "US"
        }
      ],
      "lastContactedAt": "2018-07-29T11:13:54Z",
      "lastLoggedInAt": "2017-12-29T15:19:41Z",
      "metadata": [],
      "state": "active",
      "createdAt": "2018-07-29T11:13:54Z"
    }
  ]
}

Merge Users

Representation used to merge a set of users into a master user.

Properties

user

{
  "_id": "9604e5f8-da29-4197-b6fb-60a1cfecfba8",
  "_profile": "https://api.apiture.com/schemas/users/user/v.0.1.0/profile.json",
  "_links": {
    "self": {
      "href": "/users/users/9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:deactivate": {
      "href": "/users/inactiveUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:lock": {
      "href": "/users/lockedUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:remove": {
      "href": "/users/removedUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
    },
    "apiture:merge": {
      "href": "/users/mergedUsers"
    }
  },
  "createdAt": "2018-03-09T20:14:32Z"
}

User

Representation of a user resource. A user may have the following links:

• self: A link to the user resource.
• apiture:remove: A link to remove the current user (via POST). This link only exists if the user resource is not removed and if the caller is authorized to remove users.
• apiture:activate: A link to activate the current user (via POST). This link only exists if the user resource is inactive or locked and if the caller is authorized to activate users.
• apiture:deactivate: A link to deactivate the current user (via POST). This link only exists if the user resource is active or locked and if the caller is authorized to deactivate users.
• apiture:lock: A link to lock the current user (via POST). This link only exists if the user resource is active or inactive and if the caller is authorized to lock users.
• apiture:merge: A link to merge the current user (or a collection of users) with a specified master user (via POST). This link only exists if the user resource is active, inactive, or locked and if the caller is authorized to merge users.

Properties

users

{
  "_profile": "https://api.apiture.com/schemas/users/users/v1.0.0/profile.json",
  "start": 0,
  "limit": 10,
  "count": 2,
  "name": "users",
  "_links": {
    "self": {
      "href": "/users?start=0&limit=10"
    },
    "first": {
      "href": "/users?start=10&limit=10"
    },
    "next": {
      "href": "/users?start=10&limit=10"
    },
    "collection": {
      "href": "/users"
    }
  },
  "_embedded": {
    "items": [
      {
        "_id": "9604e5f8-da29-4197-b6fb-60a1cfecfba8",
        "_profile": "https://api.apiture.com/schemas/users/user/v.0.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/users/users/9604e5f8-da29-4197-b6fb-60a1cfecfba8"
          },
          "apiture:deactivate": {
            "href": "/users/inactiveUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
          },
          "apiture:lock": {
            "href": "/users/lockedUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
          },
          "apiture:remove": {
            "href": "/users/removedUsers?user=9604e5f8-da29-4197-b6fb-60a1cfecfba8"
          },
          "apiture:merge": {
            "href": "/users/mergedUsers"
          }
        },
        "username": "Johnny1733",
        "firstName": "John",
        "middleName": "Daniel",
        "lastName": "Smith",
        "preferredName": "John",
        "identification": [
          {
            "value": "111-11-1111",
            "type": "taxId"
          }
        ],
        "emailAddresses": [
          "api@apiture.com",
          "support@apiture.com"
        ],
        "phones": [
          {
            "type": "home",
            "number": "(555) 555-5555"
          },
          {
            "type": "mobile",
            "number": "(999) 555-5555"
          }
        ],
        "birthdate": "1974-10-27",
        "citizenship": [
          {
            "country": "US",
            "status": "citizen"
          }
        ],
        "occupation": "Software Engineer",
        "addresses": [
          {
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "region": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US"
          },
          {
            "type": "home",
            "addressLine1": "123 S 3rd Street",
            "addressLine2": "Apt 42",
            "city": "Wilmington",
            "region": "NC",
            "postalCode": "28411-5405",
            "countryCode": "US"
          }
        ],
        "lastContactedAt": "2018-07-29T11:13:54Z",
        "lastLoggedInAt": "2017-12-29T15:19:41Z",
        "metadata": [],
        "state": "active",
        "createdAt": "2018-03-09T20:14:32Z"
      },
      {
        "_id": "d1fabf13-31d1-4351-89ad-877ac4d1220a",
        "_profile": "https://api.apiture.com/schemas/users/user/v.0.1.0/profile.json",
        "_links": {
          "self": {
            "href": "/users/users/d1fabf13-31d1-4351-89ad-877ac4d1220a"
          },
          "apiture:deactivate": {
            "href": "/users/inactiveUsers?user=d1fabf13-31d1-4351-89ad-877ac4d1220a"
          },
          "apiture:lock": {
            "href": "/users/lockedUsers?user=d1fabf13-31d1-4351-89ad-877ac4d1220a"
          },
          "apiture:remove": {
            "href": "/users/removedUsers?user=d1fabf13-31d1-4351-89ad-877ac4d1220a"
          },
          "apiture:merge": {
            "href": "/users/mergedUsers"
          }
        },
        "username": "LAS15",
        "firstName": "Laura",
        "middleName": "Eileen",
        "lastName": "Smith",
        "preferredName": "Laura",
        "identification": [
          {
            "value": "111-11-1111",
            "type": "taxId"
          }
        ],
        "emailAddresses": [
          "api@apiture.com",
          "support@apiture.com"
        ],
        "phones": [
          {
            "type": "home",
            "number": "(555) 555-5555"
          },
          {
            "type": "mobile",
            "number": "(999) 555-5555"
          }
        ],
        "birthdate": "1980-03-19",
        "citizenship": [
          {
            "country": "US",
            "status": "citizen"
          }
        ],
        "occupation": "Product Manager",
        "addresses": [
          {
            "type": "home",
            "addressLine1": "555 N Front Street",
            "addressLine2": "Suite 5555",
            "city": "Wilmington",
            "region": "NC",
            "postalCode": "28401-5405",
            "countryCode": "US"
          },
          {
            "type": "home",
            "addressLine1": "123 S 3rd Street",
            "addressLine2": "Apt 42",
            "city": "Wilmington",
            "region": "NC",
            "postalCode": "28411-5405",
            "countryCode": "US"
          }
        ],
        "lastContactedAt": "2018-07-29T11:13:54Z",
        "lastLoggedInAt": "2017-12-29T15:19:41Z",
        "metadata": [],
        "state": "active",
        "createdAt": "2018-07-29T11:13:54Z"
      }
    ]
  }
}

Users collection

Collection of users. The items in the collection are ordered in the _embedded object with name items. The top-level _links object may contain pagination links (self, next, prev, first, last, collection).

Properties