Link

Link

A Link is a set of credentials associated to a end-user access to an Institution.

Constructor

Source:

Extends

Members

(constant) RECURRENT :string

Source:
Type:
  • string

(constant) RECURRENT :string

Source:
Type:
  • string

(constant) SINGLE :string

Source:
Type:
  • string

(constant) SINGLE :string

Source:
Type:
  • string

Methods

(async) delete(id) → {boolean}

Delete specific record.

Overrides:
Source:
Parameters:
Name Type Description
id string

UUID4 representation of the resource Id.

Returns:
Type:
boolean

When the record is successfuly deleted returns true, otherwise false.

(async) detail(id) → {object}

Get specific record details.

Overrides:
Source:
Parameters:
Name Type Description
id string

UUID4 representation of the resource Id.

Throws:
Returns:
Type:
object

(async) list(params) → {array}

Get a list of resources.

Overrides:
Source:
Parameters:
Name Type Description
params Object

Receives two parameters.

Name Type Attributes Default Description
limit number <optional>
100

Maximum number of results.

filters Object <optional>
{}

Filters to get custom results.

Throws:
Returns:
Type:
array

List of results.

(async) patch(id, options) → {object}

Patch an existing link.

Source:
Parameters:
Name Type Description
id string

UUID4 representation of the link Id.

options object

Optional parameters (accessMode).

Throws:
Returns:
Type:
object

Link data updated.

(async) patch(id, options) → {object}

Patch an existing link.

Source:
Parameters:
Name Type Description
id string

UUID4 representation of the link Id.

options object

Optional parameters (accessMode).

Throws:
Returns:
Type:
object

Link data updated.

(async) register(institution, username, password, options) → {object}

Register a new link.

Source:
Parameters:
Name Type Description
institution string

Institution's code.

username string

Username used to sign in online by the end-user.

password string

Password used to sign in online by the end-user.

options object

Optional parameters (token, usernameType, username2, username3, password2, accessMode, certificate, privateKey, externalId).

Throws:
Returns:
Type:
object

Newly created link.

(async) register(institution, username, password, options) → {object}

Register a new link.

Source:
Parameters:
Name Type Description
institution string

Institution's code.

username string

Username used to sign in online by the end-user.

password string

Password used to sign in online by the end-user.

options object

Optional parameters (token, usernameType, username2, username3, password2, accessMode, certificate, privateKey, externalId).

Throws:
Returns:
Type:
object

Newly created link.

(async) resume(session, token, link) → {object}

Resume a "pending" session that requires an OTP token. Use this function to resume sessions that returned HTTP 428 status code.

Overrides:
Source:
Parameters:
Name Type Description
session string

UUID4 representation of a "pending" session.

token string

OTP token.

link string

UUID4 representation of the link being used.

Throws:
Returns:
Type:
object

Response.

(async) token(id, scopes) → {object}

Request scoped tokens to operate with a single link

Source:
Parameters:
Name Type Description
id string

UUID4 representation of the link Id.

scopes string

List of comma separated scopes

Throws:
Returns:
Type:
object

Response

(async) token(id, scopes) → {object}

Request scoped tokens to operate with a single link

Source:
Parameters:
Name Type Description
id string

UUID4 representation of the link Id.

scopes string

List of comma separated scopes

Throws:
Returns:
Type:
object

Response

(async) update(id, password, options) → {object}

Update link's password and password2. Use this function when you want to update the link credentials. Only updating passwords is available.

Source:
Parameters:
Name Type Description
id string

UUID4 representation of the link Id.

password string

New password.

options object

Optional parameters (token, password2, usernameType, certificate, privateKey).

Throws:
Returns:
Type:
object

Response

(async) update(id, password, options) → {object}

Update link's password and password2. Use this function when you want to update the link credentials. Only updating passwords is available.

Source:
Parameters:
Name Type Description
id string

UUID4 representation of the link Id.

password string

New password.

options object

Optional parameters (token, password2, usernameType, certificate, privateKey).

Throws:
Returns:
Type:
object

