Following subsections list MCP Server Tools that can be used to interact with the MCP Server.
Accept Presence Subscription
Accepts a presence subscription request from another user.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
Yes |
AcceptPresenceSubscription(From)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.XMPP.Tools.Presence.Accept |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
From |
String |
Required |
- |
Bare JID of the sender of the presence subscription request to accept. |
Add Photo Attachment (BASE64 upload)
Adds a photo attachment to an identity application, by providing a BASE64-encoded binary of the photo together with its corresponding Content-Type.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
No |
AddPhotoAttachmentBase64Upload(LegalId, Base64Photo, ContentTypePhoto, PhotoType)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Identity.Tools.Attachment.Add |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
LegalId |
String |
Required |
- |
Legal Identity Identifier or Identity resource URI to which the attachment shall be added. |
Base64Photo |
String |
Required |
- |
BASE64-encoded photo to be uploaded. |
ContentTypePhoto |
String |
Required |
- |
Content-Type of the photo to be uploaded. |
PhotoType |
PhotoType |
Optional |
"ProfilePhoto" |
Type of photo to be uploaded. Possible values:
"ProfilePhoto" - Profile photo."Passport" - Photo of passport."IdCardFront" - Front of ID card."IdCardBack" - Back of ID card."DriverLicenseFront" - Front of Driver’s License."DriverLicenseBack" - Back of Driver’s License.
|
Adds a photo attachment to an identity application, by eliciting the user for the photo.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
No |
AddPhotoAttachmentElicitation(LegalId, PhotoType)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Identity.Tools.Attachment.Add |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
LegalId |
String |
Required |
- |
Legal Identity Identifier or Identity resource URI to which the attachment shall be added. |
PhotoType |
PhotoType |
Optional |
"ProfilePhoto" |
Type of photo to be uploaded. Possible values:
"ProfilePhoto" - Profile photo."Passport" - Photo of passport."IdCardFront" - Front of ID card."IdCardBack" - Back of ID card."DriverLicenseFront" - Front of Driver’s License."DriverLicenseBack" - Back of Driver’s License.
|
Add Photo Attachment (URL Download)
Adds a photo attachment to an identity application, by providing a URL to the photo to be downloaded and then added as an attachment.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
No |
AddPhotoAttachmentUrlDownload(LegalId, PhotoUrl, PhotoType)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Identity.Tools.Attachment.Add |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
LegalId |
String |
Required |
- |
Legal Identity Identifier or Identity resource URI to which the attachment shall be added. |
PhotoUrl |
URI |
Required |
- |
URL of the photo to be downloaded. |
PhotoType |
PhotoType |
Optional |
"ProfilePhoto" |
Type of photo to be uploaded. Possible values:
"ProfilePhoto" - Profile photo."Passport" - Photo of passport."IdCardFront" - Front of ID card."IdCardBack" - Back of ID card."DriverLicenseFront" - Front of Driver’s License."DriverLicenseBack" - Back of Driver’s License.
|
Add to Roster
Adds a contact to the roster of the XMPP account associated with the MCP Client.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
Yes |
AddToRoster(BareJid, NickName, Groups)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.XMPP.Tools.Roster.Add |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
BareJid |
String |
Required |
- |
Bare JID of the contact to add to roster. |
NickName |
String |
Optional |
null |
Optional nick name of the contact to add to roster. |
Groups |
Array of String |
Optional |
null |
Optional groups to which the contact should be added. |
Append Binary File
Appends a binary file in account-specific file storage. If the file does not exist, one is created.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
No |
AppendBinaryFile(LocalFileName, Content)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Files.Tools.Append |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
LocalFileName |
String |
Required |
- |
Local file name. Must not contain double period characters or begin with a path character, to attempt to escape file storage area. File extension must match Internet Content-Type of file contents. |
Content |
String |
Required |
- |
BASE-64 encoded binary content of file to append. The contents must not be harmful, be executable, or contain illegal information. |
| Return Value |
| Type |
Description |
| String |
URI of appended file resource. |
Append Text File
Appends a text file in account-specific file storage. If the file does not exist, one is created. Text contents is stored UTF-8 encoded (with a Byte-Order-Mark (BOM) if the file is created).
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
No |
AppendTextFile(LocalFileName, Content, AppendCrLf)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Files.Tools.Append |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
LocalFileName |
String |
Required |
- |
Local file name. Must not contain double period characters or begin with a path character, to attempt to escape file storage area. File extension must match Internet Content-Type of file contents. |
Content |
String |
Required |
- |
Text content of file to append. The contents must not be harmful or contain illegal information. |
AppendCrLf |
Boolean |
Required |
- |
If true, a carriage-return/line-feed (CRLF) is appended to the text content before appending it to the file. |
| Return Value |
| Type |
Description |
| String |
URI of appended file resource. |
Apply For New Personal Identity
Applies for a new personal identity. Personal information will be elicited from the user.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
Yes |
| Is Idempotent: |
No |
| Open World Access: |
No |
ApplyForNewPersonalIdentity()
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Identity.Tools.Apply |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
Buy eDaler
Buy eDaler using a service provider for buying eDaler.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
Yes |
BuyEDaler(Id, Type, Amount, Currency)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Payments.Tools.EDaler.Buy |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
Id |
String |
Required |
- |
Service Provider ID for buying eDaler. |
Type |
String |
Required |
- |
Service Provider Type for buying eDaler. |
Amount |
Decimal-precision floating-point |
Required |
- |
Amount of eDaler to buy. [1,∞) |
Currency |
String |
Required |
- |
Currency of the amount to buy. |
Compromise Identity
Reports one of the identities or identity applications registered by the user as compromised.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
Yes |
| Is Idempotent: |
No |
| Open World Access: |
No |
CompromiseIdentity(LegalId)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Identity.Tools.Compromise |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
LegalId |
String |
Required |
- |
Legal Identity Identifier or Identity resource URI to report as compromised. |
| Return Value |
| Type |
Description |
IdentityResponse |
Identity compromised report result. |
Create Binary File
Creates a binary file in account-specific file storage. If a file with the same name exists, it is replaced.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
Yes |
| Open World Access: |
No |
CreateBinaryFile(LocalFileName, Content)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Files.Tools.Create |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
LocalFileName |
String |
Required |
- |
Local file name. Must not contain double period characters or begin with a path character, to attempt to escape file storage area. File extension must match Internet Content-Type of file contents. |
Content |
String |
Required |
- |
BASE-64 encoded binary content of file to create. The contents must not be harmful, be executable, or contain illegal information. |
| Return Value |
| Type |
Description |
| String |
URI of created file resource. |
Create Open Smart Contract
Creates a new open smart contract, based on a contract template. (Open means parts are not predefined.)
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
Yes |
CreateOpenContract(TemplateId, Parameters, Visibility, DurationDays, ArchiveRequiredDays, ArchiveOptionalDays, SignAfter, SignBefore)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Identity.Tools.Contract.Create |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
TemplateId |
String |
Required |
- |
Identifier of the Smart Contract template to use as basis for the new smart contract. |
Parameters |
Dictionary |
Required |
- |
Dictionary object of parameter values to use for the contract. The parameters must be defined in the contract template, and the values must be valid in accordance with validation rules defined in the contract template. |
Visibility |
ContractVisibility |
Required |
- |
Visibility of created contract. Possible values:
"CreatorAndParts" - Creator and Parts"DomainAndParts" - Domain"Public" - Public"PublicSearchable" - Public and Searchable
|
DurationDays |
32-bit signed integer |
Required |
- |
Duration of contracts, once signed, as a number of days. [1,∞) |
ArchiveRequiredDays |
32-bit signed integer |
Optional |
365 |
Required archiving time, once contract expires, as a number of days. [0,∞) |
ArchiveOptionalDays |
32-bit signed integer |
Optional |
0 |
Optional archiving time, once contract expires, as a number of days. [0,∞) |
SignAfter |
Nullable Date & Time |
Optional |
null |
Signatures will only be accepted after this point in time, if defined. (∞,∞) |
SignBefore |
Nullable Date & Time |
Optional |
null |
Signatures will only be accepted before this point in time, if defined. (∞,∞) |
Create Open Payment URI
Creates an open eDaler payment URI. The party that claims the URI and sends it to its Neuron, will receive the eDaler.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
Yes |
CreateOpenPaymentUri(Amount, AmountExtra, ValidNrDays)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Payments.Tools.Uri.Create |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
Amount |
Decimal-precision floating-point |
Required |
- |
Amount of eDaler to transfer. [0.01,∞) |
AmountExtra |
Nullable Decimal-precision floating-point |
Optional |
0.0 |
Optional extra amount of eDaler to transfer. [0,∞) |
ValidNrDays |
32-bit signed integer |
Optional |
3 |
Number of days the URI is valid. [1,∞) |
Create Payment URI to Bare JID
Creates an eDaler payment URI to a specific Bare JID. Regardless of who claims the URI and sends it to its Neuron, the transfer will be made to the wallet belonging to the account identified by the Bare JID.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
Yes |
CreatePaymentToBareJidUri(RecipientBareJid, Amount, AmountExtra, ValidNrDays, Message, ConditionalContractId)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Payments.Tools.Uri.Create |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
RecipientBareJid |
String |
Required |
- |
Bare JID of recipient. |
Amount |
Decimal-precision floating-point |
Required |
- |
Amount of eDaler to transfer. [0.01,∞) |
AmountExtra |
Nullable Decimal-precision floating-point |
Optional |
0.0 |
Optional extra amount of eDaler to transfer. [0,∞) |
ValidNrDays |
32-bit signed integer |
Optional |
3 |
Number of days the URI is valid. [1,∞) |
Message |
String |
Optional |
"" |
Optional message to include in the payment URI. |
ConditionalContractId |
String |
Optional |
null |
Optional Contract ID for conditional payments. A payment can only be performed, if this contract is fully signed. |
Create Payment URI to Legal ID
Creates an eDaler payment URI to a specific Legal ID. Regardless of who claims the URI and sends it to its Neuron, the transfer will be made to the wallet belonging to the account identified by the Legal ID. The sender must also have access to the Legal ID for the transfer to be made.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
Yes |
CreatePaymentToLegalIdUri(RecipientLegalId, Amount, AmountExtra, ValidNrDays, PrivateMessage, ConditionalContractId)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Payments.Tools.Uri.Create |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
RecipientLegalId |
String |
Required |
- |
Identifier of Legal ID of recipient. |
Amount |
Decimal-precision floating-point |
Required |
- |
Amount of eDaler to transfer. [0.01,∞) |
AmountExtra |
Nullable Decimal-precision floating-point |
Optional |
0.0 |
Optional extra amount of eDaler to transfer. [0,∞) |
ValidNrDays |
32-bit signed integer |
Optional |
3 |
Number of days the URI is valid. [1,∞) |
PrivateMessage |
String |
Optional |
"" |
Optional private message to include in the payment URI. The message will be encrypted using the public Legal Identity of the recipient. |
ConditionalContractId |
String |
Optional |
null |
Optional Contract ID for conditional payments. A payment can only be performed, if this contract is fully signed. |
Create Pay-Me URI
Creates an eDaler pay-me URI that can be shared with others to request payment. Regardless of who then claims the URI and sends it to its Neuron, the transfer will be made to your wallet.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
No |
CreatePayMeUri(Amount, AmountExtra, Message, EncryptMessage)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Payments.Tools.Uri.Create |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
Amount |
Nullable Decimal-precision floating-point |
Required |
- |
Optional amount of eDaler to transfer. [0,∞) |
AmountExtra |
Nullable Decimal-precision floating-point |
Optional |
0.0 |
Optional extra amount of eDaler to transfer. [0,∞) |
Message |
String |
Optional |
"" |
Optional message to include in the pay-me URI. |
EncryptMessage |
Boolean |
Optional |
false |
If the message to include in the pay-me URI should be encrypted. |
Create Text File
Creates a text file in account-specific file storage. If a file with the same name exists, it is replaced. Text contents is stored UTF-8 encoded, with a Byte-Order-Mark (BOM).
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
Yes |
| Open World Access: |
No |
CreateTextFile(LocalFileName, Content, AppendCrLf)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Files.Tools.Create |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
LocalFileName |
String |
Required |
- |
Local file name. Must not contain double period characters or begin with a path character, to attempt to escape file storage area. File extension must match Internet Content-Type of file contents. |
Content |
String |
Required |
- |
Text content of file to create. The contents must not be harmful or contain illegal information. |
AppendCrLf |
Boolean |
Required |
- |
If true, a carriage-return/line-feed (CRLF) is appended to the text content before creating the file. |
| Return Value |
| Type |
Description |
| String |
URI of created file resource. |
Decline Presence Subscription
Declines a presence subscription request from another user.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
Yes |
DeclinePresenceSubscription(From)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.XMPP.Tools.Presence.Decline |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
From |
String |
Required |
- |
Bare JID of the sender of the presence subscription request to decline. |
Delete
Deletes content from the Internet, by accessing a resource using the DELETE method.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
Yes |
| Is Idempotent: |
No |
| Open World Access: |
Yes |
Delete(Uri, Accept, AcceptLanguage, Timeout, AdditionalHeaders)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.InternetContent.Tools.Delete |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
Uri |
URI |
Required |
- |
URI of the resource to access. |
Accept |
String |
Optional |
"*/*" |
Accept header to use when accessing the resource. It informs the web server what Internet Content-Type you are expecting the content of the response to be encoded with. |
AcceptLanguage |
String |
Optional |
"" |
Optional Accept-Language header to use when accessing the resource. It informs the web server what language you expect human-readable content to be written in. |
Timeout |
32-bit signed integer |
Optional |
30000 |
Timeout in milliseconds for the request. [1,60000] |
AdditionalHeaders |
Dictionary |
Optional |
null |
Additional headers to include in the request. |
| Return Value |
| Type |
Description |
| Custom Encoding |
Internet content received. |
Delete File
Deletes a file in account-specific file storage, regardless of type. The file must exist.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
Yes |
| Is Idempotent: |
No |
| Open World Access: |
No |
DeleteFile(LocalFileName)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Files.Tools.Delete |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
LocalFileName |
String |
Required |
- |
Local file name. Must not contain double period characters or begin with a path character, to attempt to escape file storage area. File extension must match Internet Content-Type of file contents. |
| Return Value |
| Type |
Description |
| String |
URI of deleted file resource. |
Edit
Edits a file in account-specific file storage.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
Yes |
| Is Idempotent: |
No |
| Open World Access: |
No |
EditFile(LocalFileName, Sensitive)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Files.Tools.Edit |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
LocalFileName |
String |
Required |
- |
Local file name. Must not contain double period characters or begin with a path character, to attempt to escape file storage area. File extension must match Internet Content-Type of file contents. |
Sensitive |
Boolean |
Required |
- |
If the contents of the file are sensitive, set this to true. Sensitive information will be edited in a separate protected window and not inline. |
| Return Value |
| Type |
Description |
| String |
URI of updated file resource. |
Get
Retrieves content from the Internet, by accessing a resource using the GET method.
| Properties |
| Can Modify: |
No |
| Can Destroy: |
No |
| Is Idempotent: |
Yes |
| Open World Access: |
Yes |
Get(Uri, Accept, AcceptLanguage, Timeout, AdditionalHeaders)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.InternetContent.Tools.Get |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
Uri |
URI |
Required |
- |
URI of the resource to access. |
Accept |
String |
Optional |
"*/*" |
Accept header to use when accessing the resource. It informs the web server what Internet Content-Type you are expecting the content of the response to be enceded with. |
AcceptLanguage |
String |
Optional |
"" |
Optional Accept-Language header to use when accessing the resource. It informs the web server what language you expect human-readable content to be written in. |
Timeout |
32-bit signed integer |
Optional |
30000 |
Timeout in milliseconds for the request. [1,60000] |
AdditionalHeaders |
Dictionary |
Optional |
null |
Additional headers to include in the request. |
| Return Value |
| Type |
Description |
| Custom Encoding |
Internet content received. |
Get Balance
Gets the current eDaler balance of the wallet.
| Properties |
| Can Modify: |
No |
| Can Destroy: |
No |
| Is Idempotent: |
Yes |
| Open World Access: |
No |
GetBalance()
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Payments.Tools.Balance.Get |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
Get Options for Buying eDaler
Gets available options for buying eDaler.
| Properties |
| Can Modify: |
No |
| Can Destroy: |
No |
| Is Idempotent: |
Yes |
| Open World Access: |
Yes |
GetBuyEDalerOptions(Id, Type)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Payments.Tools.EDaler.Buy |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
Id |
String |
Required |
- |
Service Provider ID for buying eDaler. |
Type |
String |
Required |
- |
Service Provider Type for buying eDaler. |
Get Identity Application Properties
Gets identity application properties recommended by the server should be available in identity applications.
| Properties |
| Can Modify: |
No |
| Can Destroy: |
No |
| Is Idempotent: |
Yes |
| Open World Access: |
No |
GetIdentityApplicationProperties()
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Identity.Tools.Apply |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
Get Message
Gets a message that has been received over XMPP.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
Yes |
| Is Idempotent: |
No |
| Open World Access: |
Yes |
GetMessage(MessageId, Remove)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.XMPP.Tools.Message.Get |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
MessageId |
String |
Required |
- |
The ID of the message to retrieve. Can be the identifier itself, or the message resource URI. |
Remove |
Boolean |
Optional |
false |
Determines if the message should be removed from the list of received messages or not. |
Get Peer Review Providers
Gets a list of peer review providers that can be used to review identity applications.
| Properties |
| Can Modify: |
No |
| Can Destroy: |
No |
| Is Idempotent: |
Yes |
| Open World Access: |
No |
GetPeerReviewProviders()
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Identity.Tools.Petition.PeerReview |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
Get Pending Payments
Gets a list of payments that are pending to be processed.
| Properties |
| Can Modify: |
No |
| Can Destroy: |
No |
| Is Idempotent: |
Yes |
| Open World Access: |
No |
GetPendingPayments()
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Payments.Tools.Pending.Get |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
Get Options for Selling eDaler
Gets available options for selling eDaler.
| Properties |
| Can Modify: |
No |
| Can Destroy: |
No |
| Is Idempotent: |
Yes |
| Open World Access: |
Yes |
GetSellEDalerOptions(Id, Type)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Payments.Tools.EDaler.Sell |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
Id |
String |
Required |
- |
Service Provider ID for selling eDaler. |
Type |
String |
Required |
- |
Service Provider Type for selling eDaler. |
Get Service Providers for Buying eDaler
Gets a list of service providers that can be used to buy eDaler.
| Properties |
| Can Modify: |
No |
| Can Destroy: |
No |
| Is Idempotent: |
Yes |
| Open World Access: |
No |
GetServiceProvidersForBuyingEDaler()
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Payments.Tools.EDaler.Buy |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
Get Service Providers for Selling eDaler
Gets a list of service providers that can be used to sell eDaler.
| Properties |
| Can Modify: |
No |
| Can Destroy: |
No |
| Is Idempotent: |
Yes |
| Open World Access: |
No |
GetServiceProvidersForSellingEDaler()
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Payments.Tools.EDaler.Sell |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
Log Alert Event
Logs an alert event to the event log. An alert error is so grave, that action must be taken immediately. Logged alert events also get propagated to operators immediately.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
No |
LogAlert(Message, Object, Actor, Level, EventId, Facility, Module)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.EventLog.Tools.Log.Alert |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
Message |
String |
Required |
- |
The body text of the logged event. |
Object |
String |
Optional |
"" |
The object associated with the event, if any. |
Actor |
String |
Optional |
"" |
The subject, or actor, performing the action resulting in the event being logged. |
Level |
EventLevel |
Optional |
"Minor" |
The level of the event being logged. Minor events occur frequently, Medium events update something, or reports something could cause a major event, Major events adds or destroys something, or reports something important is out of order. Possible values:
"Minor" - Minor Event"Medium" - Medium Event"Major" - Major Event
|
EventId |
String |
Optional |
"McpEvent" |
Optional Event ID for the event. Event IDs are used to identify a specific type of event, and is used collect related information in reports. |
Facility |
String |
Optional |
"" |
The subsystem or external component that is the source of the event. |
Module |
String |
Optional |
"" |
The module or component within the source that is the source of the event. |
Log Critical Error Event
Logs a critical error event to the event log. A critical error is an error so great that it could escalate into something graver if not addressed. Typically, a Critical error is typically an unexpected error.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
No |
LogCritical(Message, Object, Actor, Level, EventId, Facility, Module)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.EventLog.Tools.Log.Critical |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
Message |
String |
Required |
- |
The body text of the logged event. |
Object |
String |
Optional |
"" |
The object associated with the event, if any. |
Actor |
String |
Optional |
"" |
The subject, or actor, performing the action resulting in the event being logged. |
Level |
EventLevel |
Optional |
"Minor" |
The level of the event being logged. Minor events occur frequently, Medium events update something, or reports something could cause a major event, Major events adds or destroys something, or reports something important is out of order. Possible values:
"Minor" - Minor Event"Medium" - Medium Event"Major" - Major Event
|
EventId |
String |
Optional |
"McpEvent" |
Optional Event ID for the event. Event IDs are used to identify a specific type of event, and is used collect related information in reports. |
Facility |
String |
Optional |
"" |
The subsystem or external component that is the source of the event. |
Module |
String |
Optional |
"" |
The module or component within the source that is the source of the event. |
Log Debug Event
Logs an event for debug purposes to the event log. The purpose of debug events is to highlight technical information to developers, for troubleshooting.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
No |
LogDebug(Message, Object, Actor, Level, EventId, Facility, Module)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.EventLog.Tools.Log.Debug |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
Message |
String |
Required |
- |
The body text of the logged event. |
Object |
String |
Optional |
"" |
The object associated with the event, if any. |
Actor |
String |
Optional |
"" |
The subject, or actor, performing the action resulting in the event being logged. |
Level |
EventLevel |
Optional |
"Minor" |
The level of the event being logged. Minor events occur frequently, Medium events update something, or reports something could cause a major event, Major events adds or destroys something, or reports something important is out of order. Possible values:
"Minor" - Minor Event"Medium" - Medium Event"Major" - Major Event
|
EventId |
String |
Optional |
"McpEvent" |
Optional Event ID for the event. Event IDs are used to identify a specific type of event, and is used collect related information in reports. |
Facility |
String |
Optional |
"" |
The subsystem or external component that is the source of the event. |
Module |
String |
Optional |
"" |
The module or component within the source that is the source of the event. |
Log Emergency Event
Logs an emergency event to the event log. An emergency error signals the system is unusable, or will become unusable if action is not taken immediately. Logged emergency events also get propagated to operators immediately.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
No |
LogEmergency(Message, Object, Actor, Level, EventId, Facility, Module)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.EventLog.Tools.Log.Emergency |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
Message |
String |
Required |
- |
The body text of the logged event. |
Object |
String |
Optional |
"" |
The object associated with the event, if any. |
Actor |
String |
Optional |
"" |
The subject, or actor, performing the action resulting in the event being logged. |
Level |
EventLevel |
Optional |
"Minor" |
The level of the event being logged. Minor events occur frequently, Medium events update something, or reports something could cause a major event, Major events adds or destroys something, or reports something important is out of order. Possible values:
"Minor" - Minor Event"Medium" - Medium Event"Major" - Major Event
|
EventId |
String |
Optional |
"McpEvent" |
Optional Event ID for the event. Event IDs are used to identify a specific type of event, and is used collect related information in reports. |
Facility |
String |
Optional |
"" |
The subsystem or external component that is the source of the event. |
Module |
String |
Optional |
"" |
The module or component within the source that is the source of the event. |
Log Error Event
Logs an error event to the event log. Error events inform operators of normal error conditions. A normal error condition is typically an expected error.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
No |
LogError(Message, Object, Actor, Level, EventId, Facility, Module)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.EventLog.Tools.Log.Error |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
Message |
String |
Required |
- |
The body text of the logged event. |
Object |
String |
Optional |
"" |
The object associated with the event, if any. |
Actor |
String |
Optional |
"" |
The subject, or actor, performing the action resulting in the event being logged. |
Level |
EventLevel |
Optional |
"Minor" |
The level of the event being logged. Minor events occur frequently, Medium events update something, or reports something could cause a major event, Major events adds or destroys something, or reports something important is out of order. Possible values:
"Minor" - Minor Event"Medium" - Medium Event"Major" - Major Event
|
EventId |
String |
Optional |
"McpEvent" |
Optional Event ID for the event. Event IDs are used to identify a specific type of event, and is used collect related information in reports. |
Facility |
String |
Optional |
"" |
The subsystem or external component that is the source of the event. |
Module |
String |
Optional |
"" |
The module or component within the source that is the source of the event. |
Logs an informational event to the event log. The purpose of informational events is to provide a record of normal operational tasks being performed or events occurring.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
No |
LogInformational(Message, Object, Actor, Level, EventId, Facility, Module)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.EventLog.Tools.Log.Information |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
Message |
String |
Required |
- |
The body text of the logged event. |
Object |
String |
Optional |
"" |
The object associated with the event, if any. |
Actor |
String |
Optional |
"" |
The subject, or actor, performing the action resulting in the event being logged. |
Level |
EventLevel |
Optional |
"Minor" |
The level of the event being logged. Minor events occur frequently, Medium events update something, or reports something could cause a major event, Major events adds or destroys something, or reports something important is out of order. Possible values:
"Minor" - Minor Event"Medium" - Medium Event"Major" - Major Event
|
EventId |
String |
Optional |
"McpEvent" |
Optional Event ID for the event. Event IDs are used to identify a specific type of event, and is used collect related information in reports. |
Facility |
String |
Optional |
"" |
The subsystem or external component that is the source of the event. |
Module |
String |
Optional |
"" |
The module or component within the source that is the source of the event. |
Log Notice Event
Logs an notice event to the event log. A Notice represents a significant condition or change that administrators should be aware of.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
No |
LogNotice(Message, Object, Actor, Level, EventId, Facility, Module)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.EventLog.Tools.Log.Notice |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
Message |
String |
Required |
- |
The body text of the logged event. |
Object |
String |
Optional |
"" |
The object associated with the event, if any. |
Actor |
String |
Optional |
"" |
The subject, or actor, performing the action resulting in the event being logged. |
Level |
EventLevel |
Optional |
"Minor" |
The level of the event being logged. Minor events occur frequently, Medium events update something, or reports something could cause a major event, Major events adds or destroys something, or reports something important is out of order. Possible values:
"Minor" - Minor Event"Medium" - Medium Event"Major" - Major Event
|
EventId |
String |
Optional |
"McpEvent" |
Optional Event ID for the event. Event IDs are used to identify a specific type of event, and is used collect related information in reports. |
Facility |
String |
Optional |
"" |
The subsystem or external component that is the source of the event. |
Module |
String |
Optional |
"" |
The module or component within the source that is the source of the event. |
Log Warning Event
Logs a warning event to the event log. Warning events warn operators of conditions that may lead to errors if they are not properly managed.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
No |
LogWarning(Message, Object, Actor, Level, EventId, Facility, Module)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.EventLog.Tools.Log.Warning |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
Message |
String |
Required |
- |
The body text of the logged event. |
Object |
String |
Optional |
"" |
The object associated with the event, if any. |
Actor |
String |
Optional |
"" |
The subject, or actor, performing the action resulting in the event being logged. |
Level |
EventLevel |
Optional |
"Minor" |
The level of the event being logged. Minor events occur frequently, Medium events update something, or reports something could cause a major event, Major events adds or destroys something, or reports something important is out of order. Possible values:
"Minor" - Minor Event"Medium" - Medium Event"Major" - Major Event
|
EventId |
String |
Optional |
"McpEvent" |
Optional Event ID for the event. Event IDs are used to identify a specific type of event, and is used collect related information in reports. |
Facility |
String |
Optional |
"" |
The subsystem or external component that is the source of the event. |
Module |
String |
Optional |
"" |
The module or component within the source that is the source of the event. |
Obsolete Identity
Obsoletes one of the identities or identity applications registered by the user.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
Yes |
| Is Idempotent: |
No |
| Open World Access: |
No |
ObsoleteIdentity(LegalId)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Identity.Tools.Obsolete |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
LegalId |
String |
Required |
- |
Legal Identity Identifier or Identity resource URI to obsolete. |
Make Payment to Bare JID
Makes an eDaler payment to the wallet belonging to the account identified by the Bare JID.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
Yes |
PayToBareJid(RecipientBareJid, Amount, AmountExtra, ValidNrDays, Message)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Payments.Tools.Uri.Create, OAUTH.Scope.MCP.Payments.Tools.Uri.Process |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
RecipientBareJid |
String |
Required |
- |
Bare JID of recipient. |
Amount |
Decimal-precision floating-point |
Required |
- |
Amount of eDaler to transfer. [0.01,∞) |
AmountExtra |
Nullable Decimal-precision floating-point |
Optional |
0.0 |
Optional extra amount of eDaler to transfer. [0,∞) |
ValidNrDays |
32-bit signed integer |
Optional |
3 |
Number of days the URI is valid. [1,∞) |
Message |
String |
Optional |
"" |
Optional message to include in the payment URI. |
Make Payment to Legal ID
Makes an eDaler payment to the wallet belonging to the account identified by the Legal ID. The sender must also have access to the Legal ID for the transfer to be made.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
Yes |
PayToLegalId(RecipientLegalId, Amount, AmountExtra, ValidNrDays, PrivateMessage)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Payments.Tools.Uri.Create |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
RecipientLegalId |
String |
Required |
- |
Identifier of Legal ID of recipient. |
Amount |
Decimal-precision floating-point |
Required |
- |
Amount of eDaler to transfer. [0.01,∞) |
AmountExtra |
Nullable Decimal-precision floating-point |
Optional |
0.0 |
Optional extra amount of eDaler to transfer. [0,∞) |
ValidNrDays |
32-bit signed integer |
Optional |
3 |
Number of days the URI is valid. [1,∞) |
PrivateMessage |
String |
Optional |
"" |
Optional private message to include in the payment URI. The message will be encrypted using the public Legal Identity of the recipient. |
Petition Legal Identity
Sends a petition to a user for one of its legal identities.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
Yes |
PetitionLegalIdentity(LegalId, Purpose)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Identity.Tools.Petition.Identity |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
LegalId |
String |
Required |
- |
Identifier of Legal Identity to petition. |
Purpose |
String |
Required |
- |
A message to the recipient of the petition, explaining the purpose of the petition. |
Petition Peer Review
Sends a petition to a peer for a review of an identity application.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
Yes |
PetitionPeerReview(LegalId, Purpose)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Identity.Tools.Petition.PeerReview |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
LegalId |
String |
Required |
- |
Identifier of Legal Identity to send the petition to. |
Purpose |
String |
Required |
- |
Message to recipient of petition, explaining the purpose of the review. |
Petition Digital Signature
Sends a petition to a user for a digital signature.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
Yes |
PetitionSignature(LegalId, Content, Purpose)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Identity.Tools.Petition.Signature |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
LegalId |
String |
Required |
- |
Identifier of Legal Identity to petition. |
Content |
String |
Required |
- |
BASE64-encoded content to sign. |
Purpose |
String |
Required |
- |
A message to the recipient of the petition, explaining the purpose of the petition. |
Petition Smart Contract
Sends a petition to the parts of a smart contract, for access to the smart contract.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
Yes |
PetitionSmartContract(ContractId, Purpose)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Identity.Tools.Petition.Contract |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
ContractId |
String |
Required |
- |
Identifier of the Smart Contract to petition. |
Purpose |
String |
Required |
- |
A message to the recipients of the petition, explaining the purpose of the petition. |
Pop Message
Gets the first message that has been received over XMPP, and then removes it from the resource list.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
Yes |
| Is Idempotent: |
No |
| Open World Access: |
Yes |
PopMessage()
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.XMPP.Tools.Message.Get |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
Post
Posts information to a resource on the Internet using the POST method, and returns the content that is returned.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
Yes |
| Is Idempotent: |
No |
| Open World Access: |
Yes |
Post(Uri, Payload, Accept, AcceptLanguage, Timeout, AdditionalHeaders)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.InternetContent.Tools.Post |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
Uri |
URI |
Required |
- |
URI of the resource to access. |
Payload |
Object |
Optional |
null |
The payload to post to the resource. |
Accept |
String |
Optional |
"*/*" |
Accept header to use when accessing the resource. It informs the web server what Internet Content-Type you are expecting the content of the response to be enceded with. |
AcceptLanguage |
String |
Optional |
"" |
Optional Accept-Language header to use when accessing the resource. It informs the web server what language you expect human-readable content to be written in. |
Timeout |
32-bit signed integer |
Optional |
30000 |
Timeout in milliseconds for the request. [1,60000] |
AdditionalHeaders |
Dictionary |
Optional |
null |
Additional headers to include in the request. |
| Return Value |
| Type |
Description |
| Custom Encoding |
Internet content response received. |
Process Payment URI
Sends an eDaler URI to the Neuron for processing.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
Yes |
ProcessPaymentUri(Uri)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Payments.Tools.Uri.Process |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
Uri |
URI |
Required |
- |
eDaler URI to send to the Neuron for processing. |
Propose Smart Contract
Sends a proposal to sign a smart contract as a specific role.
| Properties |
| Can Modify: |
No |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
Yes |
ProposeContract(ContractId, Role, To, Message)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Identity.Tools.Contract.Propose |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
ContractId |
String |
Required |
- |
Identifier of the Smart Contract to propose. |
Role |
String |
Required |
- |
Role to propose. |
To |
String |
Required |
- |
Bare JID of recipient of proposal. |
Message |
String |
Required |
- |
Message to show the recipient of the proposal. |
Put
Puts information to a resource on the Internet using the PUT method, and returns the content that is returned.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
Yes |
| Is Idempotent: |
Yes |
| Open World Access: |
Yes |
Put(Uri, Payload, Accept, AcceptLanguage, Timeout, AdditionalHeaders)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.InternetContent.Tools.Put |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
Uri |
URI |
Required |
- |
URI of the resource to access. |
Payload |
Object |
Optional |
null |
The payload to put to the resource. |
Accept |
String |
Optional |
"*/*" |
Accept header to use when accessing the resource. It informs the web server what Internet Content-Type you are expecting the content of the response to be encoded with. |
AcceptLanguage |
String |
Optional |
"" |
Optional Accept-Language header to use when accessing the resource. It informs the web server what language you expect human-readable content to be written in. |
Timeout |
32-bit signed integer |
Optional |
30000 |
Timeout in milliseconds for the request. [1,60000] |
AdditionalHeaders |
Dictionary |
Optional |
null |
Additional headers to include in the request. |
| Return Value |
| Type |
Description |
| Custom Encoding |
Internet content response received. |
Query
Queries information from a resource on the Internet using the QUERY method, and returns the content that is returned.
| Properties |
| Can Modify: |
No |
| Can Destroy: |
No |
| Is Idempotent: |
Yes |
| Open World Access: |
Yes |
Query(Uri, Payload, Accept, AcceptLanguage, Timeout, AdditionalHeaders)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.InternetContent.Tools.Query |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
Uri |
URI |
Required |
- |
URI of the resource to access. |
Payload |
Object |
Optional |
null |
The payload to send in the query to the resource. |
Accept |
String |
Optional |
"*/*" |
Accept header to use when accessing the resource. It informs the web server what Internet Content-Type you are expecting the content of the response to be encoded with. |
AcceptLanguage |
String |
Optional |
"" |
Optional Accept-Language header to use when accessing the resource. It informs the web server what language you expect human-readable content to be written in. |
Timeout |
32-bit signed integer |
Optional |
30000 |
Timeout in milliseconds for the request. [1,60000] |
AdditionalHeaders |
Dictionary |
Optional |
null |
Additional headers to include in the request. |
| Return Value |
| Type |
Description |
| Custom Encoding |
Internet content response received. |
Ready For Approval Identity
Reports one of the identities or identity applications registered by the user as ready for approval.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
Yes |
| Is Idempotent: |
No |
| Open World Access: |
No |
ReadyForApproval(LegalId)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Identity.Tools.ReadyForApproval |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
LegalId |
String |
Required |
- |
Legal Identity Identifier or Identity resource URI to report as ready for approval. |
Remove Attachment
Removes an attachment from an identity application.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
No |
RemoveAttachment(AttachmentId)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Identity.Tools.Attachment.Remove |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
AttachmentId |
String |
Required |
- |
Attachment ID to be removed. |
Remove from Roster
Removes a contact from the roster of the XMPP account associated with the MCP Client.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
Yes |
| Is Idempotent: |
No |
| Open World Access: |
Yes |
RemoveFromRoster(BareJid)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.XMPP.Tools.Roster.Remove |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
BareJid |
String |
Required |
- |
Bare JID of the contact to remove from roster. |
Request Presence Subscription
Requests a presence subscription to another user's presence.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
Yes |
| Open World Access: |
Yes |
RequestPresenceSubscription(To)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.XMPP.Tools.Presence.Subscribe |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
To |
String |
Required |
- |
Bare JID of the user to whom send a presence subscription request. |
Request Presence Unsubscription
Requests a presence unsubscription from another user's presence.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
Yes |
| Is Idempotent: |
Yes |
| Open World Access: |
Yes |
RequestPresenceUnsubscription(To)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.XMPP.Tools.Presence.Unsubscribe |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
To |
String |
Required |
- |
Bare JID of the user to whom send a presence subscription request. |
Search for Events
Performs a search for events in the event log.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
No |
Search(Offset, MaxCount, From, To, Message, Object, Actor, EventId, Module, Facility, Debug, Informational, Notice, Warning, Error, Critical, Alert, Emergency, Minor, Medium, Major)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.EventLog.Tools.Search |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
Offset |
32-bit signed integer |
Optional |
0 |
Offset into search result set where returned events begin. [0,2147483647] |
MaxCount |
32-bit signed integer |
Optional |
100 |
Maximum number of results to return. [1,1000] |
From |
Nullable Date & Time |
Optional |
null |
Start date/time for search, in UTC. If provided, only events newer than or equal to this point in time will be returned. (∞,∞) |
To |
Nullable Date & Time |
Optional |
null |
End date/time for search, in UTC. If provided, only events older than or equal to this point in time will be returned. (∞,∞) |
Message |
String |
Optional |
null |
Message to search for. If provided, only events containing this message text will be returned. |
Object |
String |
Optional |
null |
Object to search for. If provided, only events with this object will be returned. This property represents the object associated with the events. |
Actor |
String |
Optional |
null |
Actor to search for. If provided, only events with this actor will be returned. This property represents the subject, or actor, performing the action resulting in the events being logged. |
EventId |
String |
Optional |
null |
Event ID to search for. If provided, only events with this event ID will be returned. Event IDs are used to identify a specific type of event, and is used collect related information in reports. |
Module |
String |
Optional |
null |
Module ID to search for. If provided, only events with this module will be returned. This property represents the module or component within the source that is the source of the event. |
Facility |
String |
Optional |
null |
Facility ID to search for. If provided, only events with this facility will be returned. this property represents the subsystem or external component that is the source of the event. |
Debug |
Nullable Boolean |
Optional |
null |
If provided, determines if debug events are to be included in the result. The purpose of debug events is to highlight technical information to developers, for troubleshooting. |
Informational |
Nullable Boolean |
Optional |
null |
If provided, determines if informational events are to be included in the result. The purpose of informational events is to provide a record of normal operational tasks being performed or events occurring. |
Notice |
Nullable Boolean |
Optional |
null |
If provided, determines if notice events are to be included in the result. A Notice represents a significant condition or change that administrators should be aware of. |
Warning |
Nullable Boolean |
Optional |
null |
If provided, determines if warning events are to be included in the result. Warning events warn operators of conditions that may lead to errors if they are not properly managed. |
Error |
Nullable Boolean |
Optional |
null |
If provided, determines if error events are to be included in the result. Error events inform operators of normal error conditions. A normal error condition is typically an expected error. |
Critical |
Nullable Boolean |
Optional |
null |
If provided, determines if critical error events are to be included in the result. A critical error is an error so great that it could escalate into something graver if not addressed. Typically, a Critical error is typically an unexpected error. |
Alert |
Nullable Boolean |
Optional |
null |
If provided, determines if alerts events are to be included in the result. An alert error is so grave, that action must be taken immediately. |
Emergency |
Nullable Boolean |
Optional |
null |
If provided, determines if emergencies events are to be included in the result. An emergency error signals the system is unusable, or will become unusable if action is not taken immediately. |
Minor |
Nullable Boolean |
Optional |
null |
If provided, determines if minor events are to be included in the result. Minor events occur frequently. |
Medium |
Nullable Boolean |
Optional |
null |
If provided, determines if medium events are to be included in the result. Medium events update something, or reports something could cause a major event. |
Major |
Nullable Boolean |
Optional |
null |
If provided, determines if major events are to be included in the result. Major events adds or destroys something, or reports something important is out of order. |
| Return Value |
| Type |
Description |
SearchResult |
Result set of the search for events, as well as information about if more events are available, and the offset to the next set of events. |
Search
Searches for files in account-specific file storage that have file names matching a given search pattern.
| Properties |
| Can Modify: |
No |
| Can Destroy: |
No |
| Is Idempotent: |
Yes |
| Open World Access: |
No |
SearchFiles(Pattern)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Files.Tools.Search |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
Pattern |
String |
Optional |
"*.*" |
File name search pattern. Must not contain double period characters or path characters, to attempt to escape file storage area. Use asterisk (*) as wildcard, or questionmark (?) as a character wildcard. |
| Return Value |
| Type |
Description |
SearchResult |
Search result of files in account-specific file storage. |
Select Peer Review Provider
Selects an internal Peer Review provider.
| Properties |
| Can Modify: |
No |
| Can Destroy: |
No |
| Is Idempotent: |
Yes |
| Open World Access: |
No |
SelectPeerReviewProvider(Id, Type)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Identity.Tools.Petition.PeerReview |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
Id |
String |
Required |
- |
Peer Review Provider ID. |
Type |
String |
Required |
- |
Peer Review Provider Type. |
Sell eDaler
Sell eDaler using a service provider for selling eDaler.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
Yes |
SellEDaler(Id, Type, Amount, Currency)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Payments.Tools.EDaler.Sell |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
Id |
String |
Required |
- |
Service Provider ID for selling eDaler. |
Type |
String |
Required |
- |
Service Provider Type for selling eDaler. |
Amount |
Decimal-precision floating-point |
Required |
- |
Amount of eDaler to sell. [1,∞) |
Currency |
String |
Required |
- |
Currency of the amount to sell. |
Send Chat Message
Sends a Chat Message to a recipient using XMPP.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
Yes |
SendChatMessage(To, Message, IsMarkdown, Language)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.XMPP.Tools.Message.Send |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
To |
String |
Required |
- |
Bare JID of the recipient of the message. |
Message |
String |
Required |
- |
Message content. Can be either plain text, or Markdown. |
IsMarkdown |
Boolean |
Optional |
false |
Indicates if the message is in Markdown format (true), or plain text (false). |
Language |
String |
Optional |
null |
Optional ISO-639 code of language used in the message, if any. |
Sign Smart Contract
Signs a smart contract as a specific role.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
No |
| Is Idempotent: |
No |
| Open World Access: |
Yes |
SignContract(ContractId, Role, Transferable)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Identity.Tools.Contract.Sign |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
ContractId |
String |
Required |
- |
Identifier of the Smart Contract to sign. |
Role |
String |
Required |
- |
Role to sign the contract as. |
Transferable |
Boolean |
Optional |
false |
If the signature is transferable to another party during the life cycle of the contract. |
Update Binary File
Updates a binary file in account-specific file storage. The file must exist.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
Yes |
| Is Idempotent: |
Yes |
| Open World Access: |
No |
UpdateBinaryFile(LocalFileName, Content)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Files.Tools.Update |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
LocalFileName |
String |
Required |
- |
Local file name. Must not contain double period characters or begin with a path character, to attempt to escape file storage area. File extension must match Internet Content-Type of file contents. |
Content |
String |
Required |
- |
BASE-64 encoded binary content of file to update. The contents must not be harmful, be executable, or contain illegal information. |
| Return Value |
| Type |
Description |
| String |
URI of updated file resource. |
Update Roster Item
Updates a contact in the roster of the XMPP account associated with the MCP Client.
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
Yes |
| Is Idempotent: |
Yes |
| Open World Access: |
Yes |
UpdateRosterItem(BareJid, NickName, Groups)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.XMPP.Tools.Roster.Update |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
BareJid |
String |
Required |
- |
Bare JID of the contact to update in roster. |
NickName |
String |
Optional |
null |
Optional nick name of the contact to update in roster. |
Groups |
Array of String |
Optional |
null |
Optional groups to which the contact should belong. |
Update Text File
Updates a text file in account-specific file storage, replacing its previous content with new content. The file must exist. Text contents is stored UTF-8 encoded, with a Byte-Order-Mark (BOM).
| Properties |
| Can Modify: |
Yes |
| Can Destroy: |
Yes |
| Is Idempotent: |
Yes |
| Open World Access: |
No |
UpdateTextFile(LocalFileName, Content, AppendCrLf)
| Authentication |
| Required: |
Yes |
| Privileges Required: |
OAUTH.Scope.MCP.Files.Tools.Update |
| Authentication Mechanisms: |
Bearer JWT (128+ bit Encryption), Basic (128+ bit Encryption), Digest-MD5 (128+ bit Encryption), Digest-SHA-256 (128+ bit Encryption), Digest-SHA-3-256 (128+ bit Encryption), Session |
| Arguments |
| Name |
Type |
Use |
Default Value |
Description |
LocalFileName |
String |
Required |
- |
Local file name. Must not contain double period characters or begin with a path character, to attempt to escape file storage area. File extension must match Internet Content-Type of file contents. |
Content |
String |
Required |
- |
Text content of file to update. The contents must not be harmful or contain illegal information. |
AppendCrLf |
Boolean |
Required |
- |
If true, a carriage-return/line-feed (CRLF) is appended to the text content before updating the file. |
| Return Value |
| Type |
Description |
| String |
URI of updated file resource. |
MCP Server Resources
This MCP Server supports MCP Server Resources.
Following are information regarding resources published by the different MCP Servers available via this MCP server.
Internet Content
Event Log
File Storage
Each resource represents a file in the account-specific file storage. As files are created, modified, renamed or deleted, resource events are propagated to clients that receive notifications (new, renamed or deleted files) or have resource subscriptions active (modifed files).
Note: Files are account-specific. This means that other clients have different sets of files. This means that URIs cannot be meaningfully shared, as they point to different files in each account-specific storage. The purpose of the account-specific storage is to store information for later processing or reference.
XMPP MCP Server
There are different types of resources published by the XMPP MCP Server. The type of resource is identified by the URI scheme of each resource.
The xmpp URI scheme represents a contact in the account-specific roster. Read the resource to gain information about what groups the contact belongs to, and the status of presence subscriptions, as well as nick names and last published presence information.
Note: Rosters are account-specific. When working with XMPP each MCP Client gets associated with an XMPP account. The roster belongs to the XMPP account. Different MCP Clients have their separate rosters. Resources can be shared between MCP clients however, as they only point to the different contacts. When different clients read the resources however, different responses are expected.
The mid URI scheme represents a message stanza that has been received. Read the resource, pop the message from the queue, and read it. Once the message has been read, it will be removed from the resource list. If the MCP client needs to store it, it can use file persistence to store the contents of the resource.
Note: Messages are not persisted by the MCP Server. It is the responsability of the MCP Client to read incoming messages and store them if necessary.
Identity MCP Server
Resources on the MCP server represents digital identities in their various states, or petitioned smart contracts, or contract templates you have used.
Each identity has a State, a date when it was Created, a date when it was last Updated, a date from when the identity is valid to be used and a To date until when it is valid and after which it expires.
Each smart contract, or smart contract temaplte is recognized by the use of the iotsc URI scheme. Each smart contract has a State, a date when it was Created, a date when it was last updated, a duration, roles, parts who have signed the contract, parameters and human-readable and machine-readable contents.
Payments MCP Server
Resources on the MCP server represents transactions that have been performed. Each transaction lists timestamp, change balance, remote endpoint, and an optional message. If the message was sent in encrypted form, the message is decrypted, if possible. If not possible to decrypt, the encrypted message is available, together with the public key for which the encryption was made, and a decryption error message.