Associations

API

getApi

Top-level resources and operations in this API

Return links to the top-level resources and operations in this API. This API returns the following links: *`apiture:associations`* : links to the collection of associations held at this financial institution. *`apiture:roles`* : links to the collection of roles held at this financial institution.


/

Usage and SDK Samples

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

const aPIApi = new APIApi(configuration);

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


var api = new Associations.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:///associations/apiDoc"
import { APIApi } from "@apiture/associations-client-sdk";

const aPIApi = new APIApi(configuration);

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


var api = new Associations.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


Association

createAssociation

Create a new association

Create a new association between two resources. The request must include a valid link (`apiture:source`) to a source resource, (`apiture:role`) to an association role instance and a link (`apiture:target`) to a target resource.


/associations

Usage and SDK Samples

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

const associationApi = new AssociationApi(configuration);

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

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


var api = new Associations.AssociationApi.createAssociation()
var createAssociation = ; // {CreateAssociation} 

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

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Body parameters
Name Description
createAssociation *

The data necessary to create a new association.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must 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`


deleteAssociation

Delete this association resource

Delete this association resource and any resources that are owned by it. Deleting an association does not delete the source, role, or target resources.


/associations/{associationId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///associations/associations/{associationId}"
import { AssociationApi } from "@apiture/associations-client-sdk";

const associationApi = new AssociationApi(configuration);

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

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


var api = new Associations.AssociationApi.deleteAssociation()
var associationId = associationId_example; // {String} The unique identifier of this association. This is an opaque string.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. 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.');
  }
};
associationApi.deleteAssociation(associationId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

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

Responses


getAssociation

Fetch a representation of this association

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


/associations/{associationId}

Usage and SDK Samples

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

const associationApi = new AssociationApi(configuration);

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

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


var api = new Associations.AssociationApi.getAssociation()
var associationId = associationId_example; // {String} The unique identifier of this association. 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);
  }
};
associationApi.getAssociation(associationId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
associationId*
String
The unique identifier of this association. 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 must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this association resource.


getAssociations

Return a collection of associations.

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 associations. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.


/associations

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///associations/associations?start=&limit=&sortBy=&filter=&q=&name=&type=&label="
import { AssociationApi } from "@apiture/associations-client-sdk";

const associationApi = new AssociationApi(configuration);

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

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


var api = new Associations.AssociationApi.getAssociations()
var opts = {
  'start': 789, // {Long} The zero-based index of the first association item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of association 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).
  'name': name_example, // {String} Subset the collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` will match only items whose name is Bartell; `?name=Bartell|kirsten` will match items whose name is Bartell or kirsten. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'type': type_example, // {String} Subset the associations collection to those with this exact type value. Use `|` to separate multiple values. For example, `?type=Personal%20Savings` matches only items whose type is Personal Savings; `?type=Personal%20Savings|Investment%20Account` matches items whose type is Personal Savings or Investment Account. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'label': label_example // {String} Subset the collection to those with this label value. Use `|` to separate multiple values. For example, `?label=email_verification` matches only items whose label is `email_verification`; `?label=email_verification|account_verification` matches items whose label is `email_verification` or `account_verification`. 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);
  }
};
associationApi.getAssociations(opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first association item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of association 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).
name
String
Subset the collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` will match only items whose name is Bartell; `?name=Bartell|kirsten` will match items whose name is Bartell or kirsten. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
type
String
Subset the associations collection to those with this exact type value. Use `|` to separate multiple values. For example, `?type=Personal%20Savings` matches only items whose type is Personal Savings; `?type=Personal%20Savings|Investment%20Account` matches items whose type is Personal Savings or Investment Account. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
label
String
Subset the collection to those with this label value. Use `|` to separate multiple values. For example, `?label=email_verification` matches only items whose label is `email_verification`; `?label=email_verification|account_verification` matches items whose label is `email_verification` or `account_verification`. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).

Responses


patchAssociation

Update this association

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


/associations/{associationId}

Usage and SDK Samples

curl -X PATCH -H "API-Key: [[apiKey]]" "http:///associations/associations/{associationId}"
import { AssociationApi } from "@apiture/associations-client-sdk";

const associationApi = new AssociationApi(configuration);

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

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


var api = new Associations.AssociationApi.patchAssociation()
var associationId = associationId_example; // {String} The unique identifier of this association. This is an opaque string.
var updateAssociation = ; // {UpdateAssociation} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. 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);
  }
};
associationApi.patchAssociation(associationId, updateAssociation, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

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

Responses

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


Role

createRole

Create a new role

Create a new role which is used to associate two resources.


/roles

Usage and SDK Samples

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

const roleApi = new RoleApi(configuration);

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

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


var api = new Associations.RoleApi.createRole()
var createRole = ; // {CreateRole} 

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

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Body parameters
Name Description
createRole *

The data necessary to create a new role.

Responses

Name Type Format Description
ETag String The `ETag` response header specifies an entity tag which must 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`


