TrustedApplication

Creates a new TrustedApplication.

post

Only administrators can create TrustedApplications.

Path parameters

strTokenstringRequired

The login token

Body

application/json

Specifications of a TrustedApplication object.

trustedApplicationIDstring · nullableOptional

TrustedApplication ID. Unique and assigned by the system. Returned during Get operations. Ignored in other cases.

tenantIDstring · nullableOptional

Tenant ID this TrustedApplication belongs to. Required during Create operations. Returned during Get operations.

namestring · min: 1 · max: 255Required

Name of the TrustedApplication. Must be unique within the tenant. Required during Create operations. Used during Update operations. Returned during Get operations.

descriptionstring · max: 1000 · nullableOptional

Description of the TrustedApplication. Optional during Create and Update operations. Returned during Get operations.

baseUrlstring · max: 500 · nullableOptional

Base URL of the TrustedApplication. Optional during Create and Update operations. Returned during Get operations.

authorizationTokenstring · min: 1 · max: 1000Required

Authorization token for the TrustedApplication. Required during Create operations. Used during Update operations. Returned during Get operations.

isEnabledbooleanRequired

Whether the TrustedApplication is enabled. Required during Create operations. Used during Update operations. Returned during Get operations.

createdByUserIDstring · nullableOptional

User ID who created this TrustedApplication. Returned during Get operations. Ignored in other cases.

lastModifiedByUserIDstring · nullableOptional

User ID who last modified this TrustedApplication. Returned during Get operations. Ignored in other cases.

creationTimestampstring · date-time · nullableOptional

Timestamp of creation. Returned during Get operations. Ignored in other cases.

lastChangeTimestampstring · date-time · nullableOptional

Timestamp of latest change. Returned during Get operations. Ignored in other cases.

Responses

200

Success

application/json

Response of a Create TrustedApplication request.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous reponse.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous reponse.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is indicative of the actual error.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

post

/api/v2/TrustedApplication/{strToken}

HTTPcURLJavaScriptPython

POST /api/v2/TrustedApplication/{strToken} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 297

{
  "trustedApplicationID": "text",
  "tenantID": "text",
  "name": "text",
  "description": "text",
  "baseUrl": "text",
  "authorizationToken": "text",
  "isEnabled": true,
  "createdByUserID": "text",
  "lastModifiedByUserID": "text",
  "creationTimestamp": "2026-03-07T11:53:48.303Z",
  "lastChangeTimestamp": "2026-03-07T11:53:48.303Z"
}

200

Success

