Access Management Administration v0.3.1

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

The Access Management API controls roles and permissions within the ADB platform designated for software applications used by Apiture employees and Financial Institution (FI) administrators.

Access roles are assigned to users to set the roles they may perform in the application, such as Viewer, Contributor, Analyst, Administrator, etc. Access roles are comprised of one or more access permissions. Access permissions grant software application users the ability to perform specific actions within the application, such as creating, reading, or updating application resources.

Each application defines its own roles. Different applications may choose to use the same role names, but they are independent of one another. Thus, a user with the Administrator role in application A does not imply the user has the Administrator role in application B, or that those two Administrator roles share the same permissions.

Granting authorization to use software applications is done through the identity provider and is out of scope for the Access Management Administration API.

Download OpenAPI Definition (YAML)

Base URLs:

• https://api.apiture.com/bankingAdmin

Terms of service

Email: Apiture Web: Apiture

License: Apiture API License

Authentication

• API Key (apiKey)
  • header parameter: API-Key
  • API Key based client identification. See details at Secure Access.

• OpenID Connect authentication (accessToken)
  • OpenId Connect (OIDC) authentication/authorization. The client uses the authorization_endpoint and token_endpoint to obtain an access token to pass in the Authorization header. Those endpoints are available via the OIDC Configuration URL. The actual URL may vary with each financial institution. See details at Secure Access.
  • OIDC Configuration URL = https://auth.apiture.com/oidc/.well-known/openid-configuration

Software Applications

Software Applications

listSoftwareApplications

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/softwareApplications \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/bankingAdmin/softwareApplications HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/softwareApplications',
{
  method: 'GET',

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

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/softwareApplications',
  method: 'get',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/bankingAdmin/softwareApplications',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/bankingAdmin/softwareApplications', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/bankingAdmin/softwareApplications", data)
    req.Header = headers

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

Return a collection of software applications

GET https://api.apiture.com/bankingAdmin/softwareApplications

Return a collection of software applications.

Example responses

200 Response

{
  "items": [
    {
      "id": "0399abed-fd3d",
      "name": "Developer Portal",
      "description": "A software application for managing developer resources."
    },
    {
      "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
      "name": "Data Portal",
      "description": "A software application for performing analysis for Financial Institutions."
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

getSoftwareApplication

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId} HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}',
{
  method: 'GET',

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

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}',
  method: 'get',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}", data)
    req.Header = headers

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

Fetch a representation of this software application

GET https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}

Return the JSON representation of this software application resource.

Parameters

Parameter	Description
softwareApplicationId in: path	resourceId (required) The unique identifier of this software application. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "name": "Developer Portal",
  "description": "A software application for managing developer resources."
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Access Roles

Access Roles

listAccessRoles

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessRoles \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessRoles HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessRoles',
{
  method: 'GET',

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

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessRoles',
  method: 'get',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessRoles',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessRoles', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessRoles");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessRoles", data)
    req.Header = headers

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

Return a list of access roles

GET https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessRoles

Return a list of access roles for a software application.

Parameters