Response

Link

A Link is a set of credentials associated to a end-user access to an Institution.

Constructor

Source:

Extends

Members

(constant) RECURRENT :string

Source:
Type:
  • string

(constant) RECURRENT :string

Source:
Type:
  • string

(constant) SINGLE :string

Source:
Type:
  • string

(constant) SINGLE :string

Source:
Type:
  • string

Methods

(async) delete(id) → {boolean}

Delete specific record.

Overrides:
Source:
Parameters:
Name Type Description
id string

UUID4 representation of the resource Id.

Returns:
Type:
boolean

When the record is successfuly deleted returns true, otherwise false.

(async) detail(id) → {object}

Get specific record details.

Overrides:
Source:
Parameters:
Name Type Description
id string

UUID4 representation of the resource Id.

Throws:
Returns:
Type:
object

(async) list(params) → {array}

Get a list of resources.

Overrides:
Source:
Parameters:
Name Type Description
params Object

Receives two parameters.

Name Type Attributes Default Description
limit number <optional>
100

Maximum number of results.

filters Object <optional>
{}

Filters to get custom results.

Throws:
Returns:
Type:
array

List of results.

(async) patch(id, options) → {object}

Patch an existing link.

Source:
Parameters:
Name Type Description
id string

UUID4 representation of the link Id.

options object

Optional parameters (accessMode).

Throws:
Returns:
Type:
object

Link data updated.

(async) patch(id, options) → {object}

Patch an existing link.

Source:
Parameters:
Name Type Description
id string

UUID4 representation of the link Id.

options object

Optional parameters (accessMode).

Throws:
Returns:
Type:
object

Link data updated.

(async) register(institution, username, password, options) → {object}

Register a new link.

Source:
Parameters:
Name Type Description
institution string

Institution's code.

username string

Username used to sign in online by the end-user.

password string

Password used to sign in online by the end-user.

options object

Optional parameters (token, usernameType, username2, username3, password2, accessMode, certificate, privateKey, externalId).

Throws:
Returns:
Type:
object

Newly created link.

(async) register(institution, username, password, options) → {object}

Register a new link.

Source:
Parameters:
Name Type Description
institution string

Institution's code.

username string

Username used to sign in online by the end-user.

password string

Password used to sign in online by the end-user.

options object

Optional parameters (token, usernameType, username2, username3, password2, accessMode, certificate, privateKey, externalId).

Throws:
Returns:
Type:
object

Newly created link.

(async) resume(session, token, link) → {object}

Resume a "pending" session that requires an OTP token. Use this function to resume sessions that returned HTTP 428 status code.

Overrides:
Source:
Parameters:
Name Type Description
session string

UUID4 representation of a "pending" session.

token string

OTP token.

link string

UUID4 representation of the link being used.

Throws:
Returns:
Type:
object

Response.

(async) token(id, scopes) → {object}

Request scoped tokens to operate with a single link

Source:
Parameters:
Name Type Description
id string

UUID4 representation of the link Id.

scopes string

List of comma separated scopes

Throws:
Returns:
Type:
object

Response

(async) token(id, scopes) → {object}

Request scoped tokens to operate with a single link

Source:
Parameters:
Name Type Description
id string

UUID4 representation of the link Id.

scopes string

List of comma separated scopes

Throws:
Returns:
Type:
object

Response

(async) update(id, password, options) → {object}

Update link's password and password2. Use this function when you want to update the link credentials. Only updating passwords is available.

Source:
Parameters:
Name Type Description
id string

UUID4 representation of the link Id.

password string

New password.

options object

Optional parameters (token, password2, usernameType, certificate, privateKey).

Throws:
Returns:
Type:
object

Response

(async) update(id, password, options) → {object}

Update link's password and password2. Use this function when you want to update the link credentials. Only updating passwords is available.

Source:
Parameters:
Name Type Description
id string

UUID4 representation of the link Id.

password string

New password.

options object

Optional parameters (token, password2, usernameType, certificate, privateKey).

Throws:
Returns:
Type:
object

Response