TrustedApplication

Creates a new TrustedApplication.

post

Only administrators can create TrustedApplications.

Path parameters
strTokenstringRequired

The login token

Body

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 | nullableOptional

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

baseUrlstring | 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
post
POST /api/v2/TrustedApplication/{strToken} HTTP/1.1
Host: 
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": "2025-07-23T11:34:23.564Z",
  "lastChangeTimestamp": "2025-07-23T11:34:23.564Z"
}
200

Success

{
  "trustedApplication": {
    "trustedApplicationID": "text",
    "tenantID": "text",
    "name": "text",
    "description": "text",
    "baseUrl": "text",
    "authorizationToken": "text",
    "isEnabled": true,
    "createdByUserID": "text",
    "lastModifiedByUserID": "text",
    "creationTimestamp": "2025-07-23T11:34:23.564Z",
    "lastChangeTimestamp": "2025-07-23T11:34:23.564Z"
  },
  "requestID": 1,
  "requestDateTime": "2025-07-23T11:34:23.564Z",
  "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
get
GET /api/v2/TrustedApplication/{strToken}/{strTrustedApplicationID} HTTP/1.1
Host: 
Accept: */*
200

Success

{
  "trustedApplication": {
    "trustedApplicationID": "text",
    "tenantID": "text",
    "name": "text",
    "description": "text",
    "baseUrl": "text",
    "authorizationToken": "text",
    "isEnabled": true,
    "createdByUserID": "text",
    "lastModifiedByUserID": "text",
    "creationTimestamp": "2025-07-23T11:34:23.564Z",
    "lastChangeTimestamp": "2025-07-23T11:34:23.564Z"
  },
  "requestID": 1,
  "requestDateTime": "2025-07-23T11:34:23.564Z",
  "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
delete
DELETE /api/v2/TrustedApplication/{strToken}/{strTrustedApplicationID} HTTP/1.1
Host: 
Accept: */*
200

Success

{
  "requestID": 1,
  "requestDateTime": "2025-07-23T11:34:23.564Z",
  "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

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 | nullableOptional

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

baseUrlstring | 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
patch
PATCH /api/v2/TrustedApplication/{strToken}/{strTrustedApplicationID} HTTP/1.1
Host: 
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": "2025-07-23T11:34:23.564Z",
  "lastChangeTimestamp": "2025-07-23T11:34:23.564Z"
}
200

Success

{
  "trustedApplication": {
    "trustedApplicationID": "text",
    "tenantID": "text",
    "name": "text",
    "description": "text",
    "baseUrl": "text",
    "authorizationToken": "text",
    "isEnabled": true,
    "createdByUserID": "text",
    "lastModifiedByUserID": "text",
    "creationTimestamp": "2025-07-23T11:34:23.564Z",
    "lastChangeTimestamp": "2025-07-23T11:34:23.564Z"
  },
  "requestID": 1,
  "requestDateTime": "2025-07-23T11:34:23.564Z",
  "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
get
GET /api/v2/TrustedApplications/{strToken} HTTP/1.1
Host: 
Accept: */*
200

Success

{
  "trustedApplications": [
    {
      "trustedApplicationID": "text",
      "tenantID": "text",
      "name": "text",
      "description": "text",
      "baseUrl": "text",
      "authorizationToken": "text",
      "isEnabled": true,
      "createdByUserID": "text",
      "lastModifiedByUserID": "text",
      "creationTimestamp": "2025-07-23T11:34:23.564Z",
      "lastChangeTimestamp": "2025-07-23T11:34:23.564Z"
    }
  ],
  "requestID": 1,
  "requestDateTime": "2025-07-23T11:34:23.564Z",
  "resultCode": 1,
  "resultMessage": "text"
}
PreviousTenantNextUser