Parameter	Description
softwareApplicationId in: path	resourceId (required) The unique identifier of this software application. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "items": [
    {
      "id": "0399abed-fd3d",
      "name": "Audience Contributor",
      "description": "An audience contributor is an analyst who can make changes to properties within a customer audience.",
      "accessPermissions": [
        {
          "key": "audiences/write",
          "label": "Create and Update Customer Audiences"
        },
        {
          "key": "audiences/read",
          "label": "View Customer Audiences"
        }
      ]
    },
    {
      "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
      "name": "Audience Owner",
      "description": "The owner of a customer audience. Owners can manage contributors within a customer audience, as well as any entitlements granted with lower roles related to customer audiences.",
      "accessPermissions": [
        {
          "key": "audiences/write",
          "label": "Create and Update Customer Audiences"
        },
        {
          "key": "audiences/read",
          "label": "View Customer Audiences"
        },
        {
          "key": "audienceOwners/write",
          "label": "Assign Customer Audience Owners"
        }
      ]
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

getAccessRole

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessRoles/{accessRoleId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessRoles/{accessRoleId} HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessRoles/{accessRoleId}',
{
  method: 'GET',

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

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessRoles/{accessRoleId}',
  method: 'get',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessRoles/{accessRoleId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessRoles/{accessRoleId}', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessRoles/{accessRoleId}");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessRoles/{accessRoleId}", data)
    req.Header = headers

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

Fetch a representation of this access role

GET https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessRoles/{accessRoleId}

Return the JSON representation of this access role resource.

Parameters

Parameter	Description
accessRoleId in: path	resourceId (required) The unique identifier of this access role. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
softwareApplicationId in: path	resourceId (required) The unique identifier of this software application. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "id": "fc2f9ed1-cf81",
  "name": "Audience Contributor",
  "accessPermissions": [
    {
      "key": "audiences/write",
      "label": "Create and Update Customer Audiences"
    },
    {
      "key": "audiences/read",
      "label": "View Customer Audiences"
    }
  ],
  "description": "An audience contributor is an analyst who can make changes to properties within a customer audience."
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Access Permissions

Access Permissions

listAccessPermissions

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessPermissions \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessPermissions HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessPermissions',
{
  method: 'GET',

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

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessPermissions',
  method: 'get',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessPermissions',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessPermissions', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessPermissions");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("GET");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessPermissions", data)
    req.Header = headers

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

Return a list of access permissions

GET https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/accessPermissions

Return a list of access permissions associated with a software application.

Parameters

Parameter	Description
softwareApplicationId in: path	resourceId (required) The unique identifier of this software application. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "items": [
    {
      "key": "insightOwners/write",
      "label": "Create and Update Insight Owners"
    },
    {
      "key": "insightOwners/read",
      "label": "View Insight Owners"
    },
    {
      "key": "audiences/write",
      "label": "Create and Update Customer Audiences"
    },
    {
      "key": "audiences/read",
      "label": "View Customer Audiences"
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Software Application Users

Software Application Users

listSoftwareApplicationUsers

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/users \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/users HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/users',
{
  method: 'GET',

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

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/users',
  method: 'get',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/users',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/users', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/users", data)
    req.Header = headers

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

Return a list of users of this software application

GET https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/users

Return a list of active users of the software application. The user representation includes user properties that are immutable in the scope of this API, such as ID, name, username, and the timestamp of the last login. The representation also includes the user's assigned access roles for the software application, which may be change via the patchSoftwareApplicationUserAccessRoles operation.

Parameters

Parameter	Description
softwareApplicationId in: path	resourceId (required) The unique identifier of this software application. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "items": [
    {
      "id": "0399abed-fd3d",
      "firstName": "Benny",
      "lastName": "Billings",
      "username": "bbillings",
      "lastLoggedInAt": "2023-10-27T08:53:07Z",
      "accessRoles": [
        {
          "id": "fc2f9ed1-cf81",
          "name": "Audience Contributor"
        }
      ]
    },
    {
      "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
      "firstName": "Benny",
      "lastName": "Billings",
      "username": "bbillings",
      "lastLoggedInAt": "2023-10-25T09:44:17Z",
      "accessRoles": [
        {
          "id": "fc2f9ed1-cf81",
          "name": "Audience Contributor"
        }
      ]
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

getSoftwareApplicationUser

Code samples

# You can also use wget
curl -X GET https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/users/{softwareApplicationUserId} \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

GET https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/users/{softwareApplicationUserId} HTTP/1.1
Host: api.apiture.com
Accept: application/json

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

const headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/users/{softwareApplicationUserId}',
{
  method: 'GET',

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

var headers = {
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/users/{softwareApplicationUserId}',
  method: 'get',

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

require 'rest-client'
require 'json'

headers = {
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.get 'https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/users/{softwareApplicationUserId}',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.get('https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/users/{softwareApplicationUserId}', params={

}, headers = headers)

print r.json()

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

package main

import (
       "bytes"
       "net/http"
)

func main() {

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

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("GET", "https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/users/{softwareApplicationUserId}", data)
    req.Header = headers

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

Fetch a representation of this user

GET https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/users/{softwareApplicationUserId}

Return the JSON representation of this user resource.

Parameters

Parameter	Description
softwareApplicationUserId in: path	resourceId (required) The unique identifier of this software application user. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
softwareApplicationId in: path	resourceId (required) The unique identifier of this software application. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "firstName": "Benny",
  "lastName": "Billings",
  "username": "bbillings",
  "lastLoggedInAt": "2023-10-27T08:53:07Z",
  "accessRoles": [
    {
      "id": "fc2f9ed1-cf81",
      "name": "Audience Contributor"
    }
  ],
  "effectiveAccessPermissions": [
    {
      "key": "audiences/write",
      "label": "Create and Update Customer Audiences"
    },
    {
      "key": "audiences/read",
      "label": "View Customer Audiences"
    },
    {
      "key": "audiences/share",
      "label": "Share Audiences with Additional Analysts"
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

patchSoftwareApplicationUserAccessRoles

Code samples

# You can also use wget
curl -X PATCH https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/users/{softwareApplicationUserId}/accessRoles \
  -H 'Content-Type: application/merge-patch+json' \
  -H 'Accept: application/json' \
  -H 'Authorization: Bearer {access-token}'

PATCH https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/users/{softwareApplicationUserId}/accessRoles HTTP/1.1
Host: api.apiture.com
Content-Type: application/merge-patch+json
Accept: application/json

const fetch = require('node-fetch');
const inputBody = '{
  "accessRoles": [
    {
      "id": "fc2f9ed1-cf81",
      "name": "Audience Contributor"
    }
  ]
}';
const headers = {
  'Content-Type':'application/merge-patch+json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

fetch('https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/users/{softwareApplicationUserId}/accessRoles',
{
  method: 'PATCH',
  body: inputBody,
  headers: headers
})
.then(function(res) {
    return res.json();
}).then(function(body) {
    console.log(body);
});

var headers = {
  'Content-Type':'application/merge-patch+json',
  'Accept':'application/json',
  'Authorization':'Bearer {access-token}'

};

$.ajax({
  url: 'https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/users/{softwareApplicationUserId}/accessRoles',
  method: 'patch',

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

require 'rest-client'
require 'json'

headers = {
  'Content-Type' => 'application/merge-patch+json',
  'Accept' => 'application/json',
  'Authorization' => 'Bearer {access-token}'
}

result = RestClient.patch 'https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/users/{softwareApplicationUserId}/accessRoles',
  params: {
  }, headers: headers

p JSON.parse(result)

import requests
headers = {
  'Content-Type': 'application/merge-patch+json',
  'Accept': 'application/json',
  'Authorization': 'Bearer {access-token}'
}

r = requests.patch('https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/users/{softwareApplicationUserId}/accessRoles', params={

}, headers = headers)

print r.json()

URL obj = new URL("https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/users/{softwareApplicationUserId}/accessRoles");
HttpURLConnection con = (HttpURLConnection) obj.openConnection();
con.setRequestMethod("PATCH");
int responseCode = con.getResponseCode();
BufferedReader in = new BufferedReader(
    new InputStreamReader(con.getInputStream()));
String inputLine;
StringBuffer response = new StringBuffer();
while ((inputLine = in.readLine()) != null) {
    response.append(inputLine);
}
in.close();
System.out.println(response.toString());

package main

import (
       "bytes"
       "net/http"
)

func main() {

    headers := map[string][]string{
        "Content-Type": []string{"application/merge-patch+json"},
        "Accept": []string{"application/json"},
        "Authorization": []string{"Bearer {access-token}"},
        
    }

    data := bytes.NewBuffer([]byte{jsonReq})
    req, err := http.NewRequest("PATCH", "https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/users/{softwareApplicationUserId}/accessRoles", data)
    req.Header = headers

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

Update the assigned access roles of a software application user

PATCH https://api.apiture.com/bankingAdmin/softwareApplications/{softwareApplicationId}/users/{softwareApplicationUserId}/accessRoles

Perform a partial update of this user as per JSON Merge Patch format and processing rules. Only fields in the request body are updated on the resource; fields which are omitted are not updated.

Body parameter

{
  "accessRoles": [
    {
      "id": "fc2f9ed1-cf81",
      "name": "Audience Contributor"
    }
  ]
}

Parameters

Parameter	Description
body	softwareApplicationUserAccessRolesPatch (required) The fields to update within the user.
softwareApplicationUserId in: path	resourceId (required) The unique identifier of this software application user. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
softwareApplicationId in: path	resourceId (required) The unique identifier of this software application. This is an opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

Example responses

200 Response

{
  "id": "0399abed-fd3d",
  "firstName": "Benny",
  "lastName": "Billings",
  "username": "bbillings",
  "lastLoggedInAt": "2023-10-27T08:53:07Z",
  "accessRoles": [
    {
      "id": "fc2f9ed1-cf81",
      "name": "Audience Contributor"
    }
  ],
  "effectiveAccessPermissions": [
    {
      "key": "audiences/write",
      "label": "Create and Update Customer Audiences"
    },
    {
      "key": "audiences/read",
      "label": "View Customer Audiences"
    },
    {
      "key": "audiences/share",
      "label": "Share Audiences with Additional Analysts"
    }
  ]
}

Responses

Response Schema

Status Code 400

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 401

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 403

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 404

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 429

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 4XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Status Code 5XX

Property Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
» type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". maxLength: 2048
» title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. maxLength: 120
» status	integer(int32) The HTTP status code for this occurrence of the problem. minimum: 100 maximum: 599
» detail	string(text) A human-readable explanation specific to this occurrence of the problem. maxLength: 256
» instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment maxLength: 2048
» id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: ^[-_:.~$a-zA-Z0-9]{6,48}$
» occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. minLength: 20 maxLength: 30
» problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128
» attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

Schemas

accessPermissionItem

{
  "key": "insightOwners/write",
  "label": "Create and Update Insight Owners"
}

Access Permission Item (v1.0.0)

Summary representation of an access permission resource in access permissions collections. To fetch the full representation of this access permission, use the getAccessPermission operation, passing this item's id field as the accessPermissionId path parameter.

Properties

Name	Description
Access Permission Item (v1.0.0)	object Summary representation of an access permission resource in access permissions collections. To fetch the full representation of this access permission, use the getAccessPermission operation, passing this item's id field as the accessPermissionId path parameter.
key	string([\/-_.:a-zA-Z0-9]{1,40}) (required) The name of the key used within access management claims by the identity provider. format: [\/-_.:a-zA-Z0-9]{1,40} minLength: 1 maxLength: 40
label	string(text) (required) The self-descriptive human-readable text label for the access permission. format: text minLength: 1 maxLength: 255

accessPermissions

{
  "items": [
    {
      "key": "insightOwners/write",
      "label": "Create and Update Insight Owners"
    },
    {
      "key": "insightOwners/read",
      "label": "View Insight Owners"
    },
    {
      "key": "audiences/write",
      "label": "Create and Update Customer Audiences"
    },
    {
      "key": "audiences/read",
      "label": "View Customer Audiences"
    }
  ]
}

Access Permission Collection (v1.0.0)

Collection of access permissions. The items in the collection are ordered in the items array.

Properties

Name	Description
Access Permission Collection (v1.0.0)	object Collection of access permissions. The items in the collection are ordered in the items array.
items	array: [accessPermissionItem] (required) An array containing access permission items. unique items maxItems: 250 items: object

accessRole

{
  "id": "fc2f9ed1-cf81",
  "name": "Audience Contributor",
  "accessPermissions": [
    {
      "key": "audiences/write",
      "label": "Create and Update Customer Audiences"
    },
    {
      "key": "audiences/read",
      "label": "View Customer Audiences"
    }
  ],
  "description": "An audience contributor is an analyst who can make changes to properties within a customer audience."
}

Access Role (v1.0.0)

Representation of an access role resource. Describes an access role assignable to a user. An access role is composed of one or more access permissions, for a software application.

Properties

Name	Description
Access Role (v1.0.0)	object Representation of an access role resource. Describes an access role assignable to a user. An access role is composed of one or more access permissions, for a software application.
name	string(text) The human readable name describing this access role. Access role names are unique within their owning software application. format: text minLength: 1 maxLength: 255
description	string(text) A description of the access role. format: text maxLength: 255
default	boolean If true, this access role is the default assigned access role for the owning software application. Only one access role may be assigned as the default role for a software application. default: false
id	readOnlyResourceId The unique identifier for this access role resource. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
accessPermissions	array: [accessPermissionItem] The unique fine-grained access permissions encapsulated by this access role. unique items maxItems: 250 items: object

accessRoleItem

{
  "id": "fc2f9ed1-cf81",
  "name": "Audience Contributor",
  "accessPermissions": [
    {
      "key": "audiences/write",
      "label": "Create and Update Customer Audiences"
    },
    {
      "key": "audiences/read",
      "label": "View Customer Audiences"
    }
  ]
}

Access Role Item (v1.0.0)

Summary representation of an access role resource in access roles collections. To fetch the full representation of this access role, use the getAccessRole operation, passing this item's id field as the accessRoleId path parameter.

Properties

Name	Description
Access Role Item (v1.0.0)	object Summary representation of an access role resource in access roles collections. To fetch the full representation of this access role, use the getAccessRole operation, passing this item's id field as the accessRoleId path parameter.
name	string(text) The human readable name describing this access role. Access role names are unique within their owning software application. format: text minLength: 1 maxLength: 255
description	string(text) A description of the access role. format: text maxLength: 255
default	boolean If true, this access role is the default assigned access role for the owning software application. Only one access role may be assigned as the default role for a software application. default: false
id	readOnlyResourceId The unique identifier for this access role resource. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
accessPermissions	array: [accessPermissionItem] The unique fine-grained access permissions encapsulated by this access role. unique items maxItems: 250 items: object

accessRoles

{
  "items": [
    {
      "id": "0399abed-fd3d",
      "name": "Audience Contributor",
      "description": "An audience contributor is an analyst who can make changes to properties within a customer audience.",
      "accessPermissions": [
        {
          "key": "audiences/write",
          "label": "Create and Update Customer Audiences"
        },
        {
          "key": "audiences/read",
          "label": "View Customer Audiences"
        }
      ]
    },
    {
      "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
      "name": "Audience Owner",
      "description": "The owner of a customer audience. Owners can manage contributors within a customer audience, as well as any entitlements granted with lower roles related to customer audiences.",
      "accessPermissions": [
        {
          "key": "audiences/write",
          "label": "Create and Update Customer Audiences"
        },
        {
          "key": "audiences/read",
          "label": "View Customer Audiences"
        },
        {
          "key": "audienceOwners/write",
          "label": "Assign Customer Audience Owners"
        }
      ]
    }
  ]
}

Access Role Collection (v1.0.0)

Collection of access roles. The items in the collection are ordered in the items array.

Properties

Name	Description
Access Role Collection (v1.0.0)	object Collection of access roles. The items in the collection are ordered in the items array.
items	array: [accessRoleItem] (required) An array containing a list of access role items. unique items maxItems: 100 items: object

apiProblem

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://production.api.apiture.com/errors/accountNotFound/v1.0.0",
  "title": "Account Not Found",
  "status": 422,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "No account exists at the given account_url",
  "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

API Problem (v1.2.1)

API problem or error, as per RFC 7807 application/problem+json.

Properties

Name	Description
API Problem (v1.2.1)	object API problem or error, as per RFC 7807 application/problem+json.
type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". format: uri-reference maxLength: 2048
title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. format: text maxLength: 120
status	integer(int32) The HTTP status code for this occurrence of the problem. format: int32 minimum: 100 maximum: 599
detail	string(text) A human-readable explanation specific to this occurrence of the problem. format: text maxLength: 256
instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment format: uri-reference maxLength: 2048
id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. read-only format: date-time minLength: 20 maxLength: 30
problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 items: object

challengeFactor

{
  "type": "sms",
  "labels": [
    "9876"
  ]
}

Challenge Factor (v1.2.1)

A challenge factor. See requiredIdentityChallenge for multiple examples.

Properties

Name	Description
Challenge Factor (v1.2.1)	object A challenge factor. See requiredIdentityChallenge for multiple examples.
id	challengeFactorId The ID of an a challenge factor. This ID is unique within the challenge factors associated with a challenge. The client should pass this id value as the factorId when starting or verifying a challenge factor. Note: The id will become required in a future update to this schema. minLength: 3 maxLength: 48 pattern: "^[-a-zA-Z0-9$_]{3,48}$"
type	challengeFactorType (required) The name of challenge factor. challengeFactorType strings may have one of the following enumerated values: Value Description sms SMS: One-time passcode sent to the primary mobile phone number email Email: One-time passcode sent to the primary email address voice Voice: One-time passcode communicated via automated voice phone call authenticatorToken authenticator Token: One-time passcode issued by a pre-registered hardware device, such as a token key fob, or an authenticator app securityQuestions Security Questions: Prompt with the user's security questions registered with their security profile enum values: sms, email, voice, securityQuestions, authenticatorToken
labels	array: [string] A list of text label which identifies the channel(s) through which the user completes the challenge. For an sms or voice challenge, the only label item is the last four digits of the corresponding phone number. For an email challenge, each label is the masked email address. minItems: 1 maxItems: 4 items: string(text) » format: text » maxLength: 300
securityQuestions	challengeSecurityQuestions Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions.

challengeFactorId

"string"

Challenge Factor ID (v1.0.0)

The ID of an a challenge factor. This ID is unique within the factors offered with a challenge.

type: string

minLength: 3
maxLength: 48
pattern: "^[-a-zA-Z0-9$_]{3,48}$"

challengeFactorType

"sms"

Challenge Factor Type (v1.0.0)

The name of challenge factor.

challengeFactorType strings may have one of the following enumerated values:

Value	Description
sms	SMS: One-time passcode sent to the primary mobile phone number
email	Email: One-time passcode sent to the primary email address
voice	Voice: One-time passcode communicated via automated voice phone call
authenticatorToken	authenticator Token: One-time passcode issued by a pre-registered hardware device, such as a token key fob, or an authenticator app
securityQuestions	Security Questions: Prompt with the user's security questions registered with their security profile

type: string

enum values: sms, email, voice, securityQuestions, authenticatorToken

challengeOperationId

"string"

Challenge Operation ID (v1.0.1)

The ID of an operation/action for which the user must verify their identity via an identity challenge. This is passed when starting a challenge factor or when validating the identity challenge responses.

type: string

minLength: 6
maxLength: 48
pattern: "^[-a-zA-Z0-9$_]{6,48}$"

challengePromptId

"string"

Challenge Prompt ID (v1.0.0)

The unique ID of a prompt (such as a security question) in a challenge factor.

type: string

minLength: 1
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]+$"

challengeSecurityQuestion

{
  "id": "74699fa628911e762ea5",
  "prompt": "What is your mother's maiden name?"
}

Challenge Security Question (v1.0.1)

A single security question within the questions array of the challengeSecurityQuestions

Properties

Name	Description
Challenge Security Question (v1.0.1)	object A single security question within the questions array of the challengeSecurityQuestions
id	challengePromptId (required) The unique ID of security question prompt. This should be included in the challengeVerification response as the promptId. minLength: 1 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]+$"
prompt	string(text) (required) The text prompt of this security question. format: text maxLength: 80

challengeSecurityQuestions

{
  "questions": [
    {
      "id": "q1",
      "prompt": "What is your mother's maiden name?"
    },
    {
      "id": "q4",
      "prompt": "What is your high school's name?"
    },
    {
      "id": "q9",
      "prompt": "What is the name of your first pet?"
    }
  ]
}

Challenge Security Questions (v1.0.1)

Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions.

Properties

Name	Description
Challenge Security Questions (v1.0.1)	object Describes a securityQuestions challenge. This is omitted if the challenge type is not securityQuestions.
questions	array: [challengeSecurityQuestion] (required) The array of security questions. minItems: 1 maxItems: 8 items: object

customerUsername

"string"

Customer Username (v2.0.0)

A customer's login username.

type: string(text)

format: text
minLength: 5
maxLength: 20

problemResponse

{
  "id": "3fbad566-be86-4b22-9ba6-3ca99fdc0799",
  "type": "https://production.api.apiture.com/errors/noSuchAccount/v1.0.0",
  "title": "Account Not Found",
  "status": 422,
  "occurredAt": "2022-04-25T12:42:21.375Z",
  "detail": "No account exists for the given account reference",
  "instance": "https://production.api.apiture.com/banking/transfers/bb709151-575041fcd617"
}

Problem Response (v0.4.1)

API problem or error response, as per RFC 9457 application/problem+json.

Properties

Name	Description
Problem Response (v0.4.1)	object API problem or error response, as per RFC 9457 application/problem+json.
type	string(uri-reference) A URI reference (RFC3986) that identifies the problem type. If present, this is the URL of human-readable HTML documentation for the problem type. When this member is not present, its value is assumed to be "about:blank". format: uri-reference maxLength: 2048
title	string(text) A short, human-readable summary of the problem type. The title is usually the same for all problem with the same type. format: text maxLength: 120
status	integer(int32) The HTTP status code for this occurrence of the problem. format: int32 minimum: 100 maximum: 599
detail	string(text) A human-readable explanation specific to this occurrence of the problem. format: text maxLength: 256
instance	string(uri-reference) A URI reference that identifies the specific occurrence of the problem. This is the URI of an API resource that the problem is related to, with a unique error correlation ID URI fragment format: uri-reference maxLength: 2048
id	readOnlyResourceId The unique identifier for this problem. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
occurredAt	readOnlyTimestamp(date-time) The timestamp when the problem occurred, in RFC 3339 date-time YYYY-MM-DDThh:mm:ss.sssZ format, UTC. read-only format: date-time minLength: 20 maxLength: 30
problems	array: [apiProblem] Optional root-causes if there are multiple problems in the request or API call processing. maxItems: 128 items: object
attributes	object Additional optional attributes related to the problem. This data conforms to the schema associated with the error type.

readOnlyResourceId

"string"

Read-only Resource Identifier (v1.0.1)

The unique, opaque system-assigned identifier for a resource. This case-sensitive ID is also used in URLs as path parameters or in other properties or parameters that reference a resource by ID rather than URL. Resource IDs are immutable.

type: string

read-only
minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

readOnlyTimestamp

"2021-10-30T19:06:04.250Z"

Read-Only Timestamp (v1.0.0)

A readonly or derived timestamp (an instant in time) formatted in RFC 3339 date-time UTC format: YYYY-MM-DDThh:mm:ss.sssZ.

type: string(date-time)

read-only
format: date-time
minLength: 20
maxLength: 30

requiredIdentityChallenge

{
  "operationId": "createTransfer",
  "challengeId": "0504076c566a3cf7009c",
  "factors": [
    {
      "type": "sms",
      "labels": [
        "9876"
      ],
      "id": "85c0ee5753fcd0b0953f"
    },
    {
      "type": "voice",
      "labels": [
        "9876"
      ],
      "id": "d089e10a80a8627df37b"
    },
    {
      "type": "voice",
      "labels": [
        "6754"
      ],
      "id": "10506ecf9d1c2ee00403"
    },
    {
      "type": "email",
      "labels": [
        "an****nk@example.com",
        "an****98@example.com"
      ],
      "id": "e917d671cb2f030b56f1"
    },
    {
      "type": "authenticatorToken",
      "labels": [
        "Acme fob"
      ],
      "id": "fe6c452d7da0bbb4e407"
    },
    {
      "type": "securityQuestions",
      "securityQuestions": {
        "questions": [
          {
            "id": "q1",
            "prompt": "What is your mother's maiden name?"
          },
          {
            "id": "q4",
            "prompt": "What is your high school's name?"
          },
          {
            "id": "q9",
            "prompt": "What is the name of your first pet?"
          }
        ]
      },
      "id": "df33c6f88a37d6b3f0a6"
    }
  ]
}

Required Challenge (v1.2.3)

A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 Unauthorized problem response when the 401 problem type name is challengeRequired. See the "Challenge API" for details.

Properties

Name	Description
Required Challenge (v1.2.3)	object A request from the service for the user to verify their identity. This contains a challenge ID, the corresponding operation ID, and a list of challenge factors for identity verification. The user must complete one of these challenge factors to satisfy the challenge. This schema defines the attributes in the 401 Unauthorized problem response when the 401 problem type name is challengeRequired. See the "Challenge API" for details.
operationId	challengeOperationId (required) The ID of an operation/action for which the user must verify their identity via an identity challenge. This is passed when starting a challenge factor or when validating the identity challenge responses. minLength: 6 maxLength: 48 pattern: "^[-a-zA-Z0-9$_]{6,48}$"
challengeId	readOnlyResourceId (required) The unique ID of this challenge instance. This is an opaque string. This is passed when starting a challenge factor or when validating the identity challenge responses. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
factors	array: [challengeFactor] (required) A list of challenge factors. The user must complete one of these challenge factors. The labels in each factor identify one or more channels the user may use, such as a list of email addresses the system may use to send a one-time passcode to the user. *Note: The same channel may be used by multiple factors in the array of factors. For example, the user's primary mobile phone number may be used for both an sms factor and a voice factor. minItems: 1 maxItems: 8 items: object

resourceId

"string"

Resource Identifier (v1.0.1)

The unique, opaque system identifier for a resource. This case-sensitive ID is also used as path parameters in URLs or in other properties or parameters that reference a resource by ID rather than URL.

type: string

minLength: 6
maxLength: 48
pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

softwareApplication

{
  "id": "0399abed-fd3d",
  "name": "Developer Portal",
  "description": "A software application for managing developer resources."
}

Software Application (v1.0.0)

Representation of a software application resource. Describes a software application within the ADB platform.

Properties

Name	Description
Software Application (v1.0.0)	object Representation of a software application resource. Describes a software application within the ADB platform.
name	string(text) (required) The human readable name of this software application resource. format: text minLength: 1 maxLength: 80
description	string(text) A description of the software application resource. format: text minLength: 1 maxLength: 255
id	readOnlyResourceId (required) The unique identifier for this software application resource. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

softwareApplicationItem

{
  "id": "0399abed-fd3d",
  "name": "Developer Portal",
  "description": "A software application for managing developer resources."
}

Software Application Item (v1.0.0)

Summary representation of a software application resource in software applications collections. To fetch the full representation of this software application, use the getSoftwareApplication operation, passing this item's id field as the softwareApplicationId path parameter.

Properties

Name	Description
Software Application Item (v1.0.0)	object Summary representation of a software application resource in software applications collections. To fetch the full representation of this software application, use the getSoftwareApplication operation, passing this item's id field as the softwareApplicationId path parameter.
name	string(text) (required) The human readable name of this software application resource. format: text minLength: 1 maxLength: 80
description	string(text) A description of the software application resource. format: text minLength: 1 maxLength: 255
id	readOnlyResourceId (required) The unique identifier for this software application resource. This is an immutable opaque string. read-only minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"

softwareApplicationUser

{
  "id": "0399abed-fd3d",
  "firstName": "Benny",
  "lastName": "Billings",
  "username": "bbillings",
  "lastLoggedInAt": "2023-10-27T08:53:07Z",
  "accessRoles": [
    {
      "id": "fc2f9ed1-cf81",
      "name": "Audience Contributor"
    }
  ],
  "effectiveAccessPermissions": [
    {
      "key": "audiences/write",
      "label": "Create and Update Customer Audiences"
    },
    {
      "key": "audiences/read",
      "label": "View Customer Audiences"
    },
    {
      "key": "audiences/share",
      "label": "Share Audiences with Additional Analysts"
    }
  ]
}

Software Application User (v1.1.0)

Representation of a software application user resource.

Properties

Name	Description
Software Application User (v1.1.0)	object Representation of a software application user resource.
accessRoles	array: [accessRoleItem] (required) A list of the access roles assigned to this user within the context of this software application. maxItems: 100 items: object
id	resourceId (required) The immutable, unique, opaque identifier for the user. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
firstName	string(text) (required) The user's first name. format: text maxLength: 56
lastName	string(text) (required) The user's last name. format: text maxLength: 56
username	customerUsername(text) (required) The user's login name. format: text minLength: 5 maxLength: 20
lastLoggedInAt	readOnlyTimestamp(date-time) The date and time of the most recent successful login for this software application user. This is expressed in RFC 3339 YYYY-MM-DDThh:mm:ss.sssZ date-time format in UTC time zone. read-only format: date-time minLength: 20 maxLength: 30
effectiveAccessPermissions	array: [accessPermissionItem] A list of calculated access permissions for this software application user. read-only unique items maxItems: 250 items: object

softwareApplicationUserAccessRolesPatch

{
  "accessRoles": [
    {
      "id": "fc2f9ed1-cf81",
      "name": "Audience Contributor"
    }
  ]
}

Patch Software Application User Access Roles (v1.0.0)

Request body to update assigned access roles for a user within the context of a software application. This completely replaces the user's assigned roles for the software application. Use an empty array ([]) to revert to the default roles for the application.

Properties

Name	Description
Patch Software Application User Access Roles (v1.0.0)	object Request body to update assigned access roles for a user within the context of a software application. This completely replaces the user's assigned roles for the software application. Use an empty array ([]) to revert to the default roles for the application.
accessRoles	array: [object] unique items maxItems: 100 items: object
» id	resourceId The unique identifier for this access role resource. This is an immutable opaque string. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
» name	string(text) The human readable name describing this access role. This is included for informational purposes and is not evaluated as part of the patch operation. format: text minLength: 1 maxLength: 255

softwareApplicationUserItem

{
  "id": "0399abed-fd3d",
  "firstName": "Benny",
  "lastName": "Billings",
  "username": "bbillings",
  "lastLoggedInAt": "2023-10-27T08:53:07Z",
  "accessRoles": [
    {
      "id": "fc2f9ed1-cf81",
      "name": "Audience Contributor"
    }
  ]
}

User Item (v1.0.0)

Summary representation of an user resource in software application users collection. To fetch the full representation of this user, use the getSoftwareApplicationUser operation, passing this item's id field as the userId path parameter.

Properties

Name	Description
User Item (v1.0.0)	object Summary representation of an user resource in software application users collection. To fetch the full representation of this user, use the getSoftwareApplicationUser operation, passing this item's id field as the userId path parameter.
accessRoles	array: [accessRoleItem] (required) A list of the access roles assigned to this user within the context of this software application. maxItems: 100 items: object
id	resourceId (required) The immutable, unique, opaque identifier for the user. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
firstName	string(text) (required) The user's first name. format: text maxLength: 56
lastName	string(text) (required) The user's last name. format: text maxLength: 56
username	customerUsername(text) (required) The user's login name. format: text minLength: 5 maxLength: 20
lastLoggedInAt	readOnlyTimestamp(date-time) The date and time of the most recent successful login for this software application user. This is expressed in RFC 3339 YYYY-MM-DDThh:mm:ss.sssZ date-time format in UTC time zone. read-only format: date-time minLength: 20 maxLength: 30

softwareApplicationUsers

{
  "items": [
    {
      "id": "0399abed-fd3d",
      "firstName": "Benny",
      "lastName": "Billings",
      "username": "bbillings",
      "lastLoggedInAt": "2023-10-27T08:53:07Z",
      "accessRoles": [
        {
          "id": "fc2f9ed1-cf81",
          "name": "Audience Contributor"
        }
      ]
    },
    {
      "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
      "firstName": "Benny",
      "lastName": "Billings",
      "username": "bbillings",
      "lastLoggedInAt": "2023-10-25T09:44:17Z",
      "accessRoles": [
        {
          "id": "fc2f9ed1-cf81",
          "name": "Audience Contributor"
        }
      ]
    }
  ]
}

Software Application Users Collection (v1.0.0)

Collection of users for a software application.

Properties

Name	Description
Software Application Users Collection (v1.0.0)	object Collection of users for a software application.
items	array: [softwareApplicationUserItem] (required) An array containing of user items. unique items maxItems: 1000 items: object

softwareApplications

{
  "items": [
    {
      "id": "0399abed-fd3d",
      "name": "Developer Portal",
      "description": "A software application for managing developer resources."
    },
    {
      "id": "d62c0701-0d74-4836-83f9-ebf3709442ea",
      "name": "Data Portal",
      "description": "A software application for performing analysis for Financial Institutions."
    }
  ]
}

Software Application Collection (v1.0.0)

Collection of software applications. The items in the collection are ordered in the items array.

Properties

Name	Description
Software Application Collection (v1.0.0)	object Collection of software applications. The items in the collection are ordered in the items array.
items	array: [softwareApplicationItem] (required) An array containing software application items. maxItems: 100 items: object

userAccountReference

{
  "id": "0399abed-fd3d",
  "firstName": "Benny",
  "lastName": "Billings",
  "username": "bbillings"
}

User Account Reference (v2.0.0)

The representation of a user account.

Properties

Name	Description
User Account Reference (v2.0.0)	object The representation of a user account.
id	resourceId (required) The immutable, unique, opaque identifier for the user. minLength: 6 maxLength: 48 pattern: "^[-_:.~$a-zA-Z0-9]{6,48}$"
firstName	string(text) (required) The user's first name. format: text maxLength: 56
lastName	string(text) (required) The user's last name. format: text maxLength: 56
username	customerUsername(text) (required) The user's login name. format: text minLength: 5 maxLength: 20

---