Chat now with support
Chat with Support

One Identity Safeguard for Privileged Sessions 7.5 - REST API Reference Guide

Introduction Using the SPS REST API Basic settings User management and access control Managing SPS General connection settings HTTP connections Citrix ICA connections MSSQL connections RDP connections SSH connections Telnet connections VNC connections Search, retrieve, download, and index sessions Reporting Health and maintenance Advanced authentication and authorization Completing the Welcome Wizard using REST Enable and configure analytics using REST REST API examples

Creating custom HTTP error templates

Configure HTTP error templates to create custom error pages when HTTP proxy errors occur.

URL
GET https://<IP-address-of-SPS>/api/configuration/http/error_templates
Cookies
Cookie name Description Required Values
session_id Contains the authentication token of the user Required

The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For more information on authentication, see Authenticate to the SPS REST API.

NOTE: This session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format).
Operations

Operations with the /http/error_templates endpoint include:

Operation HTTP method URL

Notes
Querying existing error templates GET /api/configuration/http/error_templates  

Creating a new error template with a custom logo

POST

 /api/configuration/http/error_templates

 

Updating an existing error template

PUT

/api/configuration/http/error_templates/<key>

 

Querying error templates info

GET

/api/configuration/http/error_templates?info=

 

Querying custom error template preview

GET

/api/configuration/http/error_templates?preview=&error_type=<type-of-the-error-template>

 

Sample request

The following command lists the available HTTP proxy error templates.

curl --cookie cookies.txt https://<IP-address-of-SPS>/api/configuration/http/error_templates
Response

The following is a sample response received when available HTTP proxy error templates are queried.

For more information on the meta object, see Message format.

{
     "name": "Template_with_logo",
     "color": "#123456",
     "logo": "<'logo_id' from the response of the first creation>",
     "brand_name": "Noname brand",
     "md_contents": {
       "auth": "Custom auth failed markdown content.",
       "badcontent": "Custom bad content error markdown content.",
       "clientsyntax": "Custom client syntax error markdown content.",
       "clienttimeout": "Custom client timeout error markdown content.",
       "connecterror": "Custom connection error markdown content.",
       "ftperror": "Custom FTP error markdown content.",
       "internal": "Custom internal error markdown content.",
       "invalidurl": "Custom invalid URL markdown content.",
       "ioerror": "Custom I/O error markdown content.",
       "policysyntax": "Custom policy syntax error markdown content.",
       "policyviolation": "Custom policy violation error markdown content.",
       "redirect": "Custom redirect markdown content.",
       "serversyntax": "Custom server syntax error markdown content.",
       "servertimeout": "Custom server timeout error markdown content."
     }
    }

The following is a sample response received when HTTP proxy error template information is queried with /api/configuration/http/error_templates?info=.

{
     "error_type_names": {
       "auth": "Authentication Failed",
       "badcontent": "Bad Content",
       "clientsyntax": "Client Syntax",
       "clienttimeout": "Client Timeout",
       "connecterror": "Connection Error",
       "ftperror": "FTP Error",
       "internal": "Internal Error",
       "invalidurl": "Invalid URL",
       "ioerror": "I/O Error",
       "policysyntax": "Policy Syntax",
       "policyviolation": "Policy Violation",
       "redirect": "Redirect",
       "serversyntax": "Server Syntax",
       "servertimeout": "Server Timeout"
     }
    }

Elements of the response message include:

Element

Type

 Description

Notes
name string The name of the template.

 

color number The color of the brand and links appearing in the error template. The value is given in hex color code.
logo string? union? The identifier of the logo. The value of the logo can be 'null'.

brand_name

string

The name of the brand.

 

md_contents

object

Contains a list of error templates written in Markdown.

 

md_contents.auth

string

The content of the Authentication failed error template in Markdown.

 

md_contents.badcontent

string

The content of the Bad content error template in Markdown.

 

md_contents.clientsyntax

string

The content of the Client syntax error template in Markdown.

 

md_contents.clienttimeout

string

The content of the Client timeout error template in Markdown.

 

md_contents.connecterror

string

The content of the Connect error error template in Markdown.

 

md_contents.ftperror

string

The content of the FTP error error template in Markdown.

 

md_contents.internal

string

The content of the Internal error error template in Markdown.

 

md_contents.invalidurl

string

The content of the Invalid URL error template in Markdown.

 

md_contents.ioerror

string

The content of the IO error error template in Markdown.

 

md_contents.policysyntax

string

The content of the Policy syntax error template in Markdown.

 

md_contents.policyviolation

string

The content of the Policy violation error template in Markdown.

 

md_contents.redirect

string

The content of the Redirect error template in Markdown.

 

md_contents.serversyntax

string

The content of the Server syntax error template in Markdown.

 

md_contents.servertimeout

string

The content of the Server timeout error template in Markdown.

 

For details of the meta object, see Message format.

HTTP response codes

HTTP response codes comprise of standard or endpoint-specific HTTP status and error codes. The following table lists the endpoint-specific HTTP response codes for this request.

HTTP response code Status/Error Description
400 NotSupportedProxyErrorType Preview could not be created. The used error type is not supported. Use an error type from the following list: Authentication failed, Bad content, Client syntax, Client timeout, Connect error, FTP error, Internal, Invalid URL, IO error, Policy syntax, Policy violation, Redirect, Server syntax, Server timeout.