deleteRole

Delete this role resource

Delete this role resource and any resources that are owned by it. A role cannot be deleted if it is in use in an association.


/roles/{roleId}

Usage and SDK Samples

curl -X DELETE -H "API-Key: [[apiKey]]" "http:///associations/roles/{roleId}"
import { RoleApi } from "@apiture/associations-client-sdk";

const roleApi = new RoleApi(configuration);

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

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


var api = new Associations.RoleApi.deleteRole()
var roleId = roleId_example; // {String} The unique identifier of this role. This is an opaque string.
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. 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.');
  }
};
roleApi.deleteRole(roleId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

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

Responses


getRole

Fetch a representation of this role

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


/roles/{roleId}

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///associations/roles/{roleId}"
import { RoleApi } from "@apiture/associations-client-sdk";

const roleApi = new RoleApi(configuration);

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

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


var api = new Associations.RoleApi.getRole()
var roleId = roleId_example; // {String} The unique identifier of this role. 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);
  }
};
roleApi.getRole(roleId, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Path parameters
Name Description
roleId*
String
The unique identifier of this role. 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 must be provided in an `If-Match` request header for *`PUT`* or *`PATCH`* operations which update this role resource.


getRoles

Return a collection of roles

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 roles. The [links](https://developer.apiture.com/docs/concepts/links) in the response include pagination links.


/roles

Usage and SDK Samples

curl -X GET -H "API-Key: [[apiKey]]" "http:///associations/roles?start=&limit=&sortBy=&filter=&q=&name=&label="
import { RoleApi } from "@apiture/associations-client-sdk";

const roleApi = new RoleApi(configuration);

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

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


var api = new Associations.RoleApi.getRoles()
var opts = {
  'start': 789, // {Long} The zero-based index of the first role item to include in this page. The default 0 denotes the beginning of the collection.
  'limit': 56, // {Integer} The maximum number of role 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).
  'name': name_example, // {String} Subset the collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` will match only items whose name is Bartell; `?name=Bartell|kirsten` will match items whose name is Bartell or kirsten. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
  'label': label_example // {String} Subset the collection to those with this label value. Use `|` to separate multiple values. For example, `?label=email_verification` matches only items whose label is `email_verification`; `?label=email_verification|account_verification` matches items whose label is `email_verification` or `account_verification`. 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);
  }
};
roleApi.getRoles(opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

Query parameters
Name Description
start
Long (int64)
The zero-based index of the first role item to include in this page. The default 0 denotes the beginning of the collection.
limit
Integer (int32)
The maximum number of role 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).
name
String
Subset the collection to those with this name value. Use `|` to separate multiple values. For example, `?name=Bartell` will match only items whose name is Bartell; `?name=Bartell|kirsten` will match items whose name is Bartell or kirsten. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).
label
String
Subset the collection to those with this label value. Use `|` to separate multiple values. For example, `?label=email_verification` matches only items whose label is `email_verification`; `?label=email_verification|account_verification` matches items whose label is `email_verification` or `account_verification`. This is combined with an implicit and with other filters if they are used. See [filtering](https://developer.apiture.com/docs/concepts/filtering).

Responses


patchRole

Update this role

Perform a partial update of this role. Fields which are omitted are not updated. Nested `_embedded` and `_links` are ignored if included.


/roles/{roleId}

Usage and SDK Samples

curl -X PATCH -H "API-Key: [[apiKey]]" "http:///associations/roles/{roleId}"
import { RoleApi } from "@apiture/associations-client-sdk";

const roleApi = new RoleApi(configuration);

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

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


var api = new Associations.RoleApi.patchRole()
var roleId = roleId_example; // {String} The unique identifier of this role. This is an opaque string.
var updateRole = ; // {UpdateRole} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. 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);
  }
};
roleApi.patchRole(roleId, updateRole, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

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

Responses

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


updateRole

Update this role

Perform a complete replacement of this role.


/roles/{roleId}

Usage and SDK Samples

curl -X PUT -H "API-Key: [[apiKey]]" "http:///associations/roles/{roleId}"
import { RoleApi } from "@apiture/associations-client-sdk";

const roleApi = new RoleApi(configuration);

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

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


var api = new Associations.RoleApi.updateRole()
var roleId = roleId_example; // {String} The unique identifier of this role. This is an opaque string.
var updateRole = ; // {UpdateRole} 
var opts = {
  'ifMatch': ifMatch_example // {String} The entity tag that was returned in the `ETag` response. 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);
  }
};
roleApi.updateRole(roleId, updateRole, opts, callback);

Scopes

data/read Read access to non-account, non-profile data.
data/write Write (update) access to non-account, non-profile data.
data/delete Delete access to non-account, non-profile data.
data/full Full access to non-account, non-profile data.

Parameters

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

Responses

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