{
  "trustedApplication": {
    "trustedApplicationID": "text",
    "tenantID": "text",
    "name": "text",
    "description": "text",
    "baseUrl": "text",
    "authorizationToken": "text",
    "isEnabled": true,
    "createdByUserID": "text",
    "lastModifiedByUserID": "text",
    "creationTimestamp": "2026-03-07T11:53:48.303Z",
    "lastChangeTimestamp": "2026-03-07T11:53:48.303Z"
  },
  "requestID": 1,
  "requestDateTime": "2026-03-07T11:53:48.303Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Gets a TrustedApplication by ID.

get

Only administrators can get TrustedApplications.

Path parameters

strTokenstringRequired

The login token

strTrustedApplicationIDstringRequired

The TrustedApplication ID

Responses

200

Success

application/json

Response of a Get TrustedApplication request.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous reponse.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous reponse.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is indicative of the actual error.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

get

/api/v2/TrustedApplication/{strToken}/{strTrustedApplicationID}

HTTPcURLJavaScriptPython

GET /api/v2/TrustedApplication/{strToken}/{strTrustedApplicationID} HTTP/1.1
Accept: */*

200

Success

{
  "trustedApplication": {
    "trustedApplicationID": "text",
    "tenantID": "text",
    "name": "text",
    "description": "text",
    "baseUrl": "text",
    "authorizationToken": "text",
    "isEnabled": true,
    "createdByUserID": "text",
    "lastModifiedByUserID": "text",
    "creationTimestamp": "2026-03-07T11:53:48.303Z",
    "lastChangeTimestamp": "2026-03-07T11:53:48.303Z"
  },
  "requestID": 1,
  "requestDateTime": "2026-03-07T11:53:48.303Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Deletes a TrustedApplication.

delete

Only administrators can delete TrustedApplications.

Path parameters

strTokenstringRequired

The login token

strTrustedApplicationIDstringRequired

The TrustedApplication ID

Responses

200

Success

application/json

Base response.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous reponse.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous reponse.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is indicative of the actual error.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

delete

/api/v2/TrustedApplication/{strToken}/{strTrustedApplicationID}

HTTPcURLJavaScriptPython

DELETE /api/v2/TrustedApplication/{strToken}/{strTrustedApplicationID} HTTP/1.1
Accept: */*

200

Success

{
  "requestID": 1,
  "requestDateTime": "2026-03-07T11:53:48.303Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Updates an existing TrustedApplication.

patch

Only administrators can update TrustedApplications.

Path parameters

strTokenstringRequired

The login token

strTrustedApplicationIDstringRequired

The TrustedApplication ID

Body

application/json

Specifications of a TrustedApplication object.

trustedApplicationIDstring · nullableOptional

TrustedApplication ID. Unique and assigned by the system. Returned during Get operations. Ignored in other cases.

tenantIDstring · nullableOptional

Tenant ID this TrustedApplication belongs to. Required during Create operations. Returned during Get operations.

namestring · min: 1 · max: 255Required

Name of the TrustedApplication. Must be unique within the tenant. Required during Create operations. Used during Update operations. Returned during Get operations.

descriptionstring · max: 1000 · nullableOptional

Description of the TrustedApplication. Optional during Create and Update operations. Returned during Get operations.

baseUrlstring · max: 500 · nullableOptional

Base URL of the TrustedApplication. Optional during Create and Update operations. Returned during Get operations.

authorizationTokenstring · min: 1 · max: 1000Required

Authorization token for the TrustedApplication. Required during Create operations. Used during Update operations. Returned during Get operations.

isEnabledbooleanRequired

Whether the TrustedApplication is enabled. Required during Create operations. Used during Update operations. Returned during Get operations.

createdByUserIDstring · nullableOptional

User ID who created this TrustedApplication. Returned during Get operations. Ignored in other cases.

lastModifiedByUserIDstring · nullableOptional

User ID who last modified this TrustedApplication. Returned during Get operations. Ignored in other cases.

creationTimestampstring · date-time · nullableOptional

Timestamp of creation. Returned during Get operations. Ignored in other cases.

lastChangeTimestampstring · date-time · nullableOptional

Timestamp of latest change. Returned during Get operations. Ignored in other cases.

Responses

200

Success

application/json

Response of an Update TrustedApplication request.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous reponse.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous reponse.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is indicative of the actual error.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

patch

/api/v2/TrustedApplication/{strToken}/{strTrustedApplicationID}

HTTPcURLJavaScriptPython

PATCH /api/v2/TrustedApplication/{strToken}/{strTrustedApplicationID} HTTP/1.1
Content-Type: application/json
Accept: */*
Content-Length: 297

{
  "trustedApplicationID": "text",
  "tenantID": "text",
  "name": "text",
  "description": "text",
  "baseUrl": "text",
  "authorizationToken": "text",
  "isEnabled": true,
  "createdByUserID": "text",
  "lastModifiedByUserID": "text",
  "creationTimestamp": "2026-03-07T11:53:48.303Z",
  "lastChangeTimestamp": "2026-03-07T11:53:48.303Z"
}

200

Success

{
  "trustedApplication": {
    "trustedApplicationID": "text",
    "tenantID": "text",
    "name": "text",
    "description": "text",
    "baseUrl": "text",
    "authorizationToken": "text",
    "isEnabled": true,
    "createdByUserID": "text",
    "lastModifiedByUserID": "text",
    "creationTimestamp": "2026-03-07T11:53:48.303Z",
    "lastChangeTimestamp": "2026-03-07T11:53:48.303Z"
  },
  "requestID": 1,
  "requestDateTime": "2026-03-07T11:53:48.303Z",
  "resultCode": 1,
  "resultMessage": "text"
}

Lists all TrustedApplications for the current tenant.

get

Only administrators can list TrustedApplications.

Path parameters

strTokenstringRequired

The login token

Responses

200

Success

application/json

Response of a List TrustedApplications request.

requestIDinteger · int64Optional

Progressive number of the request (since the Server started). Use this number, together with the RequestDateTime property, to report an anomalous reponse.

requestDateTimestring · date-timeOptional

Timestamp of the request. Use this timestamp, together with the RequestID property, to report an anomalous reponse.

resultCodeinteger · int32Optional

Result code. A code of 0 means no errors. When the request fails, its value is indicative of the actual error.

resultMessagestring · nullableOptional

Result message. A message of Ok means no errors.

get

/api/v2/TrustedApplications/{strToken}

HTTPcURLJavaScriptPython

GET /api/v2/TrustedApplications/{strToken} HTTP/1.1
Accept: */*

200

Success

{
  "trustedApplications": [
    {
      "trustedApplicationID": "text",
      "tenantID": "text",
      "name": "text",
      "description": "text",
      "baseUrl": "text",
      "authorizationToken": "text",
      "isEnabled": true,
      "createdByUserID": "text",
      "lastModifiedByUserID": "text",
      "creationTimestamp": "2026-03-07T11:53:48.303Z",
      "lastChangeTimestamp": "2026-03-07T11:53:48.303Z"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2026-03-07T11:53:48.303Z",
  "resultCode": 1,
  "resultMessage": "text"
}