For more information and a complete list of standard HTTP response codes, see Application level error codes.

Uploading a custom logo to your custom HTTP proxy error pages

Upload a custom logo to your custom HTTP proxy error pages.

Supported formats: PNG, JPEG, GIF.

URL
GET https://<IP-address-of-SPS>/api/configuration/http/proxy_error_logo
Cookies
Cookie name Description Required Values
session_id Contains the authentication token of the user Required

The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For more information on authentication, see Authenticate to the SPS REST API.

NOTE: This session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format).
Operations

Operations with the /http/proxy_error_logo endpoint include:

Operation HTTP method URL

Notes
Uploading a custom logo POST /api/upload/http/proxy_error_logo If you upload an oversized logo, for example 800x800 pixels, your image will be automatically resized to 128x128 pixels, keeping the original aspect ratio.

NOTE: GET / PUT / DELETE methods are not allowed on logo upload.

Sample request

The following command uploads a custom logo.

curl --cookie cookies.txt https://<IP-address-of-SPS>/api/configuration/http/proxy_error_logo
Response

The following is a sample response received when the custom logo has been uploaded.

The response of the creation without the unique ID is the following.

{
     "logo_id": "rest_XXXXXXXX",
     "meta": {
       "href": "/api/upload/http/proxy_error_logo",
       "parent": "/api/upload/http"
     }
   }

The response of the query without a unique logo ID is the following.

{
     "changes": [
      {
       "new_value": "rest_XXXXXXXX",
       "path": "/api/upload/http/proxy_error_logo",
       "type": "creation"
      }
     ],
     "meta": {
       "href": "/api/transaction/changes",
       "parent": "/api/transaction",
       "transaction": "/api/transaction"
     }    
   }

For more information on the meta object, see Message format.

Elements of the response message include:

Element

Type

 Description

Notes
logo_id string The identifier of the custom logo.

 

supported_formats enum The supported image formats. Possible values: PNG, JPEG, GIF.
actual_resolution number The actual resolution of the uploaded custom logo.  
max_resolution

number

 The maximal resolution of the uploaded custom logo. The maximum accepted size is 4096x4096 pixels.

file_size

number

The actual size of the file.

 

file_limit

number

The maximum size of the file.

The file size limit is 16 megabyte.

HTTP response codes

HTTP response codes comprise of standard or endpoint-specific HTTP status and error codes. The following table lists the endpoint-specific HTTP response codes for this request.

HTTP response code Status/Error Description
400 ResolutionTooLarge The logo you uploaded (5200x5200 pixels) is larger than the maximum accepted size (4096x4096 pixels). Upload a logo that is not larger than 4096x4096 pixels.

413

FileTooLarge

The file in the request exceeds the file size limitation.

415

InvalidImageFormat

The file format of the uploaded logo is not supported. Make sure that you upload a logo in one of our supported file formats (PNG, JPEG, GIF).

For more information and a complete list of standard HTTP response codes, see Application level error codes.

Citrix ICA connections

Topics:

ICA connections

List of endpoints for configuring the policies, options and connection rules of ICA connections.

URL
GET https://<IP-address-of-SPS>/api/configuration/ica
Cookies
Cookie name Description Required Values
session_id Contains the authentication token of the user Required

The value of the session ID cookie received from the REST server in the authentication response, for example, a1f71d030e657634730b9e887cb59a5e56162860. For more information on authentication, see Authenticate to the SPS REST API.

NOTE: This session ID refers to the connection between the REST client and the SPS REST API. It is not related to the sessions that SPS records (and which also have a session ID, but in a different format).
Sample request

The following command lists the available settings for configuring for ICA connections.

curl --cookie cookies.txt https://<IP-address-of-SPS>/api/configuration/ica
Response

The following is a sample response received when listing the configuration settings.

For more information on the meta object, see Message format.

{
  "items": [
    {
      "key": "channel_policies",
      "meta": {
        "href": "/api/configuration/ica/channel_policies"
      }
    },
   {
     "key": "connections",
     "meta": {
       "href": "/api/configuration/ica/connections"
     }
   },
    {
      "key": "options",
      "meta": {
        "href": "/api/configuration/ica/options"
      }
    },
    {
      "key": "settings_policies",
      "meta": {
        "href": "/api/configuration/ica/settings_policies"
      }
    }
  ],
  "meta": {
    "first": "/api/configuration/aaa",
    "href": "/api/configuration/ica",
    "last": "/api/configuration/x509",
    "next": "/api/configuration/local_services",
    "parent": "/api/configuration",
    "previous": "/api/configuration/http",
    "transaction": "/api/transaction"
  }
}
Item Description
channel_policies List of the default and custom channel policies.

connections

List of ICA connection policies.

options List of global ICA options that affect all connections.
settings_policies List of protocol-level settings (timeout, reliability). You can create multiple variations, and choose the appropriate one for each connection policy.
Status and error codes

The following table lists the typical status and error codes for this request. For a complete list of error codes, see Application level error codes.

Code Description Notes
401 Unauthenticated The requested resource cannot be retrieved because the client is not authenticated and the resource requires authorization to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.
403 Unauthorized The requested resource cannot be retrieved because the client is not authorized to access it. The details section contains the path that was attempted to be accessed, but could not be retrieved.
404 NotFound The requested object does not exist.
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating