Users

API

getApi

Top-level resources and operations in this API

Return links to the top-level resources and operations in this API. Links in the root response may include: * *`apiture:users`* : A link to the collection of all users. * *`apiture:createUser`* : A link to create a new user (via `POST`)


/

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///users/"
import { APIApi } from "@apiture/users-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new Users.APIApi.getApi()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getApi(callback);

Scopes

Parameters

Responses


getApiDoc

Return API definition document

Return the OpenAPI document that describes this API.


/apiDoc

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///users/apiDoc"
import { APIApi } from "@apiture/users-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new Users.APIApi.getApiDoc()
var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getApiDoc(callback);

Scopes

Parameters

Responses


getLabels

Localized Labels

Return a JSON object which defines labels for enumeration types defined by the schemas defined in this API. The labels in the response may not all match the requested language; some may be in the default language (`en-us`).


/labels

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///users/labels"
import { APIApi } from "@apiture/users-client-sdk";

const aPIApi = new APIApi(configuration);

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
aPIApi.setApiKey(apiKey);


var api = new Users.APIApi.getLabels()
var opts = {
  'acceptLanguage': acceptLanguage_example // {String} The weighted language tags which indicate the user's preferred natural language for the localized labels in the response, as per [RFC 7231](https://tools.ietf.org/html/rfc7231#section-5.3.5).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
aPIApi.getLabels(opts, callback);

Scopes

Parameters

Header parameters
Name Description
Accept-Language
String
The weighted language tags which indicate the user's preferred natural language for the localized labels in the response, as per [RFC 7231](https://tools.ietf.org/html/rfc7231#section-5.3.5).

Responses


Address

createAddress

Create a new address

Add an address to the list of the user's addresses. The new address will be `pending` until the financial institution has reviewed and approved it, after which it will become `approved`. This operation may require the user to complete an additional authentication challenge as described in _Multi-factor authentication challenges_ above. A valid `Apiture-Challenge` request header may be required if the `?replaceId` parameter is used and the profile item being replaced is the preferred mailing address. See _Multi-factor authentication challenges_ above.


/users/{userId}/addresses

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///users/users/{userId}/addresses?replaceId="
import { AddressApi } from "@apiture/users-client-sdk";

const addressApi = new AddressApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
addressApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
addressApi.setApiKey(apiKey);


var api = new Users.AddressApi.createAddress()
var userId = userId_example; // {String} The unique identifier of the user. This is an opaque string.
var userAddress = ; // {UserAddress} 
var opts = {
  'replaceId': replaceId_example, // {String} An optional `_id` of an existing address to be _replaced_ with this new address instead of adding a new address, once it has been approved. If `replaceId` matches the `_id` of the preferred mailing address the `preferredMailingAddressId` will also be updated to the value of `replaceId` once approved (the `Apiture-Challenge` header may be required also). If no existing address matches `replaceId`, the new address is added to the list of addresses. Example: `?replaceId=ha1`
  'apitureChallenge': apitureChallenge_example // {String} The unique identifier of a Challenge resource which demonstrates the user has recently verified their identity. See the discussion of _Multi-factor authentication challenges_ above. The value must be the `_id` string of a valid, redeemable Challenge resource which matches the challenge context.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
addressApi.createAddress(userId, userAddress, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
userId*
String
The unique identifier of the user. This is an opaque string.
Required
Header parameters
Name Description
Apiture-Challenge
String
The unique identifier of a Challenge resource which demonstrates the user has recently verified their identity. See the discussion of _Multi-factor authentication challenges_ above. The value must be the `_id` string of a valid, redeemable Challenge resource which matches the challenge context.
Body parameters
Name Description
userAddress *

The data necessary to create a new address.

Query parameters
Name Description
replaceId
String
An optional `_id` of an existing address to be _replaced_ with this new address instead of adding a new address, once it has been approved. If `replaceId` matches the `_id` of the preferred mailing address the `preferredMailingAddressId` will also be updated to the value of `replaceId` once approved (the `Apiture-Challenge` header may be required also). If no existing address matches `replaceId`, the new address is added to the list of addresses. Example: `?replaceId=ha1`

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update the resource.
Location String uri The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`scheme`*`://host`


deleteAddress

Delete this address resource

Delete this address. The address can only be deleted if it is _not_ the user's preferred address.


/users/{userId}/addresses/{addressId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///users/users/{userId}/addresses/{addressId}"
import { AddressApi } from "@apiture/users-client-sdk";

const addressApi = new AddressApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
addressApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
addressApi.setApiKey(apiKey);


var api = new Users.AddressApi.deleteAddress()
var userId = userId_example; // {String} The unique identifier of the user. This is an opaque string.
var addressId = addressId_example; // {String} The unique identifier of this address. This is an opaque string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
addressApi.deleteAddress(userId, addressId, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
userId*
String
The unique identifier of the user. This is an opaque string.
Required
addressId*
String
The unique identifier of this address. This is an opaque string.
Required

Responses


getAddress

Fetch a representation of this address

Return a [HAL](http://developer.apiture.com/docs/concepts/hal) representation of this address resource.


/users/{userId}/addresses/{addressId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///users/users/{userId}/addresses/{addressId}"
import { AddressApi } from "@apiture/users-client-sdk";

const addressApi = new AddressApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
addressApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
addressApi.setApiKey(apiKey);


var api = new Users.AddressApi.getAddress()
var userId = userId_example; // {String} The unique identifier of the user. This is an opaque string.
var addressId = addressId_example; // {String} The unique identifier of this address. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
addressApi.getAddress(userId, addressId, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
userId*
String
The unique identifier of the user. This is an opaque string.
Required
addressId*
String
The unique identifier of this address. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this address resource.


getAddresses

Get user's addresses

Return the list of the user's addresses.


/users/{userId}/addresses

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///users/users/{userId}/addresses"
import { AddressApi } from "@apiture/users-client-sdk";

const addressApi = new AddressApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
addressApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
addressApi.setApiKey(apiKey);


var api = new Users.AddressApi.getAddresses()
var userId = userId_example; // {String} The unique identifier of the user. This is an opaque string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
addressApi.getAddresses(userId, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
userId*
String
The unique identifier of the user. This is an opaque string.
Required

Responses


setPreferredAddress

Set Preferred mailing Address

Set the user's preferred mailing address. The user may set their preferred address to an _approved_ address by passing its unique `_id` in the `value` query parameter. This updates the `preferredAddressId` property of the user. This operation may require the user to complete an additional authentication challenge as described in _Multi-factor authentication challenges_ above. A valid `Apiture-Challenge` request header may be required. This operation is available via the `apiture:setAsPreferred` link on an address if that resource is eligible to be set as the preferred address. No changes are made if the specified address is already the preferred address.


/users/{userId}/preferredAddress

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///users/users/{userId}/preferredAddress?value="
import { AddressApi } from "@apiture/users-client-sdk";

const addressApi = new AddressApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
addressApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
addressApi.setApiKey(apiKey);


var api = new Users.AddressApi.setPreferredAddress()
var userId = userId_example; // {String} The unique identifier of the user. This is an opaque string.
var opts = {
  'value': value_example, // {String} The `_id` of the address to assign as the preferred address. If this query parameter exists, the request body, if any, is ignored. Example: `?value=ha1`
  'apitureChallenge': apitureChallenge_example // {String} The unique identifier of a Challenge resource which demonstrates the user has recently verified their identity. See the discussion of _Multi-factor authentication challenges_ above. The value must be the `_id` string of a valid, redeemable Challenge resource which matches the challenge context.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
addressApi.setPreferredAddress(userId, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
userId*
String
The unique identifier of the user. This is an opaque string.
Required
Header parameters
Name Description
Apiture-Challenge
String
The unique identifier of a Challenge resource which demonstrates the user has recently verified their identity. See the discussion of _Multi-factor authentication challenges_ above. The value must be the `_id` string of a valid, redeemable Challenge resource which matches the challenge context.
Query parameters
Name Description
value
String
The `_id` of the address to assign as the preferred address. If this query parameter exists, the request body, if any, is ignored. Example: `?value=ha1`

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this user resource.


Configuration

getConfigurationGroup

Fetch a representation of this configuration group

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this configuration group resource.


/configurations/groups/{groupName}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///users/configurations/groups/{groupName}"
import { ConfigurationApi } from "@apiture/users-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new Users.ConfigurationApi.getConfigurationGroup()
var groupName = groupName_example; // {String} The unique name of this configuration group.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.getConfigurationGroup(groupName, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
groupName*
String
The unique name of this configuration group.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-None-Match` request header for *`GET`* operations for this configuration group resource.


getConfigurationGroupSchema

Fetch the schema for this configuration group

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this configuration group schema resource.


/configurations/groups/{groupName}/schema

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///users/configurations/groups/{groupName}/schema"
import { ConfigurationApi } from "@apiture/users-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new Users.ConfigurationApi.getConfigurationGroupSchema()
var groupName = groupName_example; // {String} The unique name of this configuration group.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.getConfigurationGroupSchema(groupName, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
groupName*
String
The unique name of this configuration group.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`*


getConfigurationGroupValue

Fetch a single value associated with the specified configuration group

Fetch a single value associated with this configuration group. This provides convenient access to individual values of the configuration group. The response is always a JSON value which can be parsed with a strict JSON parser. The response may be * a primitive number, boolean, or quoted JSON string. * a JSON array. * a JSON object. * `null`. Examples: * `"a string configuration value"` * `120` * `true` * `null` * `{ "borderWidth": 8, "foregroundColor": "blue" }` To update a specific value, use `PUT /users/configurations/groups/{groupName}/values/{valueName}` (operation `updateConfigurationGroupValue`).


/configurations/groups/{groupName}/values/{valueName}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///users/configurations/groups/{groupName}/values/{valueName}"
import { ConfigurationApi } from "@apiture/users-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new Users.ConfigurationApi.getConfigurationGroupValue()
var groupName = groupName_example; // {String} The unique name of this configuration group.
var valueName = valueName_example; // {String} The unique name of a value in a configuration group. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern _`letter [letter | digit | '-' | '_']*`_

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.getConfigurationGroupValue(groupName, valueName, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
groupName*
String
The unique name of this configuration group.
Required
valueName*
String
The unique name of a value in a configuration group. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern _`letter [letter | digit | '-' | '_']*`_
Required

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this configuration group resource.


getConfigurationGroupValues

Fetch the values for the specified configuration group

Return a representation of this configuration group values resource.


/configurations/groups/{groupName}/values

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///users/configurations/groups/{groupName}/values"
import { ConfigurationApi } from "@apiture/users-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new Users.ConfigurationApi.getConfigurationGroupValues()
var groupName = groupName_example; // {String} The unique name of this configuration group.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.getConfigurationGroupValues(groupName, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
groupName*
String
The unique name of this configuration group.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`*


getConfigurationGroups

Return a collection of configuration groups

Return a [paginated](https://developer.apiture.com/docs/concepts/pagination) [sortable](https://developer.apiture.com/docs/concepts/sorting) [filterable](https://developer.apiture.com/docs/concepts/filtering) [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of configuration groups. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.


/configurations/groups

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///users/configurations/groups?start=&limit=&sortBy=&filter=&q="
import { ConfigurationApi } from "@apiture/users-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new Users.ConfigurationApi.getConfigurationGroups()
var opts = {
  'start': 789, // {Long} The zero-based index of the first configuration group item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of configuration group representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.getConfigurationGroups(opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first configuration group item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of configuration group representations to return in this page.
sortBy
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).

Responses


updateConfigurationGroupValue

Update a single value associated with the specified configuration group

Update a single value associated with this configuration group. This provides convenient access to individual values of the configuration group as defined in the configuration group's `schema`. The request body must conform to the configuration group's schema for the named `{valueName}`. This operation is idempotent. The request body must be a JSON value which can be parsed with a strict JSON parser. The response may be * a primitive number, boolean, or quoted JSON string. * a JSON array. * a JSON object. * `null`. Examples: * `"a string configuration value"` * `120` * `true` * `null` * `{ "borderWidth": 8, "foregroundColor": "blue" }` To fetch specific value, use `GET /users/configurations/groups/{groupName}/values/{valueName}` (operation `getConfigurationGroupValue`).


/configurations/groups/{groupName}/values/{valueName}

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///users/configurations/groups/{groupName}/values/{valueName}"
import { ConfigurationApi } from "@apiture/users-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new Users.ConfigurationApi.updateConfigurationGroupValue()
var groupName = groupName_example; // {String} The unique name of this configuration group.
var valueName = valueName_example; // {String} The unique name of a value in a configuration group. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern _`letter [letter | digit | '-' | '_']*`_
var body = body_example; // {String} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.updateConfigurationGroupValue(groupName, valueName, body, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
groupName*
String
The unique name of this configuration group.
Required
valueName*
String
The unique name of a value in a configuration group. This is the name of the value in the `schema`. A `{valueName}` must be a simple identifier following the pattern _`letter [letter | digit | '-' | '_']*`_
Required
Body parameters
Name Description
body *

The request body must a valid JSON value and should be parsable with a JSON parser. The result may be a string, number, boolean, array, or object.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this configuration group resource.


updateConfigurationGroupValues

Update the values for the specified configuration group

Perform a complete replacement of this set of values


/configurations/groups/{groupName}/values

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///users/configurations/groups/{groupName}/values"
import { ConfigurationApi } from "@apiture/users-client-sdk";

const configurationApi = new ConfigurationApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
configurationApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
configurationApi.setApiKey(apiKey);


var api = new Users.ConfigurationApi.updateConfigurationGroupValues()
var groupName = groupName_example; // {String} The unique name of this configuration group.
var requestBody = ; // {map[String, configurationValue]} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If used, this must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
configurationApi.updateConfigurationGroupValues(groupName, requestBody, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
groupName*
String
The unique name of this configuration group.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If used, this must match the current entity tag of the resource.
Body parameters
Name Description
requestBody *

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`*


EmailAddress

createEmailAddress

Create a new email address

Add an email address to the list of the user's email addresses. The new email address will be `pending` until the financial institution has reviewed and approved it, after which it will become `approved`. This operation may require the user to complete an additional authentication challenge as described in _Multi-factor authentication challenges_ above. A valid `Apiture-Challenge` request header may be required if the `?replaceId` parameter is used and the profile item being replaced is the preferred email address. See _Multi-factor authentication challenges_ above.


/users/{userId}/emailAddresses

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///users/users/{userId}/emailAddresses?replaceId="
import { EmailAddressApi } from "@apiture/users-client-sdk";

const emailAddressApi = new EmailAddressApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
emailAddressApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
emailAddressApi.setApiKey(apiKey);


var api = new Users.EmailAddressApi.createEmailAddress()
var userId = userId_example; // {String} The unique identifier of the user. This is an opaque string.
var userEmailAddress = ; // {UserEmailAddress} 
var opts = {
  'replaceId': replaceId_example, // {String} An optional `_id` of an existing email address to be _replaced_ with this new email address instead of adding a new email address, once it has been approved. If `replaceId` matches the `_id` of the preferred email address the `preferredEmailAddressId` will also be updated to the value of `replaceId` once approved (the `Apiture-Challenge` header may be required also). If no existing email address matches `replaceId`, the new email address is added to the list of email addresses. Example: `?replaceId=e1`
  'apitureChallenge': apitureChallenge_example // {String} The unique identifier of a Challenge resource which demonstrates the user has recently verified their identity. See the discussion of _Multi-factor authentication challenges_ above. The value must be the `_id` string of a valid, redeemable Challenge resource which matches the challenge context.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
emailAddressApi.createEmailAddress(userId, userEmailAddress, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
userId*
String
The unique identifier of the user. This is an opaque string.
Required
Header parameters
Name Description
Apiture-Challenge
String
The unique identifier of a Challenge resource which demonstrates the user has recently verified their identity. See the discussion of _Multi-factor authentication challenges_ above. The value must be the `_id` string of a valid, redeemable Challenge resource which matches the challenge context.
Body parameters
Name Description
userEmailAddress *

The data necessary to create a new email address.

Query parameters
Name Description
replaceId
String
An optional `_id` of an existing email address to be _replaced_ with this new email address instead of adding a new email address, once it has been approved. If `replaceId` matches the `_id` of the preferred email address the `preferredEmailAddressId` will also be updated to the value of `replaceId` once approved (the `Apiture-Challenge` header may be required also). If no existing email address matches `replaceId`, the new email address is added to the list of email addresses. Example: `?replaceId=e1`

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update the resource.
Location String uri The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`scheme`*`://host`


deleteEmailAddress

Delete this email address resource

Delete this email address. The email address can only be deleted if it is _not_ the user's preferred email address.


/users/{userId}/emailAddresses/{emailAddressId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///users/users/{userId}/emailAddresses/{emailAddressId}"
import { EmailAddressApi } from "@apiture/users-client-sdk";

const emailAddressApi = new EmailAddressApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
emailAddressApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
emailAddressApi.setApiKey(apiKey);


var api = new Users.EmailAddressApi.deleteEmailAddress()
var userId = userId_example; // {String} The unique identifier of the user. This is an opaque string.
var emailAddressId = emailAddressId_example; // {String} The unique identifier of this email address. This is an opaque string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
emailAddressApi.deleteEmailAddress(userId, emailAddressId, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
userId*
String
The unique identifier of the user. This is an opaque string.
Required
emailAddressId*
String
The unique identifier of this email address. This is an opaque string.
Required

Responses


getEmailAddress

Fetch a representation of this email address

Return a [HAL](http://developer.apiture.com/docs/concepts/hal) representation of this email address resource.


/users/{userId}/emailAddresses/{emailAddressId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///users/users/{userId}/emailAddresses/{emailAddressId}"
import { EmailAddressApi } from "@apiture/users-client-sdk";

const emailAddressApi = new EmailAddressApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
emailAddressApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
emailAddressApi.setApiKey(apiKey);


var api = new Users.EmailAddressApi.getEmailAddress()
var userId = userId_example; // {String} The unique identifier of the user. This is an opaque string.
var emailAddressId = emailAddressId_example; // {String} The unique identifier of this email address. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
emailAddressApi.getEmailAddress(userId, emailAddressId, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
userId*
String
The unique identifier of the user. This is an opaque string.
Required
emailAddressId*
String
The unique identifier of this email address. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this email address resource.


getEmailAddresses

Get user's email addresses

Return the list of the user's email addresses.


/users/{userId}/emailAddresses

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///users/users/{userId}/emailAddresses"
import { EmailAddressApi } from "@apiture/users-client-sdk";

const emailAddressApi = new EmailAddressApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
emailAddressApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
emailAddressApi.setApiKey(apiKey);


var api = new Users.EmailAddressApi.getEmailAddresses()
var userId = userId_example; // {String} The unique identifier of the user. This is an opaque string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
emailAddressApi.getEmailAddresses(userId, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
userId*
String
The unique identifier of the user. This is an opaque string.
Required

Responses


setPreferredEmailAddress

Set Preferred Email Address

Set the user's preferred email address. The user may set their preferred email address to an _approved_ address by passing its unique `_id` in the `value` query parameter. This updates the `preferredEmailAddressId` property of the user. This operation may require the user to complete an additional authentication challenge as described in _Multi-factor authentication challenges_ above. A valid `Apiture-Challenge` request header may be required. This operation is available via the `apiture:setAsPreferred` link on an email address if that resource is eligible to be set as the preferred email address. No changes are made if the specified email address is already the preferred email address.


/users/{userId}/preferredEmailAddress

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///users/users/{userId}/preferredEmailAddress?value="
import { EmailAddressApi } from "@apiture/users-client-sdk";

const emailAddressApi = new EmailAddressApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
emailAddressApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
emailAddressApi.setApiKey(apiKey);


var api = new Users.EmailAddressApi.setPreferredEmailAddress()
var userId = userId_example; // {String} The unique identifier of the user. This is an opaque string.
var opts = {
  'value': value_example, // {String} The `_id` of the email address to assign as the preferred email address. If this query parameter exists, the request body, if any, is ignored. Example: `?value=pe0`
  'apitureChallenge': apitureChallenge_example // {String} The unique identifier of a Challenge resource which demonstrates the user has recently verified their identity. See the discussion of _Multi-factor authentication challenges_ above. The value must be the `_id` string of a valid, redeemable Challenge resource which matches the challenge context.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
emailAddressApi.setPreferredEmailAddress(userId, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
userId*
String
The unique identifier of the user. This is an opaque string.
Required
Header parameters
Name Description
Apiture-Challenge
String
The unique identifier of a Challenge resource which demonstrates the user has recently verified their identity. See the discussion of _Multi-factor authentication challenges_ above. The value must be the `_id` string of a valid, redeemable Challenge resource which matches the challenge context.
Query parameters
Name Description
value
String
The `_id` of the email address to assign as the preferred email address. If this query parameter exists, the request body, if any, is ignored. Example: `?value=pe0`

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this user resource.


PhoneNumber

createPhoneNumber

Create a new phone number

Add a phone number to the list of the user's phone numbers. The new number will be `pending` until the financial institution has reviewed and approved it, after which it will become `approved`. This operation may require the user to complete an additional authentication challenge as described in _Multi-factor authentication challenges_ above. A valid `Apiture-Challenge` request header may be required if the `?replaceId` parameter is used and the profile item being replaced is the preferred phone number. See _Multi-factor authentication challenges_ above.


/users/{userId}/phoneNumbers

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///users/users/{userId}/phoneNumbers?replaceId="
import { PhoneNumberApi } from "@apiture/users-client-sdk";

const phoneNumberApi = new PhoneNumberApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
phoneNumberApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
phoneNumberApi.setApiKey(apiKey);


var api = new Users.PhoneNumberApi.createPhoneNumber()
var userId = userId_example; // {String} The unique identifier of the user. This is an opaque string.
var userPhoneNumber = ; // {UserPhoneNumber} 
var opts = {
  'replaceId': replaceId_example, // {String} An optional `_id` of an existing phone number to be _replaced_ with this new phone number instead of adding a new phone number, once it has been approved. If `replaceId` matches the `_id` of the preferred phone number the `preferredPhoneNumberId` will also be updated to the value of `replaceId` once approved (the `Apiture-Challenge` header may be required also). If no existing phone number matches `replaceId`, the new phone number is added to the list of phone numbers. Example: `?replaceId=p1`
  'apitureChallenge': apitureChallenge_example // {String} The unique identifier of a Challenge resource which demonstrates the user has recently verified their identity. See the discussion of _Multi-factor authentication challenges_ above. The value must be the `_id` string of a valid, redeemable Challenge resource which matches the challenge context.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
phoneNumberApi.createPhoneNumber(userId, userPhoneNumber, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
userId*
String
The unique identifier of the user. This is an opaque string.
Required
Header parameters
Name Description
Apiture-Challenge
String
The unique identifier of a Challenge resource which demonstrates the user has recently verified their identity. See the discussion of _Multi-factor authentication challenges_ above. The value must be the `_id` string of a valid, redeemable Challenge resource which matches the challenge context.
Body parameters
Name Description
userPhoneNumber *

The data necessary to create a new phone number.

Query parameters
Name Description
replaceId
String
An optional `_id` of an existing phone number to be _replaced_ with this new phone number instead of adding a new phone number, once it has been approved. If `replaceId` matches the `_id` of the preferred phone number the `preferredPhoneNumberId` will also be updated to the value of `replaceId` once approved (the `Apiture-Challenge` header may be required also). If no existing phone number matches `replaceId`, the new phone number is added to the list of phone numbers. Example: `?replaceId=p1`

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update the resource.
Location String uri The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`scheme`*`://host`


deletePhoneNumber

Delete this phone number resource

Delete this phone number. The number can only be deleted if it is _not_ the user's preferred phone number.


/users/{userId}/phoneNumbers/{phoneNumberId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///users/users/{userId}/phoneNumbers/{phoneNumberId}"
import { PhoneNumberApi } from "@apiture/users-client-sdk";

const phoneNumberApi = new PhoneNumberApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
phoneNumberApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
phoneNumberApi.setApiKey(apiKey);


var api = new Users.PhoneNumberApi.deletePhoneNumber()
var userId = userId_example; // {String} The unique identifier of the user. This is an opaque string.
var phoneNumberId = phoneNumberId_example; // {String} The unique identifier of this phone number. This is an opaque string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
};
phoneNumberApi.deletePhoneNumber(userId, phoneNumberId, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
userId*
String
The unique identifier of the user. This is an opaque string.
Required
phoneNumberId*
String
The unique identifier of this phone number. This is an opaque string.
Required

Responses


getPhoneNumber

Fetch a representation of this phone number

Return a [HAL](http://developer.apiture.com/docs/concepts/hal) representation of this phone number resource.


/users/{userId}/phoneNumbers/{phoneNumberId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///users/users/{userId}/phoneNumbers/{phoneNumberId}"
import { PhoneNumberApi } from "@apiture/users-client-sdk";

const phoneNumberApi = new PhoneNumberApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
phoneNumberApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
phoneNumberApi.setApiKey(apiKey);


var api = new Users.PhoneNumberApi.getPhoneNumber()
var userId = userId_example; // {String} The unique identifier of the user. This is an opaque string.
var phoneNumberId = phoneNumberId_example; // {String} The unique identifier of this phone number. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
phoneNumberApi.getPhoneNumber(userId, phoneNumberId, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
userId*
String
The unique identifier of the user. This is an opaque string.
Required
phoneNumberId*
String
The unique identifier of this phone number. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this phone number resource.


getPhoneNumbers

Get user's phone numbers

Return the list of the user's phone numbers


/users/{userId}/phoneNumbers

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///users/users/{userId}/phoneNumbers"
import { PhoneNumberApi } from "@apiture/users-client-sdk";

const phoneNumberApi = new PhoneNumberApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
phoneNumberApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
phoneNumberApi.setApiKey(apiKey);


var api = new Users.PhoneNumberApi.getPhoneNumbers()
var userId = userId_example; // {String} The unique identifier of the user. This is an opaque string.

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
phoneNumberApi.getPhoneNumbers(userId, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
userId*
String
The unique identifier of the user. This is an opaque string.
Required

Responses


setPreferredPhoneNumber

Set Preferred Phone Number

Set the user's preferred phone number. The user may set their preferred phone number to an _approved_ number by passing its unique `_id` in the `value` query parameter. This updates the `preferredPhoneNumberId` property of the user. This operation may require the user to complete an additional authentication challenge as described in _Multi-factor authentication challenges_ above. A valid `Apiture-Challenge` request header may be required. This operation is available via the `apiture:setAsPreferred` link on an phone number if that resource is eligible to be set as the preferred phone number. No changes are made if the specified phone number is already the preferred phone number.


/users/{userId}/preferredPhoneNumber

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///users/users/{userId}/preferredPhoneNumber?value="
import { PhoneNumberApi } from "@apiture/users-client-sdk";

const phoneNumberApi = new PhoneNumberApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
phoneNumberApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
phoneNumberApi.setApiKey(apiKey);


var api = new Users.PhoneNumberApi.setPreferredPhoneNumber()
var userId = userId_example; // {String} The unique identifier of the user. This is an opaque string.
var opts = {
  'value': value_example, // {String} The `_id` of the number to assign as the preferred phone number. If this query parameter exists, the request body, if any, is ignored. Example: `?value=pe0`
  'apitureChallenge': apitureChallenge_example // {String} The unique identifier of a Challenge resource which demonstrates the user has recently verified their identity. See the discussion of _Multi-factor authentication challenges_ above. The value must be the `_id` string of a valid, redeemable Challenge resource which matches the challenge context.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
phoneNumberApi.setPreferredPhoneNumber(userId, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
userId*
String
The unique identifier of the user. This is an opaque string.
Required
Header parameters
Name Description
Apiture-Challenge
String
The unique identifier of a Challenge resource which demonstrates the user has recently verified their identity. See the discussion of _Multi-factor authentication challenges_ above. The value must be the `_id` string of a valid, redeemable Challenge resource which matches the challenge context.
Query parameters
Name Description
value
String
The `_id` of the number to assign as the preferred phone number. If this query parameter exists, the request body, if any, is ignored. Example: `?value=pe0`

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this user resource.


User

createUser

Create a new user


/users

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///users/users"
import { UserApi } from "@apiture/users-client-sdk";

const userApi = new UserApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
userApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
userApi.setApiKey(apiKey);


var api = new Users.UserApi.createUser()
var createUser = ; // {CreateUser} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
userApi.createUser(createUser, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Body parameters
Name Description
createUser *

The data necessary to create a new user.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update the resource.
Location String uri The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`schema`*`://host`

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update the resource.
Location String uri The URI of the new resource. If the URI begins with / it is relative to the API root context. Else, it is a full URI starting with *`schema`*`://host`

getUser

Fetch a representation of this user

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this user resource. This representation will contain links related to the current user as defined in the `user` schema.


/users/{userId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///users/users/{userId}"
import { UserApi } from "@apiture/users-client-sdk";

const userApi = new UserApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
userApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
userApi.setApiKey(apiKey);


var api = new Users.UserApi.getUser()
var userId = userId_example; // {String} The unique identifier of the user. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
userApi.getUser(userId, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
userId*
String
The unique identifier of the user. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this user resource.


getUserConstraints

Fetch a representation of this user's constraints

Return a [HAL](https://developer.apiture.com/docs/concepts/hal) representation of this user's constraints resource. Constraints are limits and other values established for the user, such as single or daily transfer limits.


/users/{userId}/constraints

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///users/users/{userId}/constraints"
import { UserApi } from "@apiture/users-client-sdk";

const userApi = new UserApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
userApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
userApi.setApiKey(apiKey);


var api = new Users.UserApi.getUserConstraints()
var userId = userId_example; // {String} The unique identifier of the user. This is an opaque string.
var opts = {
  'ifNoneMatch': ifNoneMatch_example // {String} The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
userApi.getUserConstraints(userId, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
userId*
String
The unique identifier of the user. This is an opaque string.
Required
Header parameters
Name Description
If-None-Match
String
The entity tag that was returned in the `ETag` response. If the resource's current entity tag matches, the `GET` will return 304 (Not Modified) and no response body, else the resource representation will be returned.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this user resource.


getUsers

Return a collection of users

Use this endpoint to retrieve a [paginated](https://developer.apiture.com/docs/concepts/pagination), [sortable](https://developer.apiture.com/docs/concepts/sorting), [filterable](https://developer.apiture.com/docs/concepts/filtering), [searchable](https://developer.apiture.com/docs/concepts/searchable) collection of users. An authenticated user will have access only to their User resource. The [links](https://developer.apiture.com/docs/concepts/links) in the response include collecton pagination links. Each resource in the `_embedded.items` array is a summary representation of a user; use the `getUser` opertion on the summary's `self` link to get the full representation of the user and all available links.


/users

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///users/users?start=&limit=&sortBy=&filter=&q=&state=&customerId=&occupation="
import { UserApi } from "@apiture/users-client-sdk";

const userApi = new UserApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
userApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
userApi.setApiKey(apiKey);


var api = new Users.UserApi.getUsers()
var opts = {
  'start': 789, // {Long} The zero-based index of the first user in this page. The default, 0, represents the first page of the collection.
  'limit': 56, // {Integer} The maximum number of user representations to return in this page.
  'sortBy': sortBy_example, // {String} Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
  'filter': filter_example, // {String} Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'q': q_example, // {String} Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
  'state': state_example, // {String} Subset the users collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=removed|inactive` matches items whose `state` is `removed` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'customerId': customerId_example, // {String} Subset the users collection to those whose `customerId` matches this value. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'occupation': occupation_example // {String} Subset the users collection to those with this name value. Use `|` to separate multiple values. For example, ?occupation=officeAndAdministrativeSupport will match only items whose occupation is officeAndAdministrativeSupport; ?occupation=officeAndAdministrativeSupport|transportationAndMaterialMoving will match items whose occupation is officeAndAdministrativeSupport or transportationAndMaterialMoving. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
userApi.getUsers(opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first user in this page. The default, 0, represents the first page of the collection.
limit
Integer (int32)
The maximum number of user representations to return in this page.
sortBy
String
Optional sort criteria. See [sort criteria format](https://developer.apiture.com/docs/concepts/sorting), such as `?sortBy=field1,-field2`.
filter
String
Optional filter criteria. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
q
String
Optional search string. See [searching](https://developer.apiture.com/docs/concepts/searching).
state
String
Subset the users collection to those whose `state` matches this value. Use `|` to separate multiple values. For example, `?state=pending` matches only items whose `state` is `pending`; `?state=removed|inactive` matches items whose `state` is `removed` or `inactive`. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
customerId
String
Subset the users collection to those whose `customerId` matches this value. This is combined with an implicit `and` with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
occupation
String
Subset the users collection to those with this name value. Use `|` to separate multiple values. For example, ?occupation=officeAndAdministrativeSupport will match only items whose occupation is officeAndAdministrativeSupport; ?occupation=officeAndAdministrativeSupport|transportationAndMaterialMoving will match items whose occupation is officeAndAdministrativeSupport or transportationAndMaterialMoving. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).

Responses


patchUser

Update this user

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


/users/{userId}

Usage and SDK Samples

curl -X PATCH -H "API-Key: [[apiKey]]" "http:///users/users/{userId}"
import { UserApi } from "@apiture/users-client-sdk";

const userApi = new UserApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
userApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
userApi.setApiKey(apiKey);


var api = new Users.UserApi.patchUser()
var userId = userId_example; // {String} The unique identifier of the user. This is an opaque string.
var user = ; // {User} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If used, this must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
userApi.patchUser(userId, user, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
userId*
String
The unique identifier of the user. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If used, this must match the current entity tag of the resource.
Body parameters
Name Description
user *

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this user resource.


patchUserConstraints

Update this user's constraints

Perform a partial update of this user's constraints, a user should not be able to change their own limits. Fields which are omitted are not updated.


/users/{userId}/constraints

Usage and SDK Samples

curl -X PATCH -H "API-Key: [[apiKey]]" "http:///users/users/{userId}/constraints"
import { UserApi } from "@apiture/users-client-sdk";

const userApi = new UserApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
userApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
userApi.setApiKey(apiKey);


var api = new Users.UserApi.patchUserConstraints()
var userId = userId_example; // {String} The unique identifier of the user. This is an opaque string.
var updateConstraints = ; // {UpdateConstraints} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If used, this must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
userApi.patchUserConstraints(userId, updateConstraints, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
userId*
String
The unique identifier of the user. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If used, this must match the current entity tag of the resource.
Body parameters
Name Description
updateConstraints *

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this user resource.


updateUser

Update this user

Perform a complete replacement of this user.


/users/{userId}

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///users/users/{userId}"
import { UserApi } from "@apiture/users-client-sdk";

const userApi = new UserApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
userApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
userApi.setApiKey(apiKey);


var api = new Users.UserApi.updateUser()
var userId = userId_example; // {String} The unique identifier of the user. This is an opaque string.
var user = ; // {User} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If used, this must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
userApi.updateUser(userId, user, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
userId*
String
The unique identifier of the user. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If used, this must match the current entity tag of the resource.
Body parameters
Name Description
user *

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this user resource.


updateUserConstraints

Update this user's constraints

Perform a complete replacement of this user's constraints. This operation is performed by an admin. A user cannot change their own limits.


/users/{userId}/constraints

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///users/users/{userId}/constraints"
import { UserApi } from "@apiture/users-client-sdk";

const userApi = new UserApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
userApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
userApi.setApiKey(apiKey);


var api = new Users.UserApi.updateUserConstraints()
var userId = userId_example; // {String} The unique identifier of the user. This is an opaque string.
var updateConstraints = ; // {UpdateConstraints} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If used, this must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
userApi.updateUserConstraints(userId, updateConstraints, opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Path parameters
Name Description
userId*
String
The unique identifier of the user. This is an opaque string.
Required
Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If used, this must match the current entity tag of the resource.
Body parameters
Name Description
updateConstraints *

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this user resource.


UserActions

activateUser

Activate a user

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 operation will fail if the user is frozen or locked unless an FI admin is invoking the operation. This changes the `state` to `active`.


/activeUsers

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///users/activeUsers?user="
import { UserActionsApi } from "@apiture/users-client-sdk";

const userActionsApi = new UserActionsApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
userActionsApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
userActionsApi.setApiKey(apiKey);


var api = new Users.UserActionsApi.activateUser()
var opts = {
  'user': user_example, // {String} The ID or URI of an existing user which is eligible to be removed.
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If used, this must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
userActionsApi.activateUser(opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If used, this must match the current entity tag of the resource.
Query parameters
Name Description
user
String
The ID or URI of an existing user which is eligible to be removed.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this user resource.


deactivateUser

Deactivate a user

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`.


/inactiveUsers

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///users/inactiveUsers?user="
import { UserActionsApi } from "@apiture/users-client-sdk";

const userActionsApi = new UserActionsApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
userActionsApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
userActionsApi.setApiKey(apiKey);


var api = new Users.UserActionsApi.deactivateUser()
var opts = {
  'user': user_example, // {String} The ID or URI of an existing user which is eligible to be removed.
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If used, this must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
userActionsApi.deactivateUser(opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If used, this must match the current entity tag of the resource.
Query parameters
Name Description
user
String
The ID or URI of an existing user which is eligible to be removed.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this user resource.


freezeUser

Freeze a user

Freeze a user from an active, inactive or locked state. A state of frozen indicates that an admin has a concern of fraud. This operation is invoked from the `apiture:freeze` link on a user resource when an admin user has suspicion of fraud. Only admin has access to freeze a user. This changes the `state` to `frozen`.


/frozenUsers

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///users/frozenUsers?user="
import { UserActionsApi } from "@apiture/users-client-sdk";

const userActionsApi = new UserActionsApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
userActionsApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
userActionsApi.setApiKey(apiKey);


var api = new Users.UserActionsApi.freezeUser()
var opts = {
  'user': user_example, // {String} The ID or URI of an existing user which is eligible to be frozen.
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If used, this must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
userActionsApi.freezeUser(opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If used, this must match the current entity tag of the resource.
Query parameters
Name Description
user
String
The ID or URI of an existing user which is eligible to be frozen.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this user resource.


lockUser

Lock a user

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`.


/lockedUsers

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///users/lockedUsers?user="
import { UserActionsApi } from "@apiture/users-client-sdk";

const userActionsApi = new UserActionsApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
userActionsApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
userActionsApi.setApiKey(apiKey);


var api = new Users.UserActionsApi.lockUser()
var opts = {
  'user': user_example, // {String} The ID or URI of an existing user which is eligible to be removed.
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If used, this must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
userActionsApi.lockUser(opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If used, this must match the current entity tag of the resource.
Query parameters
Name Description
user
String
The ID or URI of an existing user which is eligible to be removed.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this user resource.


mergeUsers

Merge a set of users

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`.


/mergedUsers

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///users/mergedUsers"
import { UserActionsApi } from "@apiture/users-client-sdk";

const userActionsApi = new UserActionsApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
userActionsApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
userActionsApi.setApiKey(apiKey);


var api = new Users.UserActionsApi.mergeUsers()
var mergeUsers = ; // {MergeUsers} 

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
userActionsApi.mergeUsers(mergeUsers, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Body parameters
Name Description
mergeUsers *

The data necessary to merge users.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this user resource.


removeUser

Remove a user

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`.


/removedUsers

Usage and SDK Samples

curl -X POST -H "API-Key: [[apiKey]]" "http:///users/removedUsers?user="
import { UserActionsApi } from "@apiture/users-client-sdk";

const userActionsApi = new UserActionsApi(configuration);

// Configure OAuth2 access token for authorization: accessToken
var accessToken = "YOUR ACCESS TOKEN";
userActionsApi.setAccessToken(accessToken)

// Configure API key authorization: apiKey
var apiKey = "YOUR API KEY";
userActionsApi.setApiKey(apiKey);


var api = new Users.UserActionsApi.removeUser()
var opts = {
  'user': user_example, // {String} The ID or URI of an existing user which is eligible to be removed.
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. If used, this must match the current entity tag of the resource.
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
userActionsApi.removeUser(opts, callback);

Scopes

profiles/read Read access to user and contact related resources.
profiles/write Write (update) access to user and contact related resources.
profiles/delete Delete access to user and contact related resources.
profiles/readPii Read access to personally identifiable information such as tax ID numbers, phone numbers, email and postal addresses. This must be granted in addition to the `profiles/read` scope in order to read such data, but is included in the `profiles/full` scope.
profiles/full Full access to user and contact related resources.
admin/read Read access to system configuration.
admin/write Write (update) access to user and contact related resources just for administrative roles.
admin/delete Delete access to system configuration.
admin/full Full access to system configuration.

Parameters

Header parameters
Name Description
If-Match
String
The entity tag that was returned in the `ETag` response. If used, this must match the current entity tag of the resource.
Query parameters
Name Description
user
String
The ID or URI of an existing user which is eligible to be removed.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which may be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this user